CreateUser API で CloudSSO ディレクトリユーザーをプロビジョニング - 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:CreateUser

create

*User

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DirectoryId	string	必須	CloudSSO ディレクトリの ID。	d-00fc2p61****
UserName	string	必須	ユーザー名。ユーザー名はディレクトリ内で一意である必要があり、変更できません。ユーザー名には、数字、文字、および次の特殊文字 (`@_-.`) を含めることができます。ユーザー名は最大 64 文字です。	Alice
FirstName	string	任意	ユーザーの名。名は最大 64 文字です。	Alice
LastName	string	任意	ユーザーの姓。姓は最大 64 文字です。	Lee
DisplayName	string	任意	ユーザーの表示名。表示名は最大 256 文字です。	Alice
Description	string	任意	ユーザーの説明。説明は最大 1,024 文字です。	This is a user.
Email	string	任意	ユーザーのメールアドレス。メールアドレスはディレクトリ内で一意である必要があります。メールアドレスは最大 128 文字です。	Alice@example.com
Status	string	任意	ユーザーのステータス。有効な値: Enabled (デフォルト) Disabled	Enabled
Tags	array<object>	任意
	object	任意
Value	string	任意
Key	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータです。
User	object	ユーザーの詳細。
Status	string	ユーザーのステータス。有効な値: Enabled。 Disabled。	Enabled
UserName	string	ユーザー名。	Alice
Email	string	ユーザーのメールアドレス。	Alice@example.com
Description	string	ユーザーの説明。	This is a user.
UserId	string	ユーザー ID。	u-00q8wbq42wiltcrk****
FirstName	string	ユーザーの名（ファーストネーム）です。	Alice
CreateTime	string	ユーザーが作成された時刻。時刻は協定世界時 (UTC) で表示されます。	2021-10-26T03:03:42Z
ProvisionType	string	ユーザーのプロビジョニングタイプ。有効な値: Manual: ユーザーは手動で作成されました。 Synchronized: ユーザーは外部 IdP から同期されました。	Manual
DisplayName	string	ユーザーの表示名。	Alice
UpdateTime	string	ユーザーが最後に変更された時刻。時刻は協定世界時 (UTC) で表示されます。	2021-10-26T03:03:42Z
LastName	string	ユーザーの姓。	Lee
Tags	array<object>
	object
Value	string
Key	string
RequestId	string	リクエスト ID。	F6F90F3D-4502-5877-B80B-97476F6AE2CC

例

成功レスポンス

JSONJSON

{
  "User": {
    "Status": "Enabled",
    "UserName": "Alice",
    "Email": "Alice@example.com",
    "Description": "This is a user.",
    "UserId": "u-00q8wbq42wiltcrk****",
    "FirstName": "Alice",
    "CreateTime": "2021-10-26T03:03:42Z",
    "ProvisionType": "Manual",
    "DisplayName": "Alice",
    "UpdateTime": "2021-10-26T03:03:42Z",
    "LastName": "Lee",
    "Tags": [
      {
        "Value": "",
        "Key": ""
      }
    ]
  },
  "RequestId": "F6F90F3D-4502-5877-B80B-97476F6AE2CC"
}

エラーコード

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

変更履歴

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