application: addPassword

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.

Agrega una contraseña segura a una aplicación. También puede agregar contraseñas al crear la aplicación.

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) Application.ReadWrite.All No disponible.
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 aplicación 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 /applications/{id}/addPassword
POST /applications(appId='{appId}')/addPassword

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 un objeto opcional passwordCredential con las siguientes propiedades.

Propiedad Tipo Descripción
displayName Cadena Nombre descriptivo de la contraseña. Opcional.
endDateTime DateTimeOffset La fecha y hora en que expira la contraseña se representa mediante el formato ISO 8601 y siempre está en hora UTC. Por ejemplo, la medianoche en la zona horaria UTC del 1 de enero de 2014 sería 2014-01-01T00:00:00Z. Opcional. El valor predeterminado es "startDateTime + 2 years".
startDateTime DateTimeOffset La fecha y hora en que la contraseña es válida. El tipo de marca de tiempo representa la información de fecha y hora con el formato ISO 8601 y está siempre en hora UTC. Por ejemplo, la medianoche en la zona horaria UTC del 1 de enero de 2014 sería 2014-01-01T00:00:00Z. Opcional. El valor predeterminado es "ahora".

Respuesta

Si se realiza correctamente, este método devuelve un 200 OK código de respuesta y un nuevo objeto passwordCredential en el cuerpo de la respuesta. La propiedad secretText del objeto de respuesta contiene las contraseñas seguras generadas por Microsoft Entra ID con una longitud de entre 16 y 64 caracteres. No hay ninguna manera de recuperar esta contraseña en el futuro.

Ejemplos

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

Solicitud

En el ejemplo siguiente se muestra la solicitud. El identificador que se especifica en la solicitud es el valor de la propiedad id de la aplicación, no el valor de la propiedad appId .

POST https://graph.microsoft.com/beta/applications/{id}/addPassword
Content-type: application/json

{
  "passwordCredential": {
    "displayName": "Password friendly name"
  }
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 200 OK
Content-type: application/json

{
    "customKeyIdentifier": null,
    "endDateTime": "2021-09-09T19:50:29.3086381Z",
    "keyId": "f0b0b335-1d71-4883-8f98-567911bfdca6",
    "startDateTime": "2019-09-09T19:50:29.3086381Z",
    "secretText": "[6gyXA5S20@MN+WRXAJ]I-TO7g1:h2P8",
    "hint": "[6g",
    "displayName": "Password friendly name"
}