UpdateWorkspaceUsersRole でのワークスペースメンバーロール一括更新 - Quick BI

ワークスペースメンバーのロール情報を一括で更新します。既存のロールは上書きされます。

今すぐお試しください

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

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
WorkspaceId	string	必須	ワークスペース ID。	95296e95-ca89-4c7d-8af9-dedf0ad0****
UserIds	string	必須	ユーザー ID。これは Alibaba Cloud の UID ではなく、Quick BI の UserID です。バッチパラメーターをサポートしており、複数のユーザー ID はコンマ (,) で区切ります。	136516262323**,124498444445**
RoleId	integer	必須	プリセットされたスペースロール ID。既存のロールは上書きされます。有効値： 25：スペース管理者 26：スペース開発者 27：スペースアナリスト 30：スペース閲覧者	25

レスポンスフィールド

フィールド	型	説明	例
	object
Success	boolean	リクエストが成功したかどうかを示します。有効値： true：リクエストは成功しました。一部のメンバーは正常に更新されましたが、他のメンバーは失敗した可能性があります。失敗の理由については、応答の FailureDetail をご参照ください。 false：リクエストは失敗しました。データは永続化されません。	true
RequestId	string	リクエスト ID。	7AAB95D7-2E11-4FE2-94BC-858E4FC0C976
Result	object	インターフェイス実行の結果を返します。
Failure	integer	更新に失敗したユーザー数。	0
FailureDetail	object	更新が失敗した理由。
Success	integer	正常に更新されたユーザー数。	2
Total	integer	ユーザーの総数を変更します。	2

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "7AAB95D7-2E11-4FE2-94BC-858E4FC0C976",
  "Result": {
    "Failure": 0,
    "FailureDetail": {
      "test": "test",
      "test2": 1
    },
    "Success": 2,
    "Total": 2
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.
400	User.RoleType.Valid	The role ID is invalid.
400	Workspace.Not.Exist	The group workspace does not exist.
400	Workspace.Type.Error	The type of group workspace is invalid.
400	Remove.AdminRoleOf.WorkspaceOwner	The owner of the group workspace must be assigned the administrator role.
400	User.NotIn.Workspace	The user is not a member of the group workspace.
400	AnalystUser.NotSupport.AdminOrDevRole	Analyst users do not support granting workspace administrator or developer roles.
400	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.

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

変更履歴

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