OnBehalfOfCredential Класс
Выполняет проверку подлинности субъекта-службы с помощью потока on-behalf-of.
Этот поток обычно используется службами среднего уровня, которые авторизуют запросы к другим службам с делегированным удостоверением пользователя. Так как это не интерактивный поток проверки подлинности, приложение, использующее его, должно иметь согласие администратора на любые делегированные разрешения, прежде чем запрашивать маркеры для них. Более подробное описание потока on-behalf-of см. в документации по Azure Active Directory .
- Наследование
-
azure.identity.aio._internal.AsyncContextManagerOnBehalfOfCredentialazure.identity.aio._internal.get_token_mixin.GetTokenMixinOnBehalfOfCredential
Конструктор
OnBehalfOfCredential(tenant_id: str, client_id: str, *, client_certificate: bytes | None = None, client_secret: str | None = None, user_assertion: str, **kwargs: Any)
Параметры
- tenant_id
- str
Идентификатор клиента субъекта-службы. Также называется идентификатором каталога.
- client_secret
- str
Необязательный элемент. Секрет клиента для проверки подлинности субъекта-службы. Необходимо указать client_secret или client_certificate .
- client_certificate
- bytes
Необязательный элемент. Байты сертификата в формате PEM или PKCS12, включая закрытый ключ для проверки подлинности субъекта-службы. Необходимо указать client_secret или client_certificate .
- user_assertion
- str
Обязательный. Маркер доступа, который учетные данные будут использовать в качестве утверждения пользователя при запросе маркеров on-behalf-of
- authority
- str
Центр конечной точки Azure Active Directory, например "login.microsoftonline.com", центр для общедоступного облака Azure (по умолчанию). AzureAuthorityHosts определяет полномочия для других облаков.
Пароль сертификата. Используется только при указании client_certificate . Если это значение является строкой Юникода, оно будет закодировано как UTF-8. Если для сертификата требуется другая кодировка, передайте байты, закодированные соответствующим образом.
Указывает клиентов в дополнение к указанному "tenant_id", для которого учетные данные могут получать маркеры. Добавьте значение подстановочного знака "*", чтобы разрешить учетным данным получать маркеры для любого клиента, к который может получить доступ приложение.
Примеры
Создайте Объект OnBehalfOfCredential.
from azure.identity.aio import OnBehalfOfCredential
credential = OnBehalfOfCredential(
tenant_id="<tenant_id>",
client_id="<client_id>",
client_secret="<client_secret>",
user_assertion="<access_token>",
)
Методы
close | |
get_token |
Запрос маркера доступа для областей. Этот метод вызывается автоматически клиентами пакета SDK Azure. |
close
async close() -> None
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
необязательный клиент для включения в запрос маркера.
- enable_cae
- bool
указывает, следует ли включить непрерывную оценку доступа (CAE) для запрошенного маркера. Значение по умолчанию — False.
Возвращаемое значение
Маркер доступа с нужными областями.
Возвращаемый тип
Исключения
учетные данные не могут попытаться выполнить проверку подлинности из-за отсутствия необходимых данных, состояния или поддержки платформы
сбой проверки подлинности. Атрибут ошибки message
указывает причину.
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по