Compartir a través de

agentIdentityBlueprint: addKey

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.

Agregue una credencial de clave a agentIdentityBlueprint. Este método, junto con removeKey, se puede usar para automatizar la puesta en marcha de sus claves que expiran.

Nota:

Solo debe proporcionar el valor de clave pública al agregar una credencial de certificado a la aplicación. Agregar un certificado de clave privada a la aplicación pone en peligro la aplicación.

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.

Los planos técnicos de identidad del agente que no tienen ningún certificado válido existente (aún no se han agregado certificados o todos los certificados han expirado), no podrán usar esta acción de servicio. En su lugar, puede usar la operación actualizar el plano técnico de identidad del agente para realizar una actualizació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 Permiso con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) AgentIdentityBlueprint.AddRemoveCreds.All AgentIdentityBlueprint.ReadWrite.All, Directory.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación AgentIdentityBlueprint.AddRemoveCreds.All AgentIdentityBlueprint.ReadWrite.All, Directory.ReadWrite.All

Importante

Cuando se usan permisos delegados, al usuario autenticado se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. Se admiten los siguientes roles con privilegios mínimos para esta operación.

  • Administrador de id. de agente.
  • Desarrollador de id. de agente: cree planos técnicos de identidad de agente. A la entidad de seguridad con este rol se le asigna la propiedad del plano técnico que crean y pueden realizar operaciones de escritura en ese plano técnico.

Solicitud HTTP

POST /applications/{id}/microsoft.graph.agentIdentityBlueprint/addKey

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 una representación JSON de los parámetros. En la tabla siguiente se enumeran los parámetros necesarios al llamar a esta acción.

Propiedad Tipo Description
keyCredential keyCredential Nueva credencial de clave de aplicación que se va a agregar. El tipo, el uso y la clave son propiedades necesarias para este uso. Los tipos de clave admitidos son:
  • AsymmetricX509Cert: el uso debe ser Verify.
  • X509CertAndPassword: el uso debe ser Sign
passwordCredential passwordCredential Solo es necesario establecer secretText , que debe contener la contraseña de la clave. Esta propiedad solo es necesaria para las claves de tipo X509CertAndPassword. Establézcalo en null en caso contrario.
Prueba Cadena Token JWT autofirmado que se usa como prueba de posesión de las claves existentes. Este token de JWT debe estar firmado con la clave privada de uno de los certificados válidos existentes de la aplicación. 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 de la aplicación 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. Para obtener más información sobre los tipos de notificación, vea Carga de notificaciones.

Respuesta

Si se ejecuta correctamente, esta acción devuelve un 200 OK código de respuesta y una claveCredential en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

POST https://graph.microsoft.com/beta/applications/{id}/microsoft.graph.agentIdentityBlueprint/addKey
Content-Type: application/json

{
  "keyCredential": {
    "@odata.type": "microsoft.graph.keyCredential"
  },
  "passwordCredential": {
    "@odata.type": "microsoft.graph.passwordCredential"
  },
  "proof": "String"
}

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 200 OK
Content-Type: application/json

{
  "value": {
    "@odata.type": "microsoft.graph.keyCredential"
  }
}
  • Last updated on