ClientAssertionCredential Klasa

Uwierzytelnia jednostkę usługi przy użyciu asercji JWT.

To poświadczenie jest przeznaczone dla zaawansowanych scenariuszy. CertificateCredential ma bardziej wygodny interfejs API dla najbardziej typowego scenariusza asercji, uwierzytelnianie jednostki usługi przy użyciu certyfikatu.

Dziedziczenie

azure.identity._internal.get_token_mixin.GetTokenMixin

ClientAssertionCredential

Konstruktor

ClientAssertionCredential(tenant_id: str, client_id: str, func: Callable[[], str], **kwargs: Any)

Parametry

tenant_id

str

Wymagane

Identyfikator dzierżawy podmiotu zabezpieczeń. Nazwana również identyfikatorem "katalogu".

client_id

str

Wymagane

Identyfikator klienta podmiotu zabezpieczeń

func

Wymagane

Obiekt wywołujący, który zwraca asercji ciągu. Poświadczenie będzie wywoływać to za każdym razem, gdy uzyskuje nowy token.

authority

str

Urząd punktu końcowego usługi Azure Active Directory, na przykład "login.microsoftonline.com", urząd dla chmury publicznej platformy Azure (który jest domyślny). AzureAuthorityHosts definiuje władze dla innych chmur.

additionally_allowed_tenants

List[str]

Określa dzierżawy oprócz określonego "tenant_id", dla którego poświadczenia mogą uzyskiwać tokeny. Dodaj wartość symboli wieloznacznych "*", aby umożliwić poświadczeniu uzyskiwanie tokenów dla dowolnej dzierżawy, do jakiej aplikacja może uzyskać dostęp.

Przykłady

Utwórz element ClientAssertionCredential.

   from azure.identity import ClientAssertionCredential

   def get_assertion():
       return "<client-assertion>"

   credential = ClientAssertionCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       func=get_assertion,
   )

Metody

close
get_token	Zażądaj tokenu dostępu dla zakresów. Ta metoda jest wywoływana automatycznie przez klientów zestawu Azure SDK.

close

close() -> None

get_token

Zażądaj tokenu dostępu dla zakresów.

Ta metoda jest wywoływana automatycznie przez klientów zestawu Azure SDK.

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

Parametry

scopes

str

Wymagane

żądane zakresy tokenu dostępu. Ta metoda wymaga co najmniej jednego zakresu. Aby uzyskać więcej informacji na temat zakresów, zobacz https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

dodatkowe oświadczenia wymagane w tokenie, takie jak te zwrócone w wyzwaniu oświadczeń dostawcy zasobów po niepowodzeniu autoryzacji.

tenant_id

str

opcjonalna dzierżawa do uwzględnienia w żądaniu tokenu.

enable_cae

bool

wskazuje, czy włączyć ocenę ciągłego dostępu (CAE) dla żądanego tokenu. Wartość domyślna to False.

Zwraca

Token dostępu z żądanymi zakresami.

Typ zwracany

AccessToken

Wyjątki

CredentialUnavailableError

poświadczenie nie może podjąć próby uwierzytelnienia, ponieważ brakuje wymaganych danych, stanu lub obsługi platformy

ClientAuthenticationError

uwierzytelnianie nie powiodło się. Atrybut błędu message daje przyczynę.