AddUser - - Alibaba Cloud ドキュメントセンター

組織メンバーの追加

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

quickbi-public:AddUser

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AdminUser `deprecated`	boolean	任意	組織管理者ロールを割り当てるかどうかを指定します。有効な値は次のとおりです： true false 重要このパラメーターは非推奨です。 `RoleIds` が指定されている場合、このパラメーターは無視されます。	true
AuthAdminUser `deprecated`	boolean	任意	権限管理者ロールを割り当てるかどうかを指定します。有効な値は次のとおりです： true false 重要このパラメーターは非推奨です。 `RoleIds` が指定されている場合、このパラメーターは無視されます。	true
UserType	integer	必須	組織メンバーのタイプを指定します。有効な値は次のとおりです： 1：開発者 2：閲覧者 3：アナリスト	1
AccountId	string	任意	Alibaba Cloud アカウントの ID です。警告 `AccountId` パラメーターは、2024 年 12 月 31 日以降にリリースされる Quick BI バージョンで必須になります。それまでにこのパラメーターを含むように API 呼び出しを更新することを推奨します。	191476xxxxx23754
AccountName `deprecated`	string	任意	Alibaba Cloud アカウント名です。サブアカウントの場合、 `マスターアカウント：サブアカウント` のフォーマットを使用します。例： `master_test@aliyun.com:subaccount`。最大長は 50 文字です。	xxxxxx@163.com
NickName	string	必須	ユーザーのニックネームです。最大長は 50 文字です。ニックネームには、日本語の文字、英字、数字、および次の特殊文字を含めることができます： `_ \ / \| () []`。	张三
RoleIds	string	任意	割り当てる事前定義ロールまたはカスタム組織ロールの ID を指定します。カンマ (,) で区切って最大 3 つのロール ID を指定できます。事前定義ロールの有効な値： `111111111`：組織管理者 `111111112`：権限管理者 `111111113`：一般ユーザー	111111111,456
CopilotModules	string	任意	ユーザーに対して有効にする Copilot モジュールを指定します。複数のモジュールを有効にするには、コードをカンマ (,) で区切って指定します。 `qreport`：Q レポート `qExploreNum`：Q エクスプロア `smartQAskNum`：データとの Q&A `smartQDevNum`：Q による構築支援	qreport,qExploreNum

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	新しく追加された Alibaba Cloud ユーザーの詳細。
AccountName	string	Alibaba Cloud アカウント。	xxxxxx@163.com
AdminUser	boolean	組織管理者ロールが割り当てられているかどうかを示します。有効な値： true false 重要このパラメーターは非推奨です。 RoleIdList が指定されている場合、このパラメーターは有効になりません。	true
AuthAdminUser	boolean	権限管理者ロールが割り当てられているかどうかを示します。有効な値： true false 重要このパラメーターは非推奨です。 RoleIdList が指定されている場合、このパラメーターは有効になりません。	true
NickName	string	Alibaba Cloud アカウントのニックネーム。	张三
RoleIdList	array	ユーザーに割り当てられた組織ロール ID のリスト。
	integer	組織ロールの ID。最大 3 つのロールを割り当てることができます。定義済みロールは以下のとおりです。組織管理者 (定義済みロール)：111111111 権限管理者 (定義済みロール)：111111112 標準ユーザー (定義済みロール)：111111113	111111111
CopilotModules	array	ユーザーにクォータが割り当てられている Copilot モジュールのリスト。
	string	ユーザーにクォータが割り当てられている Copilot モジュール。	qreport
UserId	string	Quick BI のユーザー ID。	b5d8fd9348cc4327****afb604
UserType	integer	ユーザータイプ。有効な値： 1：開発者 2：閲覧者 3：アナリスト	1
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true false	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "AccountName": "xxxxxx@163.com",
    "AdminUser": true,
    "AuthAdminUser": true,
    "NickName": "张三",
    "RoleIdList": [
      111111111
    ],
    "CopilotModules": [
      "qreport"
    ],
    "UserId": "b5d8fd9348cc4327****afb604",
    "UserType": 1
  },
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Organization.Developers.ReachedTheUpperLimit	The developers of the organization have reached the upper limit:%s
400	Organization.Viewers.ReachedTheUpperLimit	The visitors of the organization have reached the upper limit:%s.
400	Organization.Analysts.ReachedTheUpperLimit	The analysts of the organization have reached the upper limit:%s.
400	NickName.AlreadyIn.Organization	The alias already exists.	ユーザーは組織のメンバーではありません。
400	User.AlreadyIn.Organization	This user is already a member of the current organization.	エイリアスは既に存在します。
400	Instance.Over.MaxLicense	You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.
400	AnalystUser.NotSupport.AdminOrDevRole	Analyst users do not support granting workspace administrator or developer roles.
400	Workspace.Not.Exist	The group workspace does not exist.	指定されたワークスペースは存在しません。
400	Workspace.Type.Error	The type of group workspace is invalid.	指定されたワークスペースタイプは無効です。
400	Viewer.AddInTo.Workspace	Organization members with viewer type are not allowed to add to workspace: %s.
400	User.AlreadyIn.Workspace	This user already exists.	このユーザーは既にこのワークスペースに参加しています。
400	User.AlreadyIn.Role	The user is already assigned this role.	このユーザーには既にこのロールがあります。
400	User.OrganizationRole.NotExist	User %s must have role in organization.
400	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.
400	RoleCount.ExceedsLimit.Error	The user role cannot exceed three.
400	BindRole.NotExist.Error	Bind role not exist, %s.
400	DirtyData.Duplicate.User	Dirty data,duplicate user: %s.
400	Robot.Module.Exhausted	The Quota of %s module has been exhausted.

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

変更履歴

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