Partilhar via

Upsert agentIdentityBlueprint

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 esquema de identidade do agente se não existir ou atualize as propriedades de um objeto existente.

Importante

Não há suporte para o uso do PATCH para definir passwordCredential. Utilize os métodos addPassword e removePassword para atualizar a palavra-passe ou o segredo de um esquema de identidade do agente.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ✅

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissão com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) AgentIdentityBlueprint.ReadWrite.All Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application AgentIdentityBlueprint.ReadWrite.All Directory.ReadWrite.All

Importante

Ao utilizar permissões delegadas, tem de ser atribuída ao utilizador autenticado uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.

  • Administrador de ID do Agente.
  • ID do Agente Programador – criar esquemas de identidade do agente. O principal com esta função tem a propriedade atribuída do esquema que criam e pode realizar operações de escrita nesse esquema.

Solicitação HTTP

Para criar ou atualizar uma aplicação, 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, o pedido é tratado como uma operação de atualização.

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON do objeto agentIdentityBlueprint . O corpo do pedido tem de conter displayName, que é uma propriedade necessária. Especifique outras propriedades graváveis conforme necessário para o agentIdentityBlueprint, para criação ou atualização.

Resposta

Se não existir um objeto com uniqueName , este método devolve um 201 Created código de resposta e um novo objeto de esquema de identidade do agente no corpo da resposta. É atribuído ao esquema de identidade do agente o valor uniqueName.

Se um objeto com uniqueName não existir e o Prefer: create-if-missing cabeçalho não for especificado, este método devolve um 404 Not Found código de erro.

Se já existir um objeto de aplicação com uniqueName , este método atualiza o objeto e devolve um 204 No Content código de resposta.

Para obter informações sobre os erros devolvidos pelas APIs de identidade do agente, veja 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",
    "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
        }
    }, 
}
  • Last updated on