Upsert agentIdentityBlueprint

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Cree un nuevo objeto de blueprint de identidad de agente si no existe, o actualice las propiedades de un objeto existente.

Importante

No es compatible con el uso de PATCH para establecer passwordCredential. Use los métodos addPassword y removePassword para actualizar la contraseña o el secreto de un plano técnico de identidad de agente.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permiso con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) AgentIdentityBlueprint.ReadWrite.All No disponible
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación AgentIdentityBlueprint.ReadWrite.All No disponible

Importante

  • Una entidad de seguridad que crea una identidad de agente, un plano técnico o una entidad de seguridad de plano técnico se asigna automáticamente como propietario.
  • Los propietarios pueden crear y modificar identidades de agente asociadas a un plano técnico de su propiedad sin que se les asigne un rol de ID de agente.
  • Para que los usuarios que no son propietarios puedan llamar a esta API en escenarios delegados con cuentas profesionales o educativas, el administrador debe tener asignado un rol compatible de Microsoft Entra. Esta operación admite el siguiente rol integrado con privilegios mínimos:

Solicitud HTTP

Para crear o actualizar una aplicación, especifique la clave alternativa uniqueName proporcionada por el cliente.

PATCH /applications(uniqueName='{uniqueName}')/microsoft.graph.agentIdentityBlueprint

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.
Content-Type application/json. Necesario.
Prefer create-if-missing. Necesario para el comportamiento de upsert, de lo contrario, la solicitud se trata como una operación de actualización.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto agentIdentityBlueprint . El cuerpo de la solicitud debe contener displayName, que es una propiedad necesaria. Especifique otras propiedades grabables según sea necesario para la creación o actualización de agentIdentityBlueprint.

Respuesta

La propiedad isSingleInstance se puede establecer al crear un plano técnico y el valor predeterminado es false si se omite. Es inmutable después de la creación; Un intento de cambiarlo en un plano técnico existente devuelve 400 Bad Request el código Request_BadRequestde error.

Si no existe un objeto con uniqueName , este método devuelve un 201 Created código de respuesta y un nuevo objeto blueprint de identidad de agente en el cuerpo de la respuesta. Al plano técnico de identidad del agente se le asigna el valor uniqueName.

Si no existe un objeto con uniqueName y no se especifica el Prefer: create-if-missing encabezado, este método devuelve un 404 Not Found código de error.

Si ya existe un objeto de aplicación con uniqueName , este método actualiza el objeto y devuelve un 204 No Content código de respuesta.

Para obtener información sobre los errores devueltos por las API de identidad del agente, consulte Códigos de error de identidad del agente.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')/microsoft.graph.agentIdentityBlueprint
Content-Type: application/json
Prefer: create-if-missing

{
  "displayName": "Display name"
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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
        }
    }, 
}
  • Se actualizó por última vez el