CreateUserProvisioning による RAM ユーザープロビジョニング作成 - CloudSSO

Resource Access Management (RAM) ユーザープロビジョニングを作成します。

操作説明

リソースディレクトリ内のメンバーに対して RAM ユーザープロビジョニングを作成することで、CloudSSO ユーザーと同じユーザー名を持つ RAM ユーザーを作成できます。これにより、CloudSSO ユーザーは RAM ユーザーとしてメンバーのリソースにアクセスできるようになります。

今すぐお試しください

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

create

*UserProvisioning

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user-provisioning/*

*Account

acs:resourcemanager::{#accountId}:account/{#AccountId}

Group

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

User

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DirectoryId	string	必須	リソースディレクトリの ID です。	d-003qew84****
DuplicationStrategy	string	必須	競合時の処理ポリシーです。CloudSSO ユーザーが RAM に同期される際に、既に同名の RAM ユーザーが存在する場合に適用されます。有効な値は以下のとおりです。 KeepBoth：CloudSSO ユーザーを RAM に同期する際、同名の RAM ユーザーが既に存在する場合、システムは CloudSSO ユーザーのユーザー名に接尾辞 `_sso` を付加した新しい RAM ユーザーを作成します。 TakeOver：CloudSSO ユーザーを RAM に同期する際、同名の RAM ユーザーが既に存在する場合、システムは既存の RAM ユーザーを CloudSSO ユーザーで置き換えます。	KeepBoth
DeletionStrategy	string	必須	削除ポリシーです。RAM ユーザープロビジョニングを削除する際に、同期済みユーザーをどのように管理するかを指定します。有効な値は以下のとおりです。 Delete：RAM ユーザープロビジョニングを削除すると、システムは同期済みユーザーも削除します。 Keep：RAM ユーザープロビジョニングを削除しても、システムは同期済みユーザーを保持します。	Delete
Description	string	任意	説明文です。	This is a user provisioning.
PrincipalId	string	必須	RAM ユーザープロビジョニングの ID です。有効な値は以下のとおりです。 `PrincipalType` パラメーターを `Group` に設定した場合、このパラメーターの値は CloudSSO ユーザーグループの ID (g-******) です。 `PrincipalType` パラメーターを `User` に設定した場合、このパラメーターの値は CloudSSO ユーザーの ID (u-******) です。	g-02ha881d*****
PrincipalType	string	必須	RAM ユーザープロビジョニングの ID タイプです。有効な値は以下のとおりです。 User：RAM ユーザープロビジョニングの ID は CloudSSO ユーザーです。 Group：RAM ユーザープロビジョニングの ID は CloudSSO ユーザーグループです。	Group
TargetId	string	必須	RAM ユーザープロビジョニングを作成する対象オブジェクトの ID です。この値は、リソースディレクトリ内のメンバーの ID に固定されます。	1743382******
TargetType	string	必須	RAM ユーザープロビジョニングを作成する対象オブジェクトです。この値は `RD-Account` に固定されます。	RD-Account

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
UserProvisioning	object	RAM ユーザープロビジョニングの情報です。
Status	string	RAM ユーザープロビジョニングのステータスです。有効な値は以下のとおりです。 Enabled Disabled	Enabled
Description	string	説明文です。	This is a user provisioning.
UserProvisioningId	string	RAM ユーザープロビジョニングの ID です。	up-002axzhapcbz6e63****
PrincipalId	string	RAM ユーザープロビジョニングの ID です。有効な値は以下のとおりです。 `PrincipalType` パラメーターの戻り値が `Group` の場合、このパラメーターの値は CloudSSO ユーザーグループの ID (g-******) です。 `PrincipalType` パラメーターの戻り値が `User` の場合、このパラメーターの値は CloudSSO ユーザーの ID (u-******) です。	g-02ha881d*****
TargetPath	string	メンバー向けに RAM ユーザープロビジョニングを作成するリソースディレクトリのパスです。	rd-****/root/test
UpdateTime	string	更新時刻です。協定世界時 (UTC) で表示されます。	2022-11-28T03:55:42Z
DuplicationStrategy	string	競合時の処理ポリシーです。CloudSSO ユーザーが RAM に同期される際に、既に同名の RAM ユーザーが存在する場合に適用されます。有効な値は以下のとおりです。 KeepBoth：CloudSSO ユーザーを RAM に同期する際、同名の RAM ユーザーが既に存在する場合、システムは CloudSSO ユーザーのユーザー名に接尾辞 `_sso` を付加した新しい RAM ユーザーを作成します。 TakeOver：CloudSSO ユーザーを RAM に同期する際、同名の RAM ユーザーが既に存在する場合、システムは既存の RAM ユーザーを CloudSSO ユーザーで置き換えます。	KeepBoth
DeletionStrategy	string	削除ポリシーです。RAM ユーザープロビジョニングを削除する際に、同期済みユーザーをどのように管理するかを指定します。有効な値は以下のとおりです。 Delete：RAM ユーザープロビジョニングを削除すると、システムは同期済みユーザーも削除します。 Keep：RAM ユーザープロビジョニングを削除しても、システムは同期済みユーザーを保持します。	Delete
PrincipalName	string	RAM ユーザープロビジョニングの ID 名です。有効な値は以下のとおりです。 `PrincipalType` パラメーターの戻り値が `Group` の場合、このパラメーターの値は CloudSSO ユーザーグループの名前です。 `PrincipalType` パラメーターの戻り値が `User` の場合、このパラメーターの値は CloudSSO ユーザーの名前です。	testGroupName
TargetName	string	RAM ユーザープロビジョニングを作成する対象オブジェクトの名前です。この値は、リソースディレクトリ内のメンバーの名前に固定されます。	testTargetName
TargetId	string	RAM ユーザープロビジョニングを作成する対象オブジェクトの ID です。この値は、リソースディレクトリ内のメンバーの ID に固定されます。	1743382******
CreateTime	string	作成時刻です。協定世界時 (UTC) で表示されます。	2022-11-28T03:55:42Z
DirectoryId	string	リソースディレクトリの ID です。	d-003qew84****
OwnerPk	string	リソースディレクトリが属する Alibaba Cloud アカウントの ID です。	1639738******
TargetType	string	RAM ユーザープロビジョニングを作成する対象オブジェクトです。この値は `RD-Account` に固定されます。	RD-Account
PrincipalType	string	RAM ユーザープロビジョニングの ID タイプです。有効な値は以下のとおりです。 User：RAM ユーザープロビジョニングの ID は CloudSSO ユーザーです。 Group：RAM ユーザープロビジョニングの ID は CloudSSO ユーザーグループです。	Group
RequestId	string	リクエスト ID です。	F6F90F3D-4502-5877-B80B-97476F6AE2CC

例

成功レスポンス

JSONJSON

{
  "UserProvisioning": {
    "Status": "Enabled",
    "Description": "This is a user provisioning.",
    "UserProvisioningId": "up-002axzhapcbz6e63****",
    "PrincipalId": "g-02ha881d*****",
    "TargetPath": "rd-******/root/test**",
    "UpdateTime": "2022-11-28T03:55:42Z",
    "DuplicationStrategy": "KeepBoth",
    "DeletionStrategy": "Delete",
    "PrincipalName": "testGroupName",
    "TargetName": "testTargetName",
    "TargetId": "1743382******",
    "CreateTime": "2022-11-28T03:55:42Z",
    "DirectoryId": "d-003qew84****",
    "OwnerPk": "1639738******",
    "TargetType": "RD-Account",
    "PrincipalType": "Group"
  },
  "RequestId": "F6F90F3D-4502-5877-B80B-97476F6AE2CC"
}

エラーコード

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

変更履歴

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