AuthorizationCodeCredential Класс

  • Ссылка

Выполняет проверку подлинности путем активации кода авторизации, ранее полученного из Azure Active Directory.

Дополнительные сведения о потоке проверки подлинности см. в документации по Azure Active Directory .

Наследование
azure.identity.aio._internal.AsyncContextManager
AuthorizationCodeCredential
azure.identity.aio._internal.get_token_mixin.GetTokenMixin
AuthorizationCodeCredential

Конструктор

AuthorizationCodeCredential(tenant_id: str, client_id: str, authorization_code: str, redirect_uri: str, *, client_secret: str | None = None, **kwargs)

Параметры

tenant_id
str
Обязательно

Идентификатор клиента приложения Azure Active Directory. Также называется идентификатором каталога.

client_id
str
Обязательно

Идентификатор клиента приложения

authorization_code
str
Обязательно

Код авторизации из входа пользователя

redirect_uri
str
Обязательно

URI перенаправления приложения. Должен соответствовать универсальному коду ресурса (URI), используемому для запроса кода авторизации.

authority
str

Центр конечной точки Azure Active Directory, например "login.microsoftonline.com", центр для общедоступного облака Azure (по умолчанию). AzureAuthorityHosts определяет полномочия для других облаков.

client_secret
str

Один из секретов клиента приложения. Требуется только для веб-приложений и веб-API.

additionally_allowed_tenants
List[str]

Указывает клиентов в дополнение к указанному "tenant_id", для которого учетные данные могут получать маркеры. Добавьте значение подстановочного знака "*", чтобы разрешить учетным данным получать маркеры для любого клиента, к который может получить доступ приложение.

Примеры

Создайте AuthorizationCodeCredential.


   from azure.identity.aio import AuthorizationCodeCredential

   credential = AuthorizationCodeCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       authorization_code="<auth_code>",
       redirect_uri="<redirect_uri>",
   )

Методы

close

Закройте сеанс транспорта учетных данных.
get_token

Запрос маркера доступа для областей.

Этот метод вызывается автоматически клиентами пакета SDK Azure.

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

close

Закройте сеанс транспорта учетных данных.

async close()

get_token

Запрос маркера доступа для областей.

Этот метод вызывается автоматически клиентами пакета SDK Azure.

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

async get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

Параметры

scopes
str
Обязательно

требуемые области для маркера доступа. Для этого метода требуется по крайней мере одна область. Дополнительные сведения об областях см. в разделе https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

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

tenant_id
str

необязательный клиент для включения в запрос маркера.

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

Маркер доступа с нужными областями.

Возвращаемый тип

AccessToken

Исключения

ClientAuthenticationError

сбой проверки подлинности. Атрибут ошибки message указывает причину. Любой ответ об ошибке из Azure Active Directory доступен в качестве атрибута response ошибки.