CloudSSO API でアクセス構成更新を自動化 - CloudSSO

アクセス構成の情報を変更します。

操作説明

アクセス構成の Description、SessionDuration、RelayState パラメーターを変更できます。

このトピックでは、アクセス構成 ac-00jhtfl8thteu6uj**** の初期 Web ページを https://cloudsso.console.alibabacloud.com に変更する方法の例を示します。

今すぐお試しください

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

update

*AccessConfiguration

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DirectoryId	string	必須	ディレクトリの ID。	d-00fc2p61****
AccessConfigurationId	string	必須	アクセス構成の ID。	ac-00jhtfl8thteu6uj****
NewDescription	string	任意	アクセス構成の新しい説明。説明は、最大 1,024 文字です。	This is an access configuration.
NewSessionDuration	integer	任意	CloudSSO ユーザーがアクセス構成を使用してリソースディレクトリ内のアカウントにアクセスするセッションの新しい持続時間。単位：秒。有効値：900～43200。値 900 は 15 分を示します。値 43200 は 12 時間を示します。有効な値: 900～43200。値 900 は 15 分です。値 43200 は 12 時間です。	3600
NewRelayState	string	任意	新しい初期 Web ページ。 CloudSSO ユーザーが、アクセス構成を使用してご利用のリソースディレクトリ内のアカウントにアクセスした後に表示されます。この Web ページは、Alibaba Cloud 管理コンソールのページである必要があります。	https://cloudsso.console.alibabacloud.com

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	9B13E4EE-3853-5852-9165-597C32AD8FB7
AccessConfiguration	object	アクセス構成に関する情報。
AccessConfigurationName	string	アクセス構成の名前。	ECS-Admin
SessionDuration	integer	セッションの持続時間 CloudSSO ユーザーがアクセス構成を用いてリソースディレクトリ内のアカウントにアクセスする際のセッション期間です。単位：秒。	3600
Description	string	アクセス構成の説明。	This is an access configuration.
RelayState	string	CloudSSO ユーザーがアクセス構成を使用してリソースディレクトリ内のアカウントにアクセスした後に表示される初期 Web ページ。 CloudSSO ユーザーがアクセス構成を使用してリソースディレクトリ内のアカウントにアクセスした後に表示されるもの。	https://cloudsso.console.alibabacloud.com
CreateTime	string	アクセス構成が作成された時間。	2021-11-02T08:44:23Z
UpdateTime	string	アクセス構成の情報が変更された時間。	2021-11-02T10:10:01Z
StatusNotifications	array	ステータス通知。
	string	ステータス通知。有効な値：空：ステータス通知は送信されません。 ReprovisionRequired：アクセス構成を再プロビジョニングする必要があります。	ReprovisionRequired
AccessConfigurationId	string	アクセス構成の ID。	ac-00jhtfl8thteu6uj****

例

成功レスポンス

JSONJSON

{
  "RequestId": "9B13E4EE-3853-5852-9165-597C32AD8FB7",
  "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-02T10:10:01Z",
    "StatusNotifications": [
      "ReprovisionRequired"
    ],
    "AccessConfigurationId": "ac-00jhtfl8thteu6uj****"
  }
}

エラーコード

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

変更履歴

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