AuthorizationCodeCredential class
Обеспечивает аутентификацию по Microsoft Entra ID с использованием авторизационного кода, полученного через поток авторизационного кода, подробно описанного в документации Microsoft Entra ID:
https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
Конструкторы
| Authorization |
Создаёт экземпляр AuthorizationCodeCredential с данными, необходимыми для запроса токена доступа, используя аутентификацию, полученную из Microsoft Entra ID. В настоящее время пользователю этих учетных данных необходимо инициировать поток кода авторизации, чтобы получить код авторизации, используемый с данными учетными данными. Ниже приведен полный пример этого потока: |
| Authorization |
Создаёт экземпляр AuthorizationCodeCredential с данными, необходимыми для запроса токена доступа, используя аутентификацию, полученную из Microsoft Entra ID. В настоящее время пользователю этих учетных данных необходимо инициировать поток кода авторизации, чтобы получить код авторизации, используемый с данными учетными данными. Ниже приведен полный пример этого потока: |
Методы
| get |
Аутентифицируется с помощью Microsoft Entra ID и при успешном возвращении токена доступа. Если проверка подлинности завершается ошибкой, CredentialUnavailableError будет возникать с подробными сведениями об ошибке. |
Сведения о конструкторе
AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)
Создаёт экземпляр AuthorizationCodeCredential с данными, необходимыми для запроса токена доступа, используя аутентификацию, полученную из Microsoft Entra ID.
В настоящее время пользователю этих учетных данных необходимо инициировать поток кода авторизации, чтобы получить код авторизации, используемый с данными учетными данными. Ниже приведен полный пример этого потока:
new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Параметры
- tenantId
-
string
ID или имя арендатора (каталога) Microsoft Entra. "Common" может использоваться при работе с сценариями с несколькими клиентами.
- clientId
-
string
Идентификатор клиента (приложения) регистрации приложений в клиенте.
- authorizationCode
-
string
Код авторизации, полученный после потока кода авторизации. Этот код авторизации не должен использоваться для получения маркера доступа.
- redirectUri
-
string
URI перенаправления, используемый для запроса кода авторизации. Должен быть одинаковым универсальным кодом ресурса (URI), настроенным для регистрации приложений.
Параметры настройки клиента, который делает запрос маркера доступа.
AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)
Создаёт экземпляр AuthorizationCodeCredential с данными, необходимыми для запроса токена доступа, используя аутентификацию, полученную из Microsoft Entra ID.
В настоящее время пользователю этих учетных данных необходимо инициировать поток кода авторизации, чтобы получить код авторизации, используемый с данными учетными данными. Ниже приведен полный пример этого потока:
new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Параметры
- tenantId
-
string
ID или имя арендатора (каталога) Microsoft Entra. "Common" может использоваться при работе с сценариями с несколькими клиентами.
- clientId
-
string
Идентификатор клиента (приложения) регистрации приложений в клиенте.
- clientSecret
-
string
Секрет клиента, созданный для регистрации приложений
- authorizationCode
-
string
Код авторизации, полученный после потока кода авторизации. Этот код авторизации не должен использоваться для получения маркера доступа.
- redirectUri
-
string
URI перенаправления, используемый для запроса кода авторизации. Должен быть одинаковым универсальным кодом ресурса (URI), настроенным для регистрации приложений.
Параметры настройки клиента, который делает запрос маркера доступа.
Сведения о методе
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>