AuthorizationCodeCredential class

  • Ссылка
Пакет:
@azure/identity

Позволяет выполнять проверку подлинности для Microsoft Entra ID с помощью кода авторизации, полученного с помощью потока кода авторизации, более подробно описанного в документации по Microsoft Entra ID:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow

Конструкторы

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

Создает экземпляр AuthorizationCodeCredential со сведениями, необходимыми для запроса маркера доступа с использованием проверки подлинности, полученной из Microsoft Entra ID.

В настоящее время пользователю с данными учетными данными необходимо инициировать поток кода авторизации, чтобы получить код авторизации, который будет использоваться с этим учетным данным. Полный пример этого потока приведен здесь:

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)

Создает экземпляр AuthorizationCodeCredential со сведениями, необходимыми для запроса маркера доступа с использованием проверки подлинности, полученной из Microsoft Entra ID.

В настоящее время пользователю с данными учетными данными необходимо инициировать поток кода авторизации, чтобы получить код авторизации, который будет использоваться с этим учетным данным. Полный пример этого потока приведен здесь:

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

Методы

getToken(string | string[], GetTokenOptions)

Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError со сведениями о сбое.

Сведения о конструкторе

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

Создает экземпляр AuthorizationCodeCredential со сведениями, необходимыми для запроса маркера доступа с использованием проверки подлинности, полученной из Microsoft Entra ID.

В настоящее время пользователю с данными учетными данными необходимо инициировать поток кода авторизации, чтобы получить код авторизации, который будет использоваться с этим учетным данным. Полный пример этого потока приведен здесь:

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)

Параметры

tenantId

string

Идентификатор или имя клиента (каталога) Microsoft Entra. "common" можно использовать при работе с мультитенантными сценариями.

clientId

string

Идентификатор клиента (приложения) регистрации приложения в клиенте.

authorizationCode

string

Код авторизации, полученный из следующего потока кода авторизации. Этот код авторизации не должен использоваться для получения маркера доступа.

redirectUri

string

URI перенаправления, который использовался для запроса кода авторизации. Это должен быть тот же URI, который настроен для регистрации приложения.

options
AuthorizationCodeCredentialOptions

Параметры настройки клиента, который выполняет запрос маркера доступа.

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

Создает экземпляр AuthorizationCodeCredential со сведениями, необходимыми для запроса маркера доступа с использованием проверки подлинности, полученной из Microsoft Entra ID.

В настоящее время пользователю с данными учетными данными необходимо инициировать поток кода авторизации, чтобы получить код авторизации, который будет использоваться с этим учетным данным. Полный пример этого потока приведен здесь:

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)

Параметры

tenantId

string

Идентификатор или имя клиента (каталога) Microsoft Entra. "common" можно использовать при работе с мультитенантными сценариями.

clientId

string

Идентификатор клиента (приложения) регистрации приложения в клиенте.

clientSecret

string

Секрет клиента, созданный для регистрации приложения.

authorizationCode

string

Код авторизации, полученный из следующего потока кода авторизации. Этот код авторизации не должен использоваться для получения маркера доступа.

redirectUri

string

URI перенаправления, который использовался для запроса кода авторизации. Это должен быть тот же URI, который настроен для регистрации приложения.

options
AuthorizationCodeCredentialOptions

Параметры настройки клиента, который выполняет запрос маркера доступа.

Сведения о методе

getToken(string | string[], GetTokenOptions)

Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError со сведениями о сбое.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Параметры

scopes

string | string[]

Список областей, доступ к которым будет иметь маркер.

options
GetTokenOptions

Параметры, используемые для настройки любых запросов, которые может выполнять реализация TokenCredential.

Возвращаемое значение

Promise<AccessToken>