AuthorizationCodeCredential class
Permite la autenticación de Microsoft Entra ID utilizando un código de autorización obtenido a través del flujo de código de autorización, descrito con más detalle en la documentación de Microsoft Entra ID:
https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
Constructores
| Authorization |
Crea una instancia de AuthorizationCodeCredential con los detalles necesarios para solicitar un token de acceso usando una autenticación obtenida del Microsoft Entra ID. Actualmente es necesario que el usuario de esta credencial inicie el flujo de código de autorización para obtener un código de autorización que se usará con esta credencial. Aquí se proporciona un ejemplo completo de este flujo: |
| Authorization |
Crea una instancia de AuthorizationCodeCredential con los detalles necesarios para solicitar un token de acceso usando una autenticación obtenida del Microsoft Entra ID. Actualmente es necesario que el usuario de esta credencial inicie el flujo de código de autorización para obtener un código de autorización que se usará con esta credencial. Aquí se proporciona un ejemplo completo de este flujo: |
Métodos
| get |
Se autentica con Microsoft Entra ID y devuelve un token de acceso si tiene éxito. Si se produce un error en la autenticación, se producirá una credentialUnavailableError con los detalles del error. |
Detalles del constructor
AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)
Crea una instancia de AuthorizationCodeCredential con los detalles necesarios para solicitar un token de acceso usando una autenticación obtenida del Microsoft Entra ID.
Actualmente es necesario que el usuario de esta credencial inicie el flujo de código de autorización para obtener un código de autorización que se usará con esta credencial. Aquí se proporciona un ejemplo completo de este flujo:
new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)
Parámetros
- tenantId
-
string
El ID del inquilino (directorio) de Microsoft Entra o nombre. Se puede usar "common" al tratar con escenarios multiinquilino.
- clientId
-
string
Identificador de cliente (aplicación) de un registro de aplicaciones en el inquilino.
- authorizationCode
-
string
Código de autorización que se recibió del siguiente flujo de código de autorización. Este código de autorización no se debe haber usado para obtener un token de acceso.
- redirectUri
-
string
URI de redirección que se usó para solicitar el código de autorización. Debe ser el mismo URI configurado para el registro de aplicaciones.
Opciones para configurar el cliente que realiza la solicitud de token de acceso.
AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)
Crea una instancia de AuthorizationCodeCredential con los detalles necesarios para solicitar un token de acceso usando una autenticación obtenida del Microsoft Entra ID.
Actualmente es necesario que el usuario de esta credencial inicie el flujo de código de autorización para obtener un código de autorización que se usará con esta credencial. Aquí se proporciona un ejemplo completo de este flujo:
new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)
Parámetros
- tenantId
-
string
El ID del inquilino (directorio) de Microsoft Entra o nombre. Se puede usar "common" al tratar con escenarios multiinquilino.
- clientId
-
string
Identificador de cliente (aplicación) de un registro de aplicaciones en el inquilino.
- clientSecret
-
string
Secreto de cliente que se generó para el registro de aplicaciones
- authorizationCode
-
string
Código de autorización que se recibió del siguiente flujo de código de autorización. Este código de autorización no se debe haber usado para obtener un token de acceso.
- redirectUri
-
string
URI de redirección que se usó para solicitar el código de autorización. Debe ser el mismo URI configurado para el registro de aplicaciones.
Opciones para configurar el cliente que realiza la solicitud de token de acceso.
Detalles del método
getToken(string | string[], GetTokenOptions)
Se autentica con Microsoft Entra ID y devuelve un token de acceso si tiene éxito. Si se produce un error en la autenticación, se producirá una credentialUnavailableError con los detalles del error.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>
Parámetros
- scopes
-
string | string[]
Lista de ámbitos para los que el token tendrá acceso.
- options
- GetTokenOptions
Las opciones que se usan para configurar las solicitudes que puede realizar esta implementación de TokenCredential.
Devoluciones
Promise<AccessToken>