Aracılığıyla paylaş

OnBehalfOfCredential Sınıf

  • Başvuru

Hizmet sorumlusunun kimliğini adına akış aracılığıyla doğrular.

Bu akış genellikle temsilci kullanıcı kimliğiyle diğer hizmetlere yönelik istekleri yetkilendirilen orta katman hizmetleri tarafından kullanılır. Bu etkileşimli bir kimlik doğrulama akışı olmadığından, kullanan bir uygulamanın belirteç istemeden önce temsilci izinleri için yönetici onayına sahip olması gerekir. Adına akışın daha ayrıntılı bir açıklaması için bkz. Azure Active Directory belgeleri .

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

Oluşturucu

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

Parametreler

tenant_id
str
Gerekli

Hizmet sorumlusunun kiracısının kimliği. "Dizin" kimliği olarak da adlandırılır.

client_id
str
Gerekli

Hizmet sorumlusunun istemci kimliği

client_secret
str

İsteğe bağlı. Hizmet sorumlusunun kimliğini doğrulamak için bir istemci gizli dizisi. client_secret veya client_certificate sağlanmalıdır.

client_certificate
bytes

İsteğe bağlı. Hizmet sorumlusunun kimliğini doğrulamak için özel anahtar da dahil olmak üzere PEM veya PKCS12 biçimindeki bir sertifikanın baytları. client_secret veya client_certificate sağlanmalıdır.

user_assertion
str

Gereklidir. Kimlik bilgilerinin, adına belirteçler istediğinizde kullanıcı onayı olarak kullanacağı erişim belirteci

authority
str

Azure Active Directory uç noktasının yetkilisi, örneğin "login.microsoftonline.com", Azure Genel Bulut yetkilisi (varsayılandır). AzureAuthorityHosts diğer bulutların yetkililerini tanımlar.

password
str veya bytes

Sertifika parolası. Yalnızca client_certificate sağlandığında kullanılır. Bu değer bir unicode dizesiyse UTF-8 olarak kodlanır. Sertifika farklı bir kodlama gerektiriyorsa, bunun yerine uygun şekilde kodlanmış baytları geçirin.

disable_instance_discovery
bool

Kimlik doğrulaması denenirken örnek bulma işleminin gerçekleştirilip gerçekleştirilmeyeceğini belirler. Bunu true olarak ayarlamak hem örnek bulma hem de yetkili doğrulamayı tamamen devre dışı bırakır. Bu işlevsellik, özel bulutlar veya Azure Stack gibi meta veri uç noktasına ulaşılamadığı senaryolarda kullanılmak üzere tasarlanmıştır. Örnek bulma işlemi, yetkiliyi doğrulamak için yetkili meta verilerinin 'den https://login.microsoft.com/ alınmasını gerektirir. Bunu True olarak ayarladığınızda, yetkilinin doğrulaması devre dışı bırakılır. Sonuç olarak, yapılandırılan yetkili konağın geçerli ve güvenilir olduğundan emin olmak çok önemlidir.

additionally_allowed_tenants
List[str]

Kimlik bilgilerinin belirteçleri edinebileceği belirtilen "tenant_id" ek olarak kiracıları belirtir. Kimlik bilgilerinin uygulamanın erişebileceği herhangi bir kiracı için belirteç almasına izin vermek için "*" joker karakter değerini ekleyin.

Örnekler

OnBehalfOfCredential oluşturun.


   from azure.identity import OnBehalfOfCredential

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

Yöntemler

close
get_token

Kapsamlar için erişim belirteci isteyin.

Bu yöntem Azure SDK istemcileri tarafından otomatik olarak çağrılır.

close 

close() -> None

get_token

Kapsamlar için erişim belirteci isteyin.

Bu yöntem Azure SDK istemcileri tarafından otomatik olarak çağrılır.

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

Parametreler

scopes
str
Gerekli

erişim belirteci için istenen kapsamlar. Bu yöntem en az bir kapsam gerektirir. Kapsamlar hakkında daha fazla bilgi için bkz https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc. .

claims
str

bir yetkilendirme hatasından sonra kaynak sağlayıcısının talep sınamasında döndürülenler gibi belirteçte gerekli olan ek talepler.

tenant_id
str

belirteç isteğine dahil etmek için isteğe bağlı kiracı.

enable_cae
bool

istenen belirteç için Sürekli Erişim Değerlendirmesi'nin (CAE) etkinleştirilip etkinleştirilmeydiğini gösterir. Varsayılan değer False'tur.

Döndürülenler

İstenen kapsamlara sahip bir erişim belirteci.

Dönüş türü

AccessToken

Özel durumlar

CredentialUnavailableError

kimlik bilgisi gerekli veri, durum veya platform desteğine sahip olmadığından kimlik doğrulamayı deneyemiyor

ClientAuthenticationError

kimlik doğrulaması başarısız oldu. Hatanın message özniteliği bir neden verir.