servicePrincipal: removeKey

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.

Quitar una credencial de clave de una entidad de servicio. Un servicePrincipal puede usar este método, junto con addKey , para automatizar la anulación de sus claves que expiran.

Nota:

Crear servicePrincipal y actualizar las operaciones servicePrincipal se pueden seguir usando para agregar y actualizar credenciales de clave para cualquier servicePrincipal con o sin el contexto de un usuario.

Como parte de la validación de la solicitud para este método, se comprueba una prueba de posesión de una clave existente antes de que se pueda realizar la acción.

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 usuario que ha iniciado sesión 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:

  • Un usuario miembro no administrador con permisos de usuario predeterminados, para aplicaciones de su propiedad
  • Desarrolladores de aplicaciones: para las aplicaciones que poseen
  • Administrador de aplicaciones en la nube
  • Administrador de la aplicación

Solicitud HTTP

Puede dirigirse a la entidad de servicio mediante su id o appId. id y appId se conocen como Id. de objeto e Id. de aplicación (cliente), respectivamente, en los registros de aplicaciones en el Centro de administración de Microsoft Entra.

POST /serviceprincipals/{id}/removeKey
POST /serviceprincipals(appId='{appId}')/removeKey

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. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione las siguientes propiedades requeridas.

Propiedad Tipo Descripción
keyId Guid El identificador único de la contraseña.
como prueba Cadena Un token JWT autofirmado que se utiliza como prueba de posesión de las claves existentes. Este token JWT debe firmarse con una clave privada que corresponda a uno de los certificados válidos existentes asociados con el servicePrincipal. El token debe contener las siguientes notificaciones:
  • aud: La audiencia debe ser 00000002-0000-0000-c000-000000000000.
  • iss: El emisor debe ser el identificador del servicePrincipal que inicia la solicitud.
  • nbf: No antes de tiempo.
  • exp: El tiempo de expiración debe ser el valor de nbf + 10 minutos.

Para conocer los pasos para generar esta ficha de prueba de posesión, consulte Generación de fichas de prueba de posesión para llaves rodantes.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 204 No content.

Ejemplos

En el siguiente ejemplo se muestra cómo llamar a esta API.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

POST https://graph.microsoft.com/beta/serviceprincipals/{id}/removeKey
Content-Type: application/json

{
    "keyId": "f0b0b335-1d71-4883-8f98-567911bfdca6",
    "proof":"eyJ0eXAiOiJ..."
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content