OnBehalfOfCredential Klass

  • Referens

Autentiserar ett huvudnamn för tjänsten via å-behalf-of-flödet.

Det här flödet används vanligtvis av mellannivåtjänster som auktoriserar begäranden till andra tjänster med en delegerad användaridentitet. Eftersom detta inte är ett interaktivt autentiseringsflöde måste ett program som använder det ha administratörsmedgivande för eventuella delegerade behörigheter innan token begärs för dem. Se Azure Active Directory-dokumentationen för en mer detaljerad beskrivning av flödets räkning.

Arv
azure.identity._internal.msal_credentials.MsalCredential
OnBehalfOfCredential
azure.identity._internal.get_token_mixin.GetTokenMixin
OnBehalfOfCredential

Konstruktor

OnBehalfOfCredential(tenant_id: str, client_id: str, **kwargs: Any)

Parametrar

tenant_id
str
Obligatorisk

ID för tjänstens huvudnamns klientorganisation. Kallas även dess "katalog"-ID.

client_id
str
Obligatorisk

Tjänstens huvudnamns klient-ID

client_secret
str

Valfritt. En klienthemlighet för att autentisera tjänstens huvudnamn. Antingen client_secret eller client_certificate måste anges.

client_certificate
bytes

Valfritt. Byte för ett certifikat i PEM- eller PKCS12-format, inklusive den privata nyckeln för att autentisera tjänstens huvudnamn. Antingen client_secret eller client_certificate måste anges.

user_assertion
str

Krävs. Åtkomsttoken som autentiseringsuppgiften använder som användarkontroll när du begär tokens för räkning

authority
str

Utfärdare av en Azure Active Directory-slutpunkt, till exempel "login.microsoftonline.com", utfärdaren för Azure Public Cloud (som är standard). AzureAuthorityHosts definierar myndigheter för andra moln.

password
str eller bytes

Ett certifikatlösenord. Används endast när client_certificate tillhandahålls. Om det här värdet är en unicode-sträng kodas det som UTF-8. Om certifikatet kräver en annan kodning skickar du lämpliga kodade byte i stället.

disable_instance_discovery
bool

Avgör om instansidentifiering utförs när du försöker autentisera. Om du anger sant inaktiveras både instansidentifiering och verifiering av utfärdare helt. Den här funktionen är avsedd att användas i scenarier där metadataslutpunkten inte kan nås, till exempel i privata moln eller Azure Stack. Processen för instansidentifiering innebär att auktoritetsmetadata hämtas från https://login.microsoft.com/ för att verifiera utfärdaren. Genom att ställa in detta på Sant inaktiveras verifieringen av utfärdaren. Därför är det viktigt att se till att den konfigurerade utfärdarens värd är giltig och tillförlitlig.

additionally_allowed_tenants
List[str]

Anger klientorganisationer utöver den angivna "tenant_id" som autentiseringsuppgifterna kan hämta token för. Lägg till jokertecknets värde "*" så att autentiseringsuppgifterna kan hämta token för alla klientorganisationer som programmet kan komma åt.

Exempel

Skapa en OnBehalfOfCredential.


   from azure.identity import OnBehalfOfCredential

   credential = OnBehalfOfCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       client_secret="<client_secret>",
       user_assertion="<access_token>",
   )

Metoder

close
get_token

Begär en åtkomsttoken för omfång.

Den här metoden anropas automatiskt av Azure SDK-klienter.

close 

close() -> None

get_token

Begär en åtkomsttoken för omfång.

Den här metoden anropas automatiskt av Azure SDK-klienter.

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

Parametrar

scopes
str
Obligatorisk

önskade omfång för åtkomsttoken. Den här metoden kräver minst ett omfång. Mer information om omfång finns i https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

ytterligare anspråk som krävs i token, till exempel de som returneras i en resursproviders anspråksutmaning efter ett auktoriseringsfel.

tenant_id
str

valfri klientorganisation som ska inkluderas i tokenbegäran.

enable_cae
bool

anger om du vill aktivera kontinuerlig åtkomstutvärdering (CAE) för den begärda token. Standardvärdet är Falskt.

Returer

En åtkomsttoken med önskade omfång.

Returtyp

AccessToken

Undantag

CredentialUnavailableError

autentiseringsuppgiften kan inte försöka autentisering eftersom den saknar stöd för data, tillstånd eller plattform

ClientAuthenticationError

autentiseringen misslyckades. Felets message attribut ger en orsak.