ログイン設定と GetLoginPreference API 概要 - CloudSSO

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cloudsso:GetLoginPreference

get

*Directory

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DirectoryId	string	必須	ディレクトリの ID。	d-00fc2p61****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	8CE8B990-193D-50CE-A604-69F3E7DCE740
LoginPreference	object	ログインプリファレンス。
LoginNetworkMasks	string	IP アドレスホワイトリスト。CloudSSO ユーザーは、ホワイトリスト内の IP アドレスを使用してのみ CloudSSO ユーザーポータルにログインできます。 IP アドレスホワイトリストは、ユーザー名とパスワードによるログインまたはシングルサインオン (SSO) メソッドを使用して CloudSSO ユーザーポータルにログインする CloudSSO ユーザーにのみ有効です。IP アドレスホワイトリストは、CloudSSO ユーザーポータルからリソースディレクトリ内のアカウントにアクセスする CloudSSO ユーザーには有効ではありません。このパラメーターの戻り値が Empty の場合、IP アドレスホワイトリストは設定されていません。	192.168.0.0/16;10.0.0.0/8
AllowUserToGetCredentials	boolean	ユーザーがポータルにログインした後、アプリケーションのアクセス認証情報を取得できるかどうかを示します。有効な値： True False (デフォルト)	True

例

成功レスポンス

JSONJSON

{
  "RequestId": "8CE8B990-193D-50CE-A604-69F3E7DCE740",
  "LoginPreference": {
    "LoginNetworkMasks": "192.168.0.0/16;10.0.0.0/8",
    "AllowUserToGetCredentials": true
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。