API による RD アカウントからのアクセス構成のプロビジョニング解除 - CloudSSO

リソースディレクトリ内のアカウントからアクセス構成のプロビジョニングを解除します。

操作説明

この操作を呼び出すと、非同期タスクが自動的に作成されます。TaskId レスポンスパラメーターの値に基づいてタスクの進行状況を照会するには、GetTask 操作を呼び出します。

このトピックでは、リソースディレクトリ内のアカウント 114240524784**** からアクセス構成 ac-00jhtfl8thteu6uj**** のプロビジョニングを解除する方法の例を示します。

今すぐお試しください

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

update

*AccessConfiguration

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DirectoryId	string	必須	ディレクトリ ID。	d-00fc2p61****
AccessConfigurationId	string	必須	アクセス構成の ID。	ac-00jhtfl8thteu6uj****
TargetType	string	必須	タスクオブジェクトのタイプ。値を RD-Account に設定します。これは、リソースディレクトリ内のアカウントを指定します。	RD-Account
TargetId	string	必須	タスクオブジェクトの ID。	114240524784****

レスポンスフィールド

フィールド	型	説明	例
	object	返された結果。
Tasks	array<object>	タスク情報。
	object
Status	string	タスクステータス。有効な値は次のとおりです。 InProgress: タスクは実行中です。 Success: タスクは成功しました。 Failed: タスクは失敗しました。	InProgress
TaskId	string	タスク ID。	t-sh0655wnq8pdlrlc****
TargetPath	string	リソースディレクトリ内のタスクオブジェクトのパス ID。	rd-3G**/r-Wm/114240524784**
TargetName	string	タスクオブジェクトの名前。	dev-test
TargetId	string	タスクオブジェクトの ID。	114240524784****
AccessConfigurationName	string	アクセス構成の名前。	ECS-Admin
TargetPathName	string	リソースディレクトリ内のタスクオブジェクトのパス名。	rd-3G****/root/dev-test
TaskType	string	タスクタイプ。値は DeprovisionAccessConfiguration に固定されており、アクセス構成のプロビジョニングが解除されたことを示します。	DeprovisionAccessConfiguration
TargetType	string	タスクオブジェクトのタイプ。値は RD-Account に固定されており、リソースディレクトリ内のアカウントを示します。	RD-Account
AccessConfigurationId	string	アクセス構成の ID。	ac-00jhtfl8thteu6uj****
RequestId	string	リクエスト ID。	584FE9D0-D1AC-5B19-A39C-8D244FC0538C

例

成功レスポンス

JSONJSON

{
  "Tasks": [
    {
      "Status": "InProgress",
      "TaskId": "t-sh0655wnq8pdlrlc****",
      "TargetPath": "rd-3G****/r-Wm****/114240524784****",
      "TargetName": "dev-test",
      "TargetId": "114240524784****",
      "AccessConfigurationName": "ECS-Admin",
      "TargetPathName": "rd-3G****/root/dev-test",
      "TaskType": "DeprovisionAccessConfiguration",
      "TargetType": "RD-Account",
      "AccessConfigurationId": "ac-00jhtfl8thteu6uj****"
    }
  ],
  "RequestId": "584FE9D0-D1AC-5B19-A39C-8D244FC0538C"
}

エラーコード

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

変更履歴

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