Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
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.
Leia as propriedades e os relacionamentos de um objeto federatedIdentityCredential atribuído a um aplicativo ou a um agentIdentityBlueprint.
Essa API está disponível nas seguintes implantações de nuvem nacional.
| Serviço global | Governo dos EUA L4 | US Government L5 (DOD) | China operada pela 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Permissões para um aplicativo
| Tipo de permissão | Permissões menos privilegiadas | Permissões com privilégios mais elevados |
|---|---|---|
| Delegado (conta corporativa ou de estudante) | Application.ReadWrite.All | Indisponível. |
| Delegado (conta pessoal da Microsoft) | Application.ReadWrite.All | Indisponível. |
| Application | Application.ReadWrite.OwnedBy | Application.ReadWrite.All |
Importante
Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. Esta operação dá suporte às seguintes funções internas, que fornecem apenas o menor privilégio necessário:
- Um usuário membro não administrador com permissões de usuário padrão - para aplicativos que possuem
- Desenvolvedor de Aplicativos - para aplicativos que possuem
- Administrador de Aplicativos de Nuvem
- Administrador de Aplicativos
Permissões para um agentIdentityBlueprint
| Tipo de permissão | Permissão com privilégios mínimos | Permissões com privilégios mais elevados |
|---|---|---|
| Delegado (conta corporativa ou de estudante) | AgentIdentityBlueprint.Read.All | Application.Read.All, Directory.Read.All |
| Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
| Application | AgentIdentityBlueprint.Read.All | Application.Read.All, Directory.Read.All |
Importante
- Uma entidade de segurança que cria um blueprint de identidade de agente ou uma entidade de segurança de plano é automaticamente atribuída como proprietária.
- Os proprietários podem criar e modificar identidades de agente associadas a um blueprint que possuem sem receber uma função de ID de agente.
- Para que os não proprietários chamem essa API em cenários delegados usando contas corporativas ou de estudante, o administrador deve receber uma função do Microsoft Entra com suporte. Esta operação dá suporte à seguinte função interna com privilégios mínimos:
Solicitação HTTP
Para um aplicativo:
- Você pode abordar o aplicativo usando sua id ou appId. id e appId são chamados de ID do Objeto e ID do Aplicativo (Cliente), respectivamente, em registros de aplicativo no centro de administração do Microsoft Entra.
- Você também pode endereçar a credencial de identidade federada com seu id ou nome.
GET /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialId}
GET /applications/{id}/federatedIdentityCredentials/{federatedIdentityCredentialName}
GET /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialId}
GET /applications(appId='{appId}')/federatedIdentityCredentials/{federatedIdentityCredentialName}
Para um agentIdentityBlueprint:
- Você pode endereçar a credencial de identidade federada com seu id ou nome.
GET /applications/{id}/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials/{federatedIdentityCredentialId}
GET /applications/{id}/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials/{federatedIdentityCredentialName}
Parâmetros de consulta opcionais
Esse método dá suporte $select ao parâmetro de consulta OData para ajudar a personalizar a resposta.
Cabeçalhos de solicitação
| Nome | Descrição |
|---|---|
| Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedido, esse método retornará um código de 200 OK resposta e um objeto federatedIdentityCredential no corpo da resposta.
Exemplos
Exemplo 1: Recuperar uma credencial de identidade federada para um aplicativo
Solicitação
GET https://graph.microsoft.com/beta/applications/acd7c908-1c4d-4d48-93ee-ff38349a75c8/federatedIdentityCredentials/bdad0963-4a7a-43ae-b569-e67e1da3f2c0
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": {
"@odata.context": "https://graph.microsoft.com/beta/$metadata#applications('cd7c908-1c4d-4d48-93ee-ff38349a75c8')/federatedIdentityCredentials/$entity",
"@odata.id": "https://graph.microsoft.com/v2/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/directoryObjects/$/Microsoft.DirectoryServices.Application('bcd7c908-1c4d-4d48-93ee-ff38349a75c8')/federatedIdentityCredentials('bdad0963-4a7a-43ae-b569-e67e1da3f2c0')/bdad0963-4a7a-43ae-b569-e67e1da3f2c0",
"id": "bdad0963-4a7a-43ae-b569-e67e1da3f2c0",
"name": "testing",
"issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
"subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
"description": "This is my test federated identity credential",
"audiences": [
"api://AzureADTokenExchange"
],
"claimsMatchingExpression": null
}
}
Exemplo 2: Recuperar uma credencial de identidade federada para um agentIdentityBlueprint
Solicitação
GET https://graph.microsoft.com/beta/applications/acd7c908-1c4d-4d48-93ee-ff38349a75c8/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials/bdad0963-4a7a-43ae-b569-e67e1da3f2c0
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": {
"@odata.context": "https://graph.microsoft.com/beta/$metadata#applications('cd7c908-1c4d-4d48-93ee-ff38349a75c8')/federatedIdentityCredentials/$entity",
"@odata.id": "https://graph.microsoft.com/v2/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/directoryObjects/$/Microsoft.DirectoryServices.Application('bcd7c908-1c4d-4d48-93ee-ff38349a75c8')/federatedIdentityCredentials('bdad0963-4a7a-43ae-b569-e67e1da3f2c0')/bdad0963-4a7a-43ae-b569-e67e1da3f2c0",
"id": "bdad0963-4a7a-43ae-b569-e67e1da3f2c0",
"name": "testing",
"issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
"subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
"description": "This is my test federated identity credential",
"audiences": [
"api://AzureADTokenExchange"
],
"claimsMatchingExpression": null
}
}