AuthenticationContext クラス
Azure Active Directory から認証トークンを取得します。
使用する場合は、次の "sample" フォルダーをチェックします。https://github.com/AzureAD/azure-activedirectory-library-for-python
新しい AuthenticationContext オブジェクトを作成します。
既定では、機関は既知の Azure Active Directory 機関の一覧に対してチェックされます。 機関がこれらの既知の機関の 1 つとして認識されない場合、トークンの取得は失敗します。 この動作は、以下の validate_authority パラメーターを使用してオフにすることができます。
- 継承
-
builtins.objectAuthenticationContext
コンストラクター
AuthenticationContext(authority, validate_authority=None, cache=None, api_version=None, timeout=None, enable_pii=False, verify_ssl=None, proxies=None)パラメーター
- cache
- TokenCache
(省略可能)この AuthenticationContext インスタンスで使用されるトークン キャッシュを設定します。 このパラメーターが設定されていない場合は、既定値が使用されます。 キャッシュ インスタンスは AuthenticationContext のそのインスタンスでのみ使用され、他の AuthenticationContexts の構築中に手動で渡されない限り共有されません。
- api_version
(省略可能)ネットワーク上で を使用する API バージョンを指定します。 従来、ハードコーディングされた既定値は "1.0" です。 開発者は、明示的に None に設定することをお勧めします。つまり、基になる API バージョンが自動的に選択されます。 ADAL Python 1.0 以降では、この既定値は None になります。
- timeout
(省略可能) 要求のタイムアウト。 サーバーがデータを送信するまで待機してから、float または (接続タイムアウト、読み取りタイムアウト) タプルとして、終了するまでの時間。
- enable_pii
(省略可能)True に設定されていない限り、個人を特定できる情報 (PII) はログに書き込まれません。
- verify_ssl
(省略可能) 要求の検証。 ブール値を指定します。この場合、サーバーの TLS 証明書を検証するか、文字列を確認するかを制御します。その場合は、使用する CA バンドルへのパスである必要があります。 この値が指定されず、env varaible が設定ADAL_PYTHON_SSL_NO_VERIFY場合、動作は verify_ssl=False に相当します。
- proxies
(省略可能) プロキシを要求します。 プロキシの URL へのディクショナリ マッピング プロトコル。 詳細については、http://docs.python-requests.org/en/master/user/advanced/#proxies を参照してください。
メソッド
| acquire_token |
キャッシュされたトークンを使用して、特定のリソースのトークンを取得します。 |
| acquire_token_with_authorization_code |
サーバー アプリの承認コードを使用して、特定のリソースのトークンを取得します。 |
| acquire_token_with_client_certificate |
証明書の資格情報を使用して、特定のリソースのトークンを取得します |
| acquire_token_with_client_credentials |
クライアント資格情報を使用して、特定のリソースのトークンを取得します。 |
| acquire_token_with_device_code |
デバイス コードを介して を使用して新しいアクセス トークンを取得します。 |
| acquire_token_with_refresh_token |
更新トークンを使用して、特定のリソースのトークンを取得します |
| acquire_token_with_username_password |
ユーザー credentails を使用して、特定のリソースのトークンを取得します。 |
| acquire_user_code |
デバイスでユーザーを認証するためのdevice_code user_codeを含むユーザー コード情報を取得します。 |
| cancel_request_to_get_token_with_device_code |
ポーリング要求を取り消して、デバイス コードを使用してトークンを取得します。 |
acquire_token
キャッシュされたトークンを使用して、特定のリソースのトークンを取得します。
acquire_token(resource, user_id, client_id)パラメーター
戻り値
dic には、"accessToken" と "refreshToken" が含まれます。
acquire_token_with_authorization_code
サーバー アプリの承認コードを使用して、特定のリソースのトークンを取得します。
acquire_token_with_authorization_code(authorization_code, redirect_uri, resource, client_id, client_secret=None, code_verifier=None)パラメーター
- client_secret
- str
(機密クライアントの場合のみ)呼び出し元アプリケーションの OAuth クライアント シークレット。 このパラメーターが設定されていない場合、既定値は None です
- code_verifier
- str
(省略可能)承認コード許可要求で PKCE が使用された場合に認証コードを取得するために使用されたコード検証ツール。(通常はパブリック クライアントによって使用されます)このパラメーターが設定されていない場合、既定値は None です
戻り値
複数のキーを使用して dict を指定し、"accessToken" と "refreshToken" を含めます。
acquire_token_with_client_certificate
証明書の資格情報を使用して、特定のリソースのトークンを取得します
acquire_token_with_client_certificate(resource, client_id, certificate, thumbprint, public_certificate=None)パラメーター
- public_certificate
None でない場合は、サブジェクト名と発行者ベースの認証のためにサービスに送信されます。これは、証明書の自動ロールをサポートすることです。 値は、証明書の秘密キー パラメーターと一致する必要があります。
戻り値
複数のキーを使用して dict を指定し、"accessToken" を含めます。
acquire_token_with_client_credentials
クライアント資格情報を使用して、特定のリソースのトークンを取得します。
acquire_token_with_client_credentials(resource, client_id, client_secret)パラメーター
戻り値
複数のキーを使用して dict を指定し、"accessToken" を含めます。
acquire_token_with_device_code
デバイス コードを介して を使用して新しいアクセス トークンを取得します。
acquire_token_with_device_code(resource, user_code_info, client_id)パラメーター
戻り値
複数のキーを使用して dict を指定し、"accessToken" と "refreshToken" を含めます。
acquire_token_with_refresh_token
更新トークンを使用して、特定のリソースのトークンを取得します
acquire_token_with_refresh_token(refresh_token, client_id, resource, client_secret=None)パラメーター
戻り値
複数のキーを使用して dict を指定し、"accessToken" と "refreshToken" を含めます。
acquire_token_with_username_password
ユーザー credentails を使用して、特定のリソースのトークンを取得します。
acquire_token_with_username_password(resource, username, password, client_id)パラメーター
戻り値
複数のキーを使用して dict を指定し、"accessToken" と "refreshToken" を含めます。
acquire_user_code
デバイスでユーザーを認証するためのdevice_code user_codeを含むユーザー コード情報を取得します。
acquire_user_code(resource, client_id, language=None)パラメーター
戻り値
dict には、ユーザーがブラウザー経由でログインするためのコードと URI が含まれています。
cancel_request_to_get_token_with_device_code
ポーリング要求を取り消して、デバイス コードを使用してトークンを取得します。
cancel_request_to_get_token_with_device_code(user_code_info)パラメーター
戻り値
なし
属性
options
Azure SDK for Python