AuthorizationCodeCredential class
Включает проверку подлинности в идентификаторе Microsoft Entra с помощью кода авторизации, полученного с помощью потока кода авторизации, описанного более подробно в документации по идентификатору Microsoft Entra ID:
https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
Конструкторы
Authorization |
Создает экземпляр AuthorizationCodeCredential с подробными сведениями, необходимыми для запроса маркера доступа с помощью проверки подлинности, полученной из идентификатора Microsoft Entra. В настоящее время пользователю этих учетных данных необходимо инициировать поток кода авторизации, чтобы получить код авторизации, используемый с данными учетными данными. Ниже приведен полный пример этого потока: |
Authorization |
Создает экземпляр AuthorizationCodeCredential с подробными сведениями, необходимыми для запроса маркера доступа с помощью проверки подлинности, полученной из идентификатора Microsoft Entra. В настоящее время пользователю этих учетных данных необходимо инициировать поток кода авторизации, чтобы получить код авторизации, используемый с данными учетными данными. Ниже приведен полный пример этого потока: |
Методы
get |
Выполняет проверку подлинности с помощью идентификатора Microsoft Entra и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается ошибкой, CredentialUnavailableError будет возникать с подробными сведениями об ошибке. |
Сведения о конструкторе
AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)
Создает экземпляр AuthorizationCodeCredential с подробными сведениями, необходимыми для запроса маркера доступа с помощью проверки подлинности, полученной из идентификатора Microsoft Entra.
В настоящее время пользователю этих учетных данных необходимо инициировать поток кода авторизации, чтобы получить код авторизации, используемый с данными учетными данными. Ниже приведен полный пример этого потока:
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), настроенным для регистрации приложений.
Параметры настройки клиента, который делает запрос маркера доступа.
AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)
Создает экземпляр AuthorizationCodeCredential с подробными сведениями, необходимыми для запроса маркера доступа с помощью проверки подлинности, полученной из идентификатора Microsoft Entra.
В настоящее время пользователю этих учетных данных необходимо инициировать поток кода авторизации, чтобы получить код авторизации, используемый с данными учетными данными. Ниже приведен полный пример этого потока:
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), настроенным для регистрации приложений.
Параметры настройки клиента, который делает запрос маркера доступа.
Сведения о методе
getToken(string | string[], GetTokenOptions)
Выполняет проверку подлинности с помощью идентификатора Microsoft Entra и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается ошибкой, CredentialUnavailableError будет возникать с подробными сведениями об ошибке.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>
Параметры
- scopes
-
string | string[]
Список областей, для которых маркер будет иметь доступ.
- options
- GetTokenOptions
Параметры, используемые для настройки любых запросов этой реализации TokenCredential, могут выполняться.
Возвращаемое значение
Promise<AccessToken>