AuthorizationCodeCredential class

Paquete:

@azure/identity

Habilita la autenticación para Microsoft Entra ID mediante un código de autorización que se obtuvo a través del flujo de código de autorización, que se describe 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

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

Crea una instancia de AuthorizationCodeCredential con los detalles necesarios para solicitar un token de acceso mediante una autenticación obtenida de 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: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

Crea una instancia de AuthorizationCodeCredential con los detalles necesarios para solicitar un token de acceso mediante una autenticación obtenida de 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: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

Métodos

getToken(string | string[], GetTokenOptions)

Se autentica con Microsoft Entra ID y devuelve un token de acceso si se ejecuta correctamente. Si se produce un error en la autenticación, se producirá un 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 mediante una autenticación obtenida de 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:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

Parámetros

tenantId

string

Identificador o nombre del inquilino (directorio) de Microsoft Entra. Se puede usar "common" al tratar con escenarios multiinquilino.

clientId

string

Identificador de cliente (aplicación) de un registro de aplicación 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 redireccionamiento que se usó para solicitar el código de autorización. Debe ser el mismo URI configurado para el registro de aplicaciones.

options

AuthorizationCodeCredentialOptions

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 mediante una autenticación obtenida de 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:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

Parámetros

tenantId

string

Identificador o nombre del inquilino (directorio) de Microsoft Entra. Se puede usar "common" al tratar con escenarios multiinquilino.

clientId

string

Identificador de cliente (aplicación) de un registro de aplicación 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 redireccionamiento que se usó para solicitar el código de autorización. Debe ser el mismo URI configurado para el registro de aplicaciones.

options

AuthorizationCodeCredentialOptions

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 se ejecuta correctamente. Si se produce un error en la autenticación, se producirá un 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 usadas para configurar las solicitudes que podría realizar esta implementación de TokenCredential.

Devoluciones

Promise<AccessToken>