Upsert servicePrincipal

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 ServicePrincipal si no existe, o actualice las propiedades de un objeto ServicePrincipal existente.

Esta API también puede crear un objeto agentIdentityBlueprintPrincipal a partir de un agentIdentityBlueprint si no existe, o actualizar las propiedades de un agentIdentityBlueprintPrincipal existente, cuando la propiedad @odata.type se establece en #microsoft.graph.agentIdentityBlueprintPrincipal.

Importante

No es compatible agregar passwordCredential cuando se crea servicePrincipals. Use el método addPassword para agregar contraseñas o secretos a un servicePrincipal.

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 Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Application.ReadWrite.All Directory.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación Application.ReadWrite.OwnedBy Application.ReadWrite.All, Directory.ReadWrite.All

Importante

Para el acceso delegado con cuentas profesionales o educativas, el administrador debe tener asignado un rol compatible de Microsoft Entra o un rol personalizado que conceda los permisos necesarios para esta operación. Esta operación admite los siguientes roles integrados, que proporcionan solo el privilegio mínimo necesario:

  • Para aplicaciones multiinquilino:
    • Administrador de la aplicación
    • Administrador de aplicaciones en la nube
  • Para las aplicaciones de un solo inquilino en las que el usuario que llama es un usuario que no es administrador, pero es el propietario de la aplicación de respaldo, el usuario debe tener el rol de desarrollador de aplicaciones .

En escenarios delegados con cuentas profesionales o educativas, se admiten los siguientes privilegios para administrar identidades de agente y directores del plano técnico de identidad de agente:

  • El usuario que ha iniciado sesión es el propietario, o bien
  • Al usuario que ha iniciado sesión se le asigna el rol de administrador de ID de agente .

Solicitud HTTP

PATCH /servicePrincipals(appId='appId')

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 de un objeto servicePrincipal.

Respuesta

Si se realiza correctamente, si no existe un servicePrincipal o agentIdentityBlueprintPrincipal con appId , este método devuelve un 201 Created código de respuesta y un nuevo objeto servicePrincipal o agentIdentityBlueprintPrincipal en el cuerpo de la respuesta.

Si ya existe un servicePrincipal o agentIdentityBlueprintPrincipal con appId , este método actualiza el objeto servicePrincipal o agentIdentityBlueprintPrincipal y devuelve un código de 204 No Content respuesta.

Ejemplos

Ejemplo 1: Crear una nueva entidad de servicio si no existe

En el ejemplo siguiente se crea una entidad de servicio porque no existe una entidad de servicio con el valor de AppId especificado.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PATCH https://graph.microsoft.com/beta/servicePrincipals(appId='65415bb1-9267-4313-bbf5-ae259732ee12')
Content-type: application/json
Prefer: create-if-missing

{
  "displayName": "My app instance"
}

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#servicePrincipals/$entity",
    "id": "59e617e5-e447-4adc-8b88-00af644d7c92",
    "deletedDateTime": null,
    "accountEnabled": true,
    "appDisplayName": "My App",
    "appId": "65415bb1-9267-4313-bbf5-ae259732ee12",
    "applicationTemplateId": null,
    "appOwnerOrganizationId": "1bc1c026-2f7b-48a5-98da-afa2fd8bc7bc",
    "appRoleAssignmentRequired": false,
    "displayName": "My app instance",
    "errorUrl": null,
    "homepage": null,
    "loginUrl": null,
    "logoutUrl": null,
    "notificationEmailAddresses": [],
    "preferredSingleSignOnMode": null,
    "preferredTokenSigningKeyEndDateTime": null,
    "preferredTokenSigningKeyThumbprint": null,
    "publisherName": "Contoso",
    "replyUrls": [],
    "samlMetadataUrl": null,
    "samlSingleSignOnSettings": null,
    "servicePrincipalNames": [
        "f1bd758f-4a1a-4b71-aa20-a248a22a8928"
    ],
    "signInAudience": "AzureADandPersonalMicrosoftAccount",
    "tags": [],
    "addIns": [],
    "api": {
        "resourceSpecificApplicationPermissions": []
    },
    "appRoles": [],
    "info": {
        "termsOfServiceUrl": null,
        "supportUrl": null,
        "privacyStatementUrl": null,
        "marketingUrl": null,
        "logoUrl": null
    },
    "keyCredentials": [],
    "publishedPermissionScopes": [],
    "passwordCredentials": []
}

Ejemplo 2: Actualizar una entidad de servicio existente

En el ejemplo siguiente se actualiza el servicePrincipal porque existe un servicePrincipal con el valor appId especificado.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PATCH https://graph.microsoft.com/beta/servicePrincipals(appId='65415bb1-9267-4313-bbf5-ae259732ee12')
Content-type: application/json
Prefer: create-if-missing

{
  "displayName": "My app instance"
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content