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.
Crie um novo objeto de blueprint de identidade de agente , se ele não existir, ou atualize as propriedades de um objeto existente.
Importante
Não há suporte para o uso do PATCH para definir passwordCredential. Use os métodos addPassword e removePassword para atualizar a senha ou o segredo de um blueprint de identidade do agente.
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.
| 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.ReadWrite.All | Não disponível |
| Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
| Application | AgentIdentityBlueprint.ReadWrite.All | Não disponível |
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 criar ou atualizar um aplicativo, especifique a chave alternativa fornecida pelo cliente uniqueName .
PATCH /applications(uniqueName='{uniqueName}')/microsoft.graph.agentIdentityBlueprint
Cabeçalhos de solicitação
| Nome | Descrição |
|---|---|
| Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
| Content-Type | application/json. Obrigatório. |
| Preferir |
create-if-missing. Necessário para o comportamento de upsert, caso contrário, a solicitação será tratada como uma operação de atualização. |
Corpo da solicitação
No corpo da solicitação, forneça uma representação JSON do objeto agentIdentityBlueprint . O corpo da solicitação deve conter displayName, que é uma propriedade necessária. Especifique outras propriedades graváveis conforme necessário para seu agentIdentityBlueprint, para criação ou atualização.
Resposta
A propriedade isSingleInstance pode ser definida ao criar um blueprint e o false padrão é se omitida. É imutável após a criação; Uma tentativa de alterá-lo em um blueprint existente retorna 400 Bad Request com o código Request_BadRequestde erro .
Se um objeto com uniqueName não existir, esse método retornará um código de 201 Created resposta e um novo objeto de blueprint de identidade do agente no corpo da resposta. O blueprint de identidade do agente recebe o valor uniqueName.
Se um objeto com uniqueName não existir e o Prefer: create-if-missing cabeçalho não for especificado, esse método retornará um código de 404 Not Found erro.
Se já existir um objeto de aplicativo com uniqueName , esse método atualizará o objeto e retornará um código de 204 No Content resposta.
Para obter informações sobre erros retornados por APIs de identidade do agente, consulte Códigos de erro de identidade do agente.
Exemplos
Solicitação
O exemplo a seguir mostra uma solicitação.
PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')/microsoft.graph.agentIdentityBlueprint
Content-Type: application/json
Prefer: create-if-missing
{
"displayName": "Display name"
}
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 201 Created
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#applications/$entity",
"id": "03ef14b0-ca33-4840-8f4f-d6e91916010e",
"deletedDateTime": null,
"appId": "00001111-aaaa-2222-bbbb-3333cccc4444",
"identifierUris": [],
"createdDateTime": "2019-09-17T19:10:35.2742618Z",
"displayName": "Display name",
"groupMembershipClaims": null,
"optionalClaims": null,
"publisherDomain": "contoso.onmicrosoft.com",
"requiredResourceAccess": [],
"signInAudience": "AzureADandPersonalMicrosoftAccount",
"tags": [],
"tokenEncryptionKeyId": null,
"api": {
"requestedAccessTokenVersion": 2,
"acceptMappedClaims": null,
"knownClientApplications": [],
"oauth2PermissionScopes": [],
"preAuthorizedApplications": []
},
"appRoles": [],
"info": {
"termsOfServiceUrl": null,
"supportUrl": null,
"privacyStatementUrl": null,
"marketingUrl": null,
"logoUrl": null
},
"keyCredentials": [],
"passwordCredentials": [],
"uniqueName": "app-65278",
"web": {
"redirectUris": [],
"homePageUrl": null,
"logoutUrl": null,
"implicitGrantSettings": {
"enableIdTokenIssuance": false,
"enableAccessTokenIssuance": false
}
},
}