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.

Quite una credencial de clave de un servicePrincipal. Un servicePrincipal puede usar este método junto con addKey para automatizar la puesta en marcha de las claves que expiran.

Nota:

Las operaciones servicePrincipal y Update 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 un permiso o permisos con privilegios superiores 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

Solicitud HTTP

Puede dirigirse a la entidad de servicio mediante su id . o appId. id y appId se conocen como id. de objeto y id. de aplicación (cliente), respectivamente, en los registros de aplicaciones en el Centro de administración 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 la autenticación y la autorización.
Content-Type	application/json. Obligatorio.

Cuerpo de la solicitud

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

Propiedad	Tipo	Descripción
keyId	Guid	Identificador único de la contraseña.
Prueba	Cadena	Token JWT autofirmado que se usa como prueba de posesión de las claves existentes. Este token JWT debe estar firmado con una clave privada que corresponda a uno de los certificados válidos existentes asociados con servicePrincipal. El token debe contener las siguientes notificaciones: aud: el público debe ser 00000002-0000-0000-c000-000000000000. iss: El emisor debe ser el identificador del servicePrincipal que inicia la solicitud. nbf: no antes de la hora. exp: el tiempo de expiración debe ser el valor de nbf + 10 minutos. Para ver los pasos para generar este token de prueba de posesión, consulte Generación de tokens de prueba de posesión para claves graduales.

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.

HTTP

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

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const removeKey = {
    keyId: 'f0b0b335-1d71-4883-8f98-567911bfdca6',
    proof: 'eyJ0eXAiOiJ...'
};

await client.api('/serviceprincipals/{id}/removeKey')
	.version('beta')
	.post(removeKey);

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content