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

ユーザー管理 API

最終更新 2026/10/03

呼び出し方法は、Open APIドキュメントの呼び出し方法の説明を参照してください。

1. ユーザー管理​

1. ユーザーIDのクエリ​

注意

会社レベルのtokenのみ対応しています

インターフェースURL

/open/list-auth-users-by-login-names?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー

リクエストBodyパラメータ

{
    "loginNames": [
        "test_user1",
        "test_user2"
    ]
}
パラメータ名サンプル値パラメータタイプ必須パラメータの説明
loginNames["test_user1"]Listはいログインユーザー名のリスト

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success",
    "data": {
        "authUsers": [
            {
                "userId": 88,
                "loginName": "test_user1"
            },
            {
                "userId": 89,
                "loginName": "test_user2"
            }
        ]
    }
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ
data-Object検証結果照会用のkey
data.authUsers-Listユーザーリスト
data.authUsers.userId88IntegerユーザーID
data.authUsers.loginNametest_user1Stringユーザー名

2. ロールを含む単一ユーザー情報のクエリ​

注意
  • ユーザーがルートアカウントの場合はcompanyRoleを返し、ルートアカウントでない場合はprojectRolesを返します
  • 会社レベルのtokenのみ対応しています

インターフェースURL

/open/get-auth-user-info-by-login-name?token=xxx&loginName= test_user1

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
loginNametest_user1Stringはいログイン名

成功レスポンスの例

ユーザーがルートアカウントの場合はcompanyRoleを返します：

{
  "return_code": 0,
  "return_message": "success",
  "data": {
    "userId": 88,
    "loginName": "test_user1",
    "userName": "テストユーザーA",
    "roleInfo": {
      "companyRole": {
        "roleName": "root",
        "roleDesc": "ルートアカウント"
      }
    }
  }
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.loginNametest_user1Stringログイン名
data.roleInfo-Objectロール情報
data.roleInfo.companyRole-List会社ロールのリスト
data.roleInfo.companyRole.roleNamerootStringロール名
data.roleInfo.companyRole.roleDescルートアカウントStringロールの説明
data.userId88IntegerユーザーID
data.userNameテストユーザーAStringユーザー名
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

ユーザーがルートアカウントでない場合はprojectRolesを返します：

{
  "return_code": 0,
  "return_message": "success",
  "data": {
    "userId": 88,
    "loginName": "test_user1",
    "userName": "テストユーザーA",
    "roleInfo": {
      "projectRoles": [
        {
          "projectId": 3,
          "roleName": "admin",
          "roleDesc": "管理者"
        },
        {
          "projectId": 4,
          "roleName": "analyst",
          "roleDesc": "アナリスト"
        }
      ]
    }
  }
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.loginNametest_user1Stringログイン名
data.roleInfo-Objectロール情報
data.roleInfo.projectRoles-Listプロジェクトロールのリスト
data.roleInfo.projectRoles.projectId3IntegerプロジェクトID
data.roleInfo.projectRoles.roleDesc管理者Stringロールの説明
data.roleInfo.projectRoles.roleNameadminStringロール名
data.userId88IntegerユーザーID
data.userNameテストユーザーAStringユーザー名
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "Find no user with loginName: test007"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageFind no user with loginName: test007Stringリターンメッセージ

3. ユーザーアカウントのステータスのクエリ​

注意
  • ユーザーのログイン名でユーザーアカウントのステータスをクエリします

インターフェースURL

/open/get-auth-user-status?token=xxx&loginName=user007

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
loginNameuser007Stringはいログイン名

成功レスポンスの例

{
    "data": {
        "accountStatus": "NORMAL",
        "loginName": "user007"
    },
    "return_code": 0,
    "return_message": "success"
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.accountStatusNORMALString

アカウントステータス

  • INVALID：無効
  • NORMAL：正常
  • LOCK：ロック中
data.loginNameuser007Stringログイン名
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータ(token)が空です"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageパラメータ(token)が空ですStringリターンメッセージ

4. ユーザーの凍結​

注意
  • ユーザーのログイン名でユーザーを凍結します

インターフェースURL

/open/member-lock?token=xxx&loginName=user007

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
loginNameuser007Stringはいログイン名

成功レスポンスの例

{
    "data": true,
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
datatrueObjectレスポンスデータ
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1006,
    "return_message": "操作する権限がありません。token値が正しいか確認してください"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1006Integerリターンコード
return_message操作する権限がありません。token値が正しいか確認してくださいStringリターンメッセージ

5. ユーザーの凍結解除​

注意
  • ユーザーのログイン名でユーザーの凍結を解除します

インターフェースURL

/open/member-unlock?token=xxx&loginName=user007

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
loginNameuser007Stringはいログイン名

成功レスポンスの例

{
    "data": true,
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
datatrueObjectレスポンスデータ
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1006,
    "return_message": "操作する権限がありません。token値が正しいか確認してください"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1006Integerリターンコード
return_message操作する権限がありません。token値が正しいか確認してくださいStringリターンメッセージ

6. ユーザーのMFA連携の解除​

注意

会社レベルのtokenのみ対応しています

インターフェースURL

/open/unbind-auth-user-mfa?token=xxx&loginName=root

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
loginNamerootStringはいログイン名

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1009,
    "return_message": "ユーザー名が存在しません"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1009Integerリターンコード
return_messageユーザー名が存在しませんStringリターンメッセージ

7. ユーザーロールの一括作成​

注意

  • このAPIは次の機能を実行します：

    1. ユーザーアカウントを作成します。初期パスワードは"ta2020"です。ユーザーアカウントがすでに存在する場合は、ユーザーアカウントの作成をスキップします；
    2. 各プロジェクトにおけるユーザーアカウントのロールを設定します。ロールはプロジェクト内で定義済みである必要があります。

  • 会社レベルのtokenのみ対応しています

注意

以前のバージョンでは、「アナリスト管理者」ロールを作成する際に渡すロール名は「管理者」でした

上記の制限はv5.0のロール最適化以降に解除されました。プロジェクト内のアナリティクスロール名をそのまま渡してください

名前は変更できるため、AEシステムの「システム管理」/「プロジェクト管理」内の<ロール管理>ページで必要なロール名を確認してください

インターフェースURL

/open/batch-create-auth-user-and-set-roles?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー

リクエストBodyパラメータ

{
    "authUsers": [{
        "loginName": "test_user1",
        "roles": [{
            "projectId": 57,
            "roleDesc": "データアナリストA"
        }, {
            "projectId": 0,
            "roleDesc": "ロールテストA"
        }]
    }, {
        "loginName": "test_user2",
        "roles": [{
            "projectId": 390,
            "roleDesc": "テスト2"
        }, {
            "projectId": 377,
            "roleDesc": "メンバー"
                }]
        }]
}
$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
authUsers-Listはいユーザー情報エンティティ
authUsers.loginNametest_user1Stringはいユーザーのログインアカウント名
authUsers.roles-Listはいロールのリスト
authUsers.roles.projectId390IntegerいいえプロジェクトID
authUsers.roles.roleDescテスト2Stringはいアナリティクスロールの表示名。現在、APIによるエンゲージロールの設定には対応していません

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1006,
    "return_message": "This API is Forbidden in SAAS"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1006Integerリターンコード
return_messageThis API is Forbidden in SAASStringリターンメッセージ

9. SSOユーザーの作成​

注意
  • ssoユーザー情報の作成に使用します

インターフェースURL

/open/create/ssoUser?token=xxx&loginType=dingtalk&loginName=user007

リクエストメソッド

GET

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
loginTypedingtalkStringはいサードパーティログインタイプ
loginNameuser007Stringはいログイン名
password-Stringいいえログインパスワード（省略した場合はシステムが自動生成します）

成功レスポンスの例

{
    "data": true,
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
datatrueObjectレスポンスデータ
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1006,
    "return_message": "操作する権限がありません。token値が正しいか確認してください"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1006Integerリターンコード
return_message操作する権限がありません。token値が正しいか確認してくださいStringリターンメッセージ

10. プロジェクトからユーザーを削除（作業の譲渡を選択可能）​

インターフェースURL

/open/delete-auth-user-from-project?token=xxx&projectId=0&loginName=user007&handoverToLoginName=user008

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID
loginNameuser007Stringはい削除するユーザーのログイン名
handoverToLoginNameuser008Stringはい譲渡先にできるユーザーのログイン名

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1023,
    "return_message": "user user007が存在しません"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1023Integerリターンコード
return_messageuser user007が存在しませんStringリターンメッセージ

11. システムからユーザーを削除（作業の譲渡を選択可能）​

注意

会社レベルのtokenのみ対応しています

インターフェースURL

/open/delete-auth-user-from-system?token=xxx&loginName=user007&handoverToLoginName=user008

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
loginNameuser007Integerはいログイン名
handoverToLoginNameuser008Stringはい譲渡先ユーザーのログイン名

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1010,
    "return_message": "Unsupported in SAAS"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1010Integerリターンコード
return_messageUnsupported in SAASStringリターンメッセージ

2. ユーザーグループ管理​

1. ユーザーグループIDとメンバーリストのクエリ​

インターフェースURL

/open/get-user-group-by-name?token=xxx&projectId=0&userGroupName=demo007

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID
userGroupNamedemo007Stringはいユーザーグループ名

成功レスポンスの例

{
    "data": {
        "groupName": "demo007",
        "id": 133,
        "isDefault": false,
        "members": [
            {
                "userId": 16426
            }
        ],
        "updateTime": "2021-11-22 19:22:15"
    },
    "return_code": 0,
    "return_message": "success"
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.groupNamedemo007Stringグループ名
data.id133Integerid
data.isDefaultfalseBooleanデフォルトかどうか
data.members-Listメンバーリスト
data.members.userId16426IntegerユーザーID
data.updateTime2021-11-22 19:22:15Date更新日時
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1023,
    "return_message": "ユーザーグループが存在しません"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1023Integerリターンコード
return_messageユーザーグループが存在しませんStringリターンメッセージ

2. ユーザーグループの作成​

インターフェースURL

/open/create-user-group?token=xxx&projectId=2

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId2IntegerはいプロジェクトID

リクエストBodyパラメータ

{
    "groupName": "demo007",
    "isDefault": false,
    "members": [
        {
            "userId": 16426,
            "userName": "user007"
        }
    ]
}
$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
groupNamedemo007Stringはいグループ名。最大64文字
isDefaultfalseBooleanいいえ新規ユーザーをデフォルトでグループに追加するかどうか
members-Listいいえメンバーリスト
members.userId16426IntegerいいえメンバーのユーザーID
members.userNameuser007Stringいいえメンバーのユーザー氏名

成功レスポンスの例

{
    "data": {
        "id": 135
    },
    "return_code": 0,
    "return_message": "success"
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.id135Integerid
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1015,
    "return_message": "既に存在します"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1015Integerリターンコード
return_message既に存在しますStringリターンメッセージ

3. ユーザーグループのメンバーリストの更新​

ユーザーグループ名の追加・更新、グループメンバー情報の追加・更新に使用できます

注意

送信したメンバーリストで、元のメンバーリスト全体が置き換えられます

インターフェースURL

/open/update-user-group?token=xxx&projectId=0

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID

リクエストBodyパラメータ

{
  "id": 99,
  "groupName": "testGroup",
  "isDefault": false,
  "members": [
    {
      "userId": 88,
      "userName": "test88"
    },
    {
      "userId": 100,
      "userName": "test100"
    }
  ]
}
$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
id99Integerはいユーザーグループid
groupNametestGroupStringいいえユーザーグループ名。最大64文字
isDefaultfalseBooleanいいえプロジェクトの新規ユーザーをデフォルトでこのグループに追加
members-Listいいえユーザーグループのメンバー
members.userId88StringいいえメンバーのユーザーID
members.userNametest88Stringいいえメンバーのユーザー名

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1023,
    "return_message": "ユーザーグループが存在しません"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1023Integerリターンコード
return_messageユーザーグループが存在しませんStringリターンメッセージ

5. ユーザーグループの削除​

インターフェースURL

/open/delete-user-group?token=xxx&projectId=0&groupId=1

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID
groupId1StringはいグループID

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1023,
    "return_message": "ユーザーグループが存在しません"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1023Integerリターンコード
return_messageユーザーグループが存在しませんStringリターンメッセージ

3. プロジェクトロール管理​

1. プロジェクトロールの詳細の取得​

インターフェースURL

/open/get-project-role-by-role-desc?token=xxx&projectId=2&roleDesc=アナリスト007

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId2IntegerはいプロジェクトID
roleDescアナリスト007Stringはいロールの説明

成功レスポンスの例

{
    "data": {
        "projectId": 2,
        "roleDesc": "アナリスト007",
        "roleName": "analyst_1462717171385241600",
        "funcList": [
            {
                "functionClass": "コホート設定",
                "functionDesc": "条件コホート、結果コホート、IDコホートのリストを確認",
                "functionId": 14,
                "functionName": "viewCluster",
                "functionType": "確認"
            },
            {
                "functionId": 34,
                "functionClass": "ダッシュボードの使用",
                "functionDesc": "ダッシュボードとダッシュボード設定を確認",
                "functionName": "viewDashbord",
                "functionType": "確認"
            },
            {
                "functionId": 35,
                "preFunctionId": 34,
                "functionClass": "ダッシュボードの使用",
                "functionDesc": "ダッシュボードのフィルター条件の一時的な調整、全体フィルターの使用",
                "functionName": "useDashbordFilter",
                "functionType": "確認"
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.projectId2IntegerプロジェクトID
data.roleDescアナリスト007Stringロールの説明
data.roleNameanalyst_1462717171385241600Stringロール名
data.funcList-List機能リスト
data.funcList.functionClassダッシュボードの使用String機能分類
data.funcList.functionDescダッシュボードのフィルター条件の一時的な調整、全体フィルターの使用String機能の説明
data.funcList.functionId35Integer機能ID
data.funcList.functionNameuseDashbordFilterString機能名
data.funcList.functionType確認String機能タイプ
data.funcList.preFunctionId34Integer依存機能ID
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1023,
    "return_message": "role testが存在しません"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1023Integerリターンコード
return_messagerole testが存在しませんStringリターンメッセージ

2. （廃止）基本ロールの機能リストの取得​

注意

AE 5.0でロール権限管理機能がアップグレードされたため、baseRoleに基づいてカスタムロールを作成する必要はなくなりました

「すべての機能リストの取得」APIで全機能のリストをクエリし、ロールに必要な機能と機能の依存関係に基づいて、カスタムロールを直接作成してください。

3. すべての機能リストの取得​

注意

会社レベルのtokenのみ対応しています

インターフェースURL

/open/get-all-functions?token=xxx

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー

成功レスポンスの例

{
    "data": [
                {
                    "functionId":6,
                    "functionName":"viewProjectInfo",
                    "functionDesc":"プロジェクト構成情報を確認",
                    "functionType":"確認",
                    "functionClass":"プロジェクト構成"
                },
                {
                    "functionId":8,
                    "functionName":"configProjectParm",
                    "functionDesc":"プロジェクト構成情報を編集",
                    "functionType":"編集",
                    "functionClass":"プロジェクト構成",
                    "preFunctionId":6
                },
                {
                    "functionId":14,
                    "functionName":"viewCluster",
                    "functionDesc":"コホートリストを確認",
                    "functionType":"確認",
                    "functionClass":"コホート管理"
                }
],
    "return_code": 0,
    "return_message": "success"
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.functionId8Integer機能ID
data.functionNameconfigProjectParmString機能名
data.functionDescプロジェクト構成情報を編集String機能の説明
data.functionType編集String機能カテゴリ
data.functionClassプロジェクト構成String機能モジュール
data.preFunctionId6Interger依存機能ID
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータ(token)が空です"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageパラメータ(token)が空ですStringリターンメッセージ

3. プロジェクトロールの新規作成​

注意

プロジェクトロールを新規作成して権限を割り当てます。先に「すべての機能リストの取得」APIで必要な機能権限をクエリし、その中の権限IDに基づいてこのAPIを呼び出すことをお勧めします

インターフェースURL

/open/create-project-role?token=xxx&projectId=2

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId2IntegerはいプロジェクトID

リクエストBodyパラメータ

{
    "roleDesc": "アナリスト007",
    "roleFuncList": [
        14,34,53
    ]
}
パラメータ名サンプル値パラメータタイプ必須パラメータの説明
roleDescアナリスト007Stringはいロールの説明。最大60文字
roleFuncList[14]Listはいロールの機能IDリスト。有効なIDである必要があります

成功レスポンスの例

{
    "data": {
        "roleName": "analyst_1462717171385241600"
    },
    "return_code": 0,
    "return_message": "success"
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.roleNameanalyst_1462717171385241600Stringロール名
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -3004,
    "return_message": "無効なプロジェクト"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-3004Integerリターンコード
return_message無効なプロジェクトStringリターンメッセージ

4. プロジェクトロールの変更​

インターフェースURL

/open/update-project-role?token=xxx&projectId=2&roleName=admin

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId2IntegerはいプロジェクトID
roleNameadminStringはいロール名

リクエストBodyパラメータ

{
    "roleDesc": "アナリスト009",
    "roleFuncList": [
        14,34,53
    ]
}
パラメータ名サンプル値パラメータタイプ必須パラメータの説明
roleDescアナリスト009Stringいいえロールの説明
roleFuncList[14]Listいいえロールの機能IDリスト

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -3004,
    "return_message": "無効なプロジェクト"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-3004Integerリターンコード
return_message無効なプロジェクトStringリターンメッセージ

5. プロジェクトロールの削除​

注意

AE 5.0でカスタム機能権限がアップグレードされたため、古いロールを削除する際は代わりとなる新しいロールを指定し、古いロールのアカウントが引き続き正常に使用できるようにする必要があります。

インターフェースURL

/open/delete-project-role?token=xxx&projectId=0&roleName=role_1&newRoleName=role_2

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID
roleNamerole_1Stringはいロール名
newRoleNamerole_2Stringはい新しいロール名を指定

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1023,
    "return_message": "role 'role_1' が存在しません"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1023Integerリターンコード
return_messagerole 'test' が存在しませんStringリターンメッセージ

4. ダッシュボード共有のブラックリスト​

使用シーン：ダッシュボード共有を設定する際、すべてのメンバーに表示されるよう共有した場合に、ブラックリストを使って特定のユーザーを除外できます

1. ブラックリストへの追加​

注意

会社レベルのtokenのみ対応しています

インターフェースURL

/open/share/add-black?token=xxx&loginName=root&blackProjectId=0

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
loginNamerootStringはいログイン名
blackProjectId0Integerはい

ブラックリストのプロジェクトID

0：すべてのプロジェクトで共有するブラックリスト

プロジェクトID：そのプロジェクトのみのブラックリスト

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ
dataObject戻り値

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータ(token)が空です"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageパラメータ(token)が空ですStringリターンメッセージ

2. ブラックリストへの一括追加(csv)​

注意

会社レベルのtokenのみ対応しています

インターフェースURL

/open/share/add-black-list?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー

ファイルのテンプレートは次のとおりです：

loginName,blackProjectId
demo@thinkingdata,-1
user1,298

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータ(token)が空です"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageパラメータ(token)が空ですStringリターンメッセージ

3. ブラックリストグループの設定​

注意
  • 会社レベルのtokenのみ対応しています
  • グループをブラックリストグループに設定すると、グループの全メンバーがブラックリストに追加されます

インターフェースURL

/open/share/add-black-group-list?token=xxx&groupIdList=[1]&groupType=1

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
groupIdList[1]ListはいグループIDのリスト
groupType1Integerはい1：ブラックリストグループ

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータ(token)が空です"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageパラメータ(token)が空ですStringリターンメッセージ

4. ブラックリストからの削除​

注意
  • 会社レベルのtokenのみ対応しています
  • 特定のユーザーを特定のプロジェクトのブラックリストから削除することも、すべてのブラックリストから削除することもできます

インターフェースURL

/open/share/cancel-black?token=xxx&loginName=root&blackProjectId=0

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
loginNamerootStringはいログイン名
blackProjectId0IntegerいいえブラックリストのプロジェクトID

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータ(token)が空です"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageパラメータ(token)が空ですStringリターンメッセージ

5. ブラックリストのダウンロード​

注意
  • 会社レベルのtokenのみ対応しています

インターフェースURL

/open/share/download-share-black?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー

成功レスポンスの例

csvファイル。サンプルのスクリーンショットは次のとおりです

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "パラメータ(token)が空です"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageパラメータ(token)が空ですStringリターンメッセージ
このページは役に立ちましたか？
このページの内容