CreateAccessConfiguration API で SSO アクセス設定を自動化 - CloudSSO

アクセス構成を作成します。

操作説明

アクセス構成の詳細については、「アクセス構成の概要」をご参照ください。

このトピックでは、ECS-Admin という名前のアクセス構成を作成する例を示します。

今すぐお試しください

この 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:CreateAccessConfiguration

create

*AccessConfiguration

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/access-configuration/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DirectoryId	string	必須	ディレクトリの ID です。	d-00fc2p61****
AccessConfigurationName	string	必須	アクセス構成の名前です。名前には英字、数字、およびハイフン (-) を使用できます。最大長は 32 文字です。	ECS-Admin
Description	string	任意	アクセス構成の説明です。最大長は 1,024 文字です。	This is an access configuration.
SessionDuration	integer	任意	ログイン会話の持続時間です。 Cloud SSO ユーザーがアクセス構成を使用してリソースディレクトリ内のメンバーにアクセスする場合、この期間が会話の最大アクティブ時間となります。単位：秒。有効範囲：900 ～ 43200（15 分～ 12 時間）。デフォルト値：3600（1 時間）。	3600
RelayState	string	任意	遷移先ページ（ランディングページ）です。 Cloud SSO ユーザーがリソースディレクトリ内のメンバーにログインした後、このページにリダイレクトされます。このページは Alibaba Cloud 管理コンソール内のページである必要があります。デフォルトでは空欄であり、Alibaba Cloud 管理コンソールのホームページにリダイレクトされます。	https://cloudsso.console.alibabacloud.com
Tags	array<object>	任意
	object	任意
Value	string	任意
Key	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object	応答データです。
RequestId	string	リクエストの ID です。	A3A41736-A050-50B6-ABC5-590F376A0044
AccessConfiguration	object	アクセス構成の情報です。
AccessConfigurationName	string	アクセス構成の名前です。	ECS-Admin
SessionDuration	integer	ログイン会話の持続時間です。 Cloud SSO ユーザーがアクセス構成を使用してリソースディレクトリ内のメンバーにアクセスする場合、この期間が会話の最大アクティブ時間となります。単位：秒。	3600
Description	string	アクセス構成の説明です。	This is an access configuration.
RelayState	string	遷移先ページ（ランディングページ）です。 Cloud SSO ユーザーがリソースディレクトリ内のメンバーにログインした後、このページにリダイレクトされます。	https://cloudsso.console.alibabacloud.com
CreateTime	string	アクセス構成が作成された時刻です。	2021-11-02T08:44:23Z
UpdateTime	string	アクセス構成が最後に更新された時刻です。	2021-11-02T08:44:23Z
StatusNotifications	array	ステータス通知です。
	string	ステータス通知の値です。有効な値は以下のとおりです。空欄の場合、ステータス通知は生成されません。 ReprovisionRequired：アクセス構成を再展開する必要があります。	ReprovisionRequired
AccessConfigurationId	string	アクセス構成の ID です。	ac-00jhtfl8thteu6uj****
Tags	array<object>
	object
Value	string
Key	string

例

成功レスポンス

JSONJSON

{
  "RequestId": "A3A41736-A050-50B6-ABC5-590F376A0044",
  "AccessConfiguration": {
    "AccessConfigurationName": "ECS-Admin",
    "SessionDuration": 3600,
    "Description": "This is an access configuration.",
    "RelayState": "https://cloudsso.console.alibabacloud.com",
    "CreateTime": "2021-11-02T08:44:23Z",
    "UpdateTime": "2021-11-02T08:44:23Z",
    "StatusNotifications": [
      "ReprovisionRequired"
    ],
    "AccessConfigurationId": "ac-00jhtfl8thteu6uj****",
    "Tags": [
      {
        "Value": "",
        "Key": ""
      }
    ]
  }
}

エラーコード

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

変更履歴

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