メインコンテンツまでスキップ

メンバーの役割を設定する

CelerData Cloud BYOC アカウントのメンバーに役割を設定します。

注意

  • アカウントの作成者の役割を変更することはできません。
  • この操作にはメンバー管理権限が必要です。

リクエスト​

基本情報
HTTP URLhttps://cloud-api.celerdata.com/api/1.0/users/:user_id/modify-roles
HTTP メソッドPOST
頻度600/分

パス変数​

パラメーター例必須タイプ説明
user_id9d71aae6-a35d-40d5-b213-27bb1f583be5はいStringメンバーのIDです。

リクエストボディ​

パラメーター例必須タイプ説明
role_ids["12345678-1234-1234-1234-123456789012"]はいArray指定されたメンバーに設定したい役割のIDの配列です。役割IDはAPI role-list を使用して取得できます。システム定義の役割 Public はすべてのメンバーに必ず割り当てられます。

ヘッダーパラメーター​

パラメーター例必須タイプ説明
AuthorizationBearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUYはいStringCelerData Cloud API にアクセスするためのアクセストークンです。フォーマット: Bearer <access_token>。

アクセストークンを取得する を参照してください。

レスポンス​

サンプルレスポンス​

{
    "code": 20000,
    "data": {
        "succeed": true
    }
}

レスポンス要素​

パラメーター例タイプ説明
code20000Integerエラーコードです。返されたエラーコードが 20000 の場合、リクエストは成功しました。他のエラーコードが返された場合、リクエストは失敗しました。
data-ObjectAPI 呼び出しの結果です。
data.succeedtrueBoolean役割変更操作が成功したかどうかです。有効な値:
  • true: 操作は成功しました。
  • false: 操作は失敗しました。
data.err_msg-String役割変更操作のエラーメッセージです。この要素は data.succeed が false の場合にのみ返されます。
message-Stringエラーメッセージです。この要素は返された code が 20000 でない場合にのみ返されます。
注意
リクエストが成功したか失敗したかを message の返り値に基づいて判断しないでください。