CertificateCredential Класс

  • Ссылка

Выполняет проверку подлинности в качестве субъекта-службы с помощью сертификата.

Сертификат должен иметь закрытый ключ RSA, так как эти учетные данные подписывает утверждения с помощью RS256. Дополнительные сведения о настройке проверки подлинности на основе сертификата см. в документации по Azure Active Directory .

Наследование
azure.identity._internal.client_credential_base.ClientCredentialBase
CertificateCredential

Конструктор

CertificateCredential(tenant_id: str, client_id: str, certificate_path: str | None = None, **kwargs: Any)

Параметры

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

Идентификатор клиента субъекта-службы. Также называется идентификатором каталога.

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

Идентификатор клиента субъекта-службы

certificate_path
str
значение по умолчанию: None

Необязательный путь к файлу сертификата в формате PEM или PKCS12, включая закрытый ключ. Если этот параметр не указан, certificate_data является обязательным.

authority
str

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

certificate_data
bytes

Байты сертификата в формате PEM или PKCS12, включая закрытый ключ

password
str или bytes

Пароль сертификата. Если строка в Юникоде, она будет закодирована как UTF-8. Если сертификату требуется другая кодировка, передайте байты, закодированные соответствующим образом.

send_certificate_chain
bool

Если задано значение True, учетные данные отправят цепочку общедоступных сертификатов в заголовке x5c JWT каждого запроса маркера. Это необходимо для проверки подлинности имени субъекта или издателя (SNI). Значение по умолчанию — False.

cache_persistence_options
TokenCachePersistenceOptions

Конфигурация для постоянного кэширования маркеров. Если это не указано, учетные данные будут кэшировать маркеры в памяти.

disable_instance_discovery
bool

Определяет, выполняется ли обнаружение экземпляра при попытке проверки подлинности. Если задать для этого параметра значение true, обнаружение экземпляров и проверка центра будут полностью отключены. Эта функция предназначена для использования в сценариях, где не удается получить доступ к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров подразумевает получение метаданных центра для https://login.microsoft.com/ проверки центра. Если присвоить этому параметру значение True, проверка центра отключается. Поэтому важно убедиться, что настроенный узел центра является допустимым и надежным.

additionally_allowed_tenants
List[str]

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

Примеры

Создайте CertificateCredential.


   from azure.identity import CertificateCredential

   credential = CertificateCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       certificate_path="<path to PEM/PKCS12 certificate>",
       password="<certificate password if necessary>",
   )

   # Certificate/private key byte data can also be passed directly
   credential = CertificateCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       certificate_data=b"<cert data>",
   )

Методы

close
get_token

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

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

close 

close() -> None

get_token

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

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

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.

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

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

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

AccessToken

Исключения

CredentialUnavailableError

учетные данные не могут попытаться выполнить проверку подлинности, так как не хватает необходимых данных, состояния или поддержки платформы.

ClientAuthenticationError

сбой проверки подлинности. Атрибут ошибки message указывает причину.