InteractiveBrowserCredential Класс
Открывает браузер для интерактивной проверки подлинности пользователя.
get_token открывает в браузере URL-адрес для входа, предоставленный Azure Active Directory, и выполняет проверку подлинности пользователя с помощью потока кода авторизации, используя PKCE (ключ подтверждения для Code Exchange) для внутренней защиты кода.
- Наследование
-
azure.identity._internal.interactive.InteractiveCredentialInteractiveBrowserCredential
Конструктор
InteractiveBrowserCredential(**kwargs: Any)Параметры
- authority
- str
Центр конечной точки Azure Active Directory, например "login.microsoftonline.com", центр для общедоступного облака Azure (по умолчанию). AzureAuthorityHosts определяет полномочия для других облаков.
- tenant_id
- str
идентификатор клиента Azure Active Directory. По умолчанию используется клиент "организации", который может проверять подлинность рабочих или учебных учетных записей.
- client_id
- str
Идентификатор клиента приложения Azure Active Directory, в который будут входить пользователи. Если это не указано, пользователи будут проходить проверку подлинности в приложении разработки Azure.
- login_hint
- str
предложение имени пользователя для предварительного заполнения поля имени пользователя или адреса электронной почты страницы входа. Пользователь по-прежнему может войти с другим именем пользователя.
- redirect_uri
- str
URI перенаправления для приложения, определяемого client_id как настроено в Azure Active Directory, например "http://localhost:8400 ". Это необходимо только при передаче значения для client_id и должно соответствовать URI перенаправления в регистрации приложения. Учетные данные должны иметь возможность привязки сокета к этому URI.
- authentication_record
- AuthenticationRecord
AuthenticationRecord возвращается authenticate
- disable_automatic_authentication
- bool
Если значение равно True, вызываетсяAuthenticationRequiredError, get_token когда для получения маркера требуется взаимодействие с пользователем. Значение по умолчанию — False.
- cache_persistence_options
- TokenCachePersistenceOptions
конфигурация для кэширования постоянных маркеров. Если они не указаны, учетные данные будут кэшировать маркеры в памяти.
- timeout
- int
секунды на ожидание завершения проверки подлинности пользователем. Значение по умолчанию — 300 (5 минут).
- disable_instance_discovery
- bool
Определяет, выполняется ли обнаружение экземпляра при попытке проверки подлинности. Если задать для этого параметра значение true, обнаружение экземпляров и проверка центра полностью отключается. Эта функция предназначена для использования в сценариях, где не удается достичь конечной точки метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров влечет за собой получение метаданных центра https://login.microsoft.com/ для проверки центра. Если задать для этого параметра значение True, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и надежным.
Примеры
Создайте Объект InteractiveBrowserCredential.
from azure.identity import InteractiveBrowserCredential
credential = InteractiveBrowserCredential(
client_id="<client_id>",
)
Методы
| authenticate |
Интерактивная проверка подлинности пользователя. |
| close | |
| get_token |
Запрос маркера доступа для областей. Этот метод вызывается автоматически клиентами пакета SDK Azure. |
authenticate
Интерактивная проверка подлинности пользователя.
authenticate(**kwargs: Any) -> AuthenticationRecordПараметры
области для запроса во время проверки подлинности, например области, предоставляемые scopes. Если этот параметр указан, успешная проверка подлинности кэширует маркер доступа для этих областей.
- claims
- str
дополнительные утверждения, необходимые в маркере, например те, которые предоставляются claims
Возвращаемый тип
Исключения
сбой проверки подлинности. Атрибут ошибки message указывает причину.
close
close() -> NoneИсключения
сбой проверки подлинности. Атрибут ошибки message указывает причину.
get_token
Запрос маркера доступа для областей.
Этот метод вызывается автоматически клиентами пакета SDK Azure.
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessTokenПараметры
- scopes
- str
требуемые области для маркера доступа. Для этого метода требуется по крайней мере одна область. Дополнительные сведения об областях см. в разделе https://video2.skills-academy.com/azure/active-directory/develop/scopes-oidc.
- claims
- str
дополнительные утверждения, необходимые в маркере, например те, которые возвращаются в запросе утверждений поставщика ресурсов после сбоя авторизации
- tenant_id
- str
необязательный клиент для включения в запрос маркера.
- enable_cae
- bool
указывает, следует ли включить непрерывную оценку доступа (CAE) для запрошенного маркера. Значение по умолчанию — False.
Возвращаемое значение
Маркер доступа с нужными областями.
Возвращаемый тип
Исключения
учетные данные не могут попытаться выполнить проверку подлинности из-за отсутствия необходимых данных, состояния или поддержки платформы
сбой проверки подлинности. Атрибут ошибки message указывает причину.
Для получения маркера необходимо взаимодействие с пользователем, и учетные данные настроены для автоматического запуска. Вызов
, чтобы начать интерактивную проверку подлинности.