Partilhar via


federatedIdentityCredential resource type

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Referencia as credenciais de identidade federada para uma aplicação ou agentIdentityBlueprint. Estas credenciais de identidade federada são utilizadas na federação de identidade da carga de trabalho ao trocar um token de um emissor fidedigno por um token de acesso ligado a uma aplicação ou a um esquema de identidade do agente.

Herda de entidade.

Methods

Método Tipo de retorno Descrição
List Coleção federatedIdentityCredential Obtenha uma lista dos objetos federatedIdentityCredential e respetivas propriedades.
Create federatedIdentityCredential Crie um novo objeto federatedIdentityCredential .
Get federatedIdentityCredential Leia as propriedades e relações de um objeto federatedIdentityCredential .
Atualizar Nenhum(a) Atualize as propriedades de um objeto federatedIdentityCredential .
Upsert federatedIdentityCredential Crie um novo federatedIdentityCredential se não existir ou atualize as propriedades de um objeto federatedIdentityCredential existente.
Delete Nenhum Eliminar um objeto federadoIdentityCredential .

Propriedades

Propriedade Tipo Descrição
audiências String collection A audiência que pode aparecer no token externo. Este campo é obrigatório e deve ser definido api://AzureADTokenExchange como para Microsoft Entra ID. Diz o que plataforma de identidade da Microsoft deve aceitar na aud afirmação no token de entrada. Este valor representa Microsoft Entra ID no seu fornecedor de identidade externo e não tem um valor fixo entre fornecedores de identidade. Poderá ter de criar um novo registo de aplicação no seu fornecedor de identidade para servir de audiência deste token. Este campo só pode aceitar um único valor e tem um limite de 600 carateres. Obrigatório.
claimsMatchingExpression federatedIdentityExpression Anulável. A predefinição é se null não estiver definida. Permite a utilização de expressões correspondentes de afirmações em relação a afirmações especificadas. Se claimsMatchingExpression estiver definido, o assunto tem de ser null. Para obter a lista de sintaxe e afirmações de expressão suportadas, visite a referência fic flexível.
description Cadeia de caracteres A descrição não validada fornecida pelo utilizador da credencial de identidade federada. Tem um limite de 600 carateres. Opcional.
id Cadeia de caracteres O identificador exclusivo da identidade federada. Obrigatório. Somente leitura.
emissor Cadeia de caracteres O URL do fornecedor de identidade externa e tem de corresponder à issuer afirmação do token externo que está a ser trocado. A combinação dos valores do emissor e do assunto tem de ser exclusiva na aplicação. Tem um limite de 600 carateres. Obrigatório.
nome Cadeia de caracteres O identificador exclusivo da credencial de identidade federada, que tem um limite de 120 carateres e tem de ser compatível com o URL. É imutável uma vez criado. Chave alternativa. Obrigatório. Não anulável. Suporta $filter (eq).
assunto Cadeia de caracteres Anulável. A predefinição é se null não estiver definida. O identificador da carga de trabalho de software externo no fornecedor de identidade externo. Tal como o valor de audiência, não tem um formato fixo, uma vez que cada fornecedor de identidade utiliza o seu próprio , por vezes um GUID, por vezes um identificador delimitado por dois pontos, por vezes cadeias arbitrárias. O valor aqui tem de corresponder à sub afirmação no token apresentado ao Microsoft Entra ID. A combinação de emissor e assunto tem de ser exclusiva na aplicação. Tem um limite de 600 carateres. Se o assunto estiver definido, claimsMatchingExpression tem de ser null. Suporta $filter (eq).

Relações

Nenhum

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "@odata.type": "#microsoft.graph.federatedIdentityCredential",
  "id": "String (identifier)",
  "name": "String",
  "issuer": "String",
  "subject": "String",
  "description": "String",
  "audiences": [
    "String"
  ],
  "claimsMatchingExpression": {
    "@odata.type": "microsoft.graph.federatedIdentityExpression"
  }
}