Tipo de recurso federatedIdentityCredential

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 de versão.

Faz referência às credenciais de identidade federada de um aplicativo. Essas credenciais de identidade federada são usadas na federação de identidade de carga de trabalho ao trocar um token de um emissor confiável por um token de acesso vinculado a um aplicativo registrado no Azure AD.

Herda de entidade.

NOTA: Esse recurso não está disponível em implantações de nuvem nacional.

Métodos

Método Tipo de retorno Descrição
Listar federatedIdentityCredentials Coleção federatedIdentityCredential Obtenha uma lista dos objetos federatedIdentityCredential e suas propriedades.
Criar federatedIdentityCredential federatedIdentityCredential Crie um novo objeto federatedIdentityCredential .
Obter federatedIdentityCredential federatedIdentityCredential Leia as propriedades e as relações de um objeto federatedIdentityCredential .
Atualizar federatedIdentityCredential Nenhum Atualize as propriedades de um objeto federatedIdentityCredential .
Excluir federatedIdentityCredential Nenhum Exclui um objeto federatedIdentityCredential .

Propriedades

Propriedade Tipo Descrição
Público Coleção de cadeias de caracteres Lista as audiências que podem aparecer no token externo. Esse campo é obrigatório e usa como padrão "api://AzureADTokenExchange". Ele diz o plataforma de identidade da Microsoft deve aceitar na declaração aud no token de entrada. Esse valor representa Azure AD em seu provedor de identidade externo e não tem nenhum valor fixo entre provedores de identidade – talvez seja necessário criar um novo registro de aplicativo em seu provedor de identidade para servir como o público-alvo desse token. Obrigatório.
description Cadeia de caracteres A descrição não validada fornecida pelo usuário da credencial de identidade federada. Opcional.
id Cadeia de caracteres O identificador exclusivo da identidade federada. Obrigatório. Somente leitura.
Emissor Cadeia de caracteres A URL do provedor de identidade externa e deve corresponder à issuer declaração do token externo que está sendo trocado. A combinação dos valores do emissor e da entidade deve ser exclusiva no aplicativo. Obrigatório.
nome String é o identificador exclusivo para a credencial de identidade federada, que tem um limite de caracteres de 120 caracteres e deve ser amigável para URL. Ele é imutável depois de criado. Obrigatório. Não anulável. Suporta $filter (eq).
assunto Cadeia de caracteres Obrigatório. O identificador da carga de trabalho de software externo no provedor de identidade externo. Como o valor do público-alvo, ele não tem nenhum formato fixo, pois cada provedor de identidade usa seu próprio – às vezes, um GUID, às vezes um identificador delimitado por dois-pontos, às vezes cadeias de caracteres arbitrárias. O valor aqui deve corresponder à declaração sub dentro do token apresentado a Azure AD. A combinação de emissor e assunto deve ser exclusiva no aplicativo. Suporta $filter (eq).

Relações

Nenhum

Representação JSON

Veja a seguir uma representação JSON do recurso.

{
  "@odata.type": "#microsoft.graph.federatedIdentityCredential",
  "name": "String",
  "issuer": "String",
  "subject": "String",
  "description": "String",
  "audiences": [
    "String"
  ]
}