すべてのプロダクト
Search
ドキュメントセンター

:AddUser

最終更新日:Sep 09, 2026

組織のメンバーを追加します。

今すぐお試しください

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

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

AdminUser deprecated

boolean

任意

組織の管理者ロールを割り当てるかどうかを指定します。有効な値:

  • true: はい。

  • false: いいえ。

重要 このパラメーターは非推奨です。RoleIds が指定されている場合、このパラメーターに効果はありません。

true

AuthAdminUser deprecated

boolean

任意

組織の権限管理の管理者ロールを割り当てるかどうかを指定します。有効な値:

  • true: はい。

  • false: いいえ。

重要 このパラメーターは期限切れであり、推奨されなくなりました。RoleIds が指定されている場合、このパラメーターに効果はありません。

true

UserType

integer

必須

組織メンバーのユーザータイプ。有効な値:

  • 1: 開発者。

  • 2: ビジター。

  • 3: アナリスト。

列挙値:

  • 1 :

    開発者。

  • 2 :

    ビジター。

  • 3 :

    アナリスト。

1

AccountId

string

任意

Alibaba Cloud アカウント ID。 <警告>2024 年 12 月 31 日以降にリリースされた Quick BI バージョンでは、AccountId は必須パラメーターです。この日付より前に API 呼び出しを更新してください。</警告>

191476xxxxx23754

AccountName deprecated

string

任意

Alibaba Cloud アカウント名。

  • 注意: RAM ユーザーの場合、フォーマットは「プライマリアカウント:RAM ユーザー」です。例: master_test@aliyun.com:subaccount

  • フォーマットチェック: 最大値は 50 文字です。

xxxxxx@163.com

NickName

string

必須

Alibaba Cloud アカウントのニックネーム。

  • フォーマットチェック: 最大値は 50 文字です。

  • 特殊文字の検証: 漢字、英字、数字、_ \ / | () ] [

John

RoleIds

string

任意

ユーザーにアタッチするプリセットまたはカスタムの組織ロールの ID。カンマ (,) で区切ります。サポートされるロール ID の最大値は 3 です。有効な値:

  • 組織の管理者 (プリセットロール): 111111111

  • 権限管理の管理者 (プリセットロール): 111111112

  • 一般ユーザー (プリセットロール): 111111113

111111111,456

CopilotModules

string

任意

ユーザーのインテリジェントモジュールのクォータ。複数のモジュールはカンマ (,) で区切ります。

  • qreport -- Small Q レポート

  • qExploreNum -- Small Q Explorer

  • smartQAskNum -- Small Q Ask

  • smartQDevNum -- Small Q Builder

qレポート,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 アカウントのニックネーム。

John

RoleIdList

array

ユーザーにバインドされている組織ロール ID のリスト。

integer

組織ロールの ID。サポートされるロール ID の最大値は 3 であり、以下のプリセットロールが含まれますが、これらに限定されません:

  • 組織の管理者 (プリセットロール): 111111111

  • 権限管理の管理者 (プリセットロール): 111111112

  • 一般ユーザー (プリセットロール): 111111113

111111111

CopilotModules

array

ユーザーが所有するインテリジェントモジュールのクォータ。

string

ユーザーが所有するインテリジェントモジュールのクォータ。

qレポート

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 組織の開発者数が上限 %s に達しました。開発者のクォータを増やすには、組織の管理者にお問い合わせください。
400 Organization.Viewers.ReachedTheUpperLimit The visitors of the organization have reached the upper limit:%s. 組織の視聴者数が上限 %s に達しました。視聴者のクォータを増やすには、組織の管理者にお問い合わせください。
400 Organization.Analysts.ReachedTheUpperLimit The analysts of the organization have reached the upper limit:%s. 組織のアナリスト数が上限 %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. 組織のゲストタイプのユーザーをワークスペースに追加することはできません: %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. ユーザー %s には組織内で少なくとも 1 つのロールが必要です。
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. ユーザーロールの数は 3 を超えることはできません。
400 BindRole.NotExist.Error Bind role not exist, %s. バインドされたロールが存在しません。%s。
400 DirtyData.Duplicate.User Dirty data,duplicate user: %s. ダーティデータです。重複するユーザー: %s。
400 Robot.Module.Exhausted The Quota of %s module has been exhausted. %s モジュールのクォータが使い果たされました。

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

変更履歴

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