ユーザー管理 API
呼び出し方法は、Open APIドキュメントの呼び出し方法の説明を参照してください。
1. ユーザー管理
1. ユーザーIDのクエリ
会社レベルのtokenのみ対応しています
インターフェースURL
/open/list-auth-users-by-login-names?token=xxx
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
リクエスト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_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
| data | - | Object | 検証結果照会用のkey |
| data.authUsers | - | List | ユーザーリスト |
| data.authUsers.userId | 88 | Integer | ユーザーID |
| data.authUsers.loginName | test_user1 | String | ユーザー名 |
2. ロールを含む単一ユーザー情報のクエリ
- ユーザーがルートアカウントの場合はcompanyRoleを返し、ルートアカウントでない場合はprojectRolesを返します
- 会社レベルのtokenのみ対応しています
インターフェースURL
/open/get-auth-user-info-by-login-name?token=xxx&loginName= test_user1
リクエストメソッド
GET
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| loginName | test_user1 | String | はい | ログイン名 |
成功レスポンスの例
ユーザーがルートアカウントの場合はcompanyRoleを返します:
{
"return_code": 0,
"return_message": "success",
"data": {
"userId": 88,
"loginName": "test_user1",
"userName": "テストユーザーA",
"roleInfo": {
"companyRole": {
"roleName": "root",
"roleDesc": "ルートアカウント"
}
}
}
}
| $$パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| data | - | Object | レスポンスデータ |
| data.loginName | test_user1 | String | ログイン名 |
| data.roleInfo | - | Object | ロール情報 |
| data.roleInfo.companyRole | - | List | 会社ロールのリスト |
| data.roleInfo.companyRole.roleName | root | String | ロール名 |
| data.roleInfo.companyRole.roleDesc | ルートアカウント | String | ロールの説明 |
| data.userId | 88 | Integer | ユーザーID |
| data.userName | テストユーザーA | String | ユーザー名 |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
ユーザーがルートアカウントでない場合は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.loginName | test_user1 | String | ログイン名 |
| data.roleInfo | - | Object | ロール情報 |
| data.roleInfo.projectRoles | - | List | プロジェクトロールのリスト |
| data.roleInfo.projectRoles.projectId | 3 | Integer | プロジェクトID |
| data.roleInfo.projectRoles.roleDesc | 管理者 | String | ロールの説明 |
| data.roleInfo.projectRoles.roleName | admin | String | ロール名 |
| data.userId | 88 | Integer | ユーザーID |
| data.userName | テストユーザーA | String | ユーザー名 |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1008,
"return_message": "Find no user with loginName: test007"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1008 | Integer | リターンコード |
| return_message | Find no user with loginName: test007 | String | リターンメッセージ |
3. ユーザーアカウントのステータスのクエリ
- ユーザーのログイン名でユーザーアカウントのステータスをクエリします
インターフェースURL
/open/get-auth-user-status?token=xxx&loginName=user007
リクエストメソッド
GET
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| loginName | user007 | String | はい | ログイン名 |
成功レスポンスの例
{
"data": {
"accountStatus": "NORMAL",
"loginName": "user007"
},
"return_code": 0,
"return_message": "success"
}
| $$パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| data | - | Object | レスポンスデータ |
| data.accountStatus | NORMAL | String | アカウントステータス
|
| data.loginName | user007 | String | ログイン名 |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1008,
"return_message": "パラメータ(token)が空です"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1008 | Integer | リターンコード |
| return_message | パラメータ(token)が空です | String | リターンメッセージ |
4. ユーザーの凍結
- ユーザーのログイン名でユーザーを凍結します
インターフェースURL
/open/member-lock?token=xxx&loginName=user007
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| loginName | user007 | String | はい | ログイン名 |
成功レスポンスの例
{
"data": true,
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| data | true | Object | レスポンスデータ |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1006,
"return_message": "操作する権限がありません。token値が正しいか確認してください"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1006 | Integer | リターンコード |
| return_message | 操作する権限がありません。token値が正しいか確認してください | String | リターンメッセージ |
5. ユーザーの凍結解除
- ユーザーのログイン名でユーザーの凍結を解除します
インターフェースURL
/open/member-unlock?token=xxx&loginName=user007
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| loginName | user007 | String | はい | ログイン名 |
成功レスポンスの例
{
"data": true,
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| data | true | Object | レスポンスデータ |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1006,
"return_message": "操作する権限がありません。token値が正しいか確認してください"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1006 | Integer | リターンコード |
| return_message | 操作する権限がありません。token値が正しいか確認してください | String | リターンメッセージ |
6. ユーザーのMFA連携の解除
会社レベルのtokenのみ対応しています
インターフェースURL
/open/unbind-auth-user-mfa?token=xxx&loginName=root
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| loginName | root | String | はい | ログイン名 |
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1009,
"return_message": "ユーザー名が存在しません"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1009 | Integer | リターンコード |
| return_message | ユーザー名が存在しません | String | リターンメッセージ |
7. ユーザーロールの一括作成
アカウントを一括作成し、会社内の各プロジェクトの分析ロールを全量設定します。同じリクエストで、各プロジェクトのデータ権限も指定できます。会社トークンのみ使用でき、1回のリクエストで同じ会社の複数プロジェクトを処理できます。プライベート環境向けのAPIで、SaaSには対応していません。
以前のバージョンでは、「アナリスト管理者」ロールを作成する際に渡すロール名は「管理者」でした
上記の制限はv5.0のロール最適化以降に解除されました。プロジェクト内のアナリティクスロール名をそのまま渡してください
ロール名は変更可能です。AEシステムの「システム管理 / プロジェクト管理」の「ロール管理」ページで必要な名称を確認してください。
インターフェースURL
/open/batch-create-auth-user-and-set-roles?token=xxx
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| token | String | はい | 会社トークン。プロジェクトトークン、ユーザートークン、一時トークンは使用できません。 |
リクエストBodyパラメータと例
以下の例では、test_user1にプロジェクト57と390の分析ロールを設定し、一方にカスタムデータ権限、もう一方に全データ権限を付与します。例中のロール名とデータ権限名は、各プロジェクトに存在する名称に置き換えてください。ロールのみを設定する場合はdataPowersを省略できます。
{
"authUsers": [
{
"loginName": "test_user1",
"roles": [
{
"projectId": 57,
"roleDesc": "数据分析师A"
},
{
"projectId": 390,
"roleDesc": "普通成员"
}
],
"dataPowers": [
{
"projectId": 57,
"dataPowerName": "华东地区数据"
},
{
"projectId": 390,
"allData": true
}
]
}
]
}
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| authUsers | Array | はい | 空にできないアカウント一覧。 |
| authUsers[].loginName | String | はい | ユーザーのログインアカウント名。形式はユーザー一括作成APIと同じです。 |
| authUsers[].roles | Array | はい | 今回の対象となる各プロジェクトで、このアカウントに設定する完全な分析ロール一覧。空にできません。同じ会社の複数プロジェクトを含めることができます。 |
| authUsers[].roles[].projectId | Integer | いいえ | プロジェクトID。トークンに対応する会社のプロジェクトである必要があります。明示的な指定を推奨します。省略するとプロジェクトID 0として処理され、プロジェクト0も実在する必要があります。 |
| authUsers[].roles[].roleDesc | String | はい | プロジェクトに定義済みの分析ロールの表示名。内部識別子ではありません。現在、運営ロールの設定には対応していません。名称は変更可能なため、「システム管理 / プロジェクト管理」の「ロール管理」ページで確認してください。 |
| authUsers[].dataPowers | Array | いいえ | このアカウントのデータ権限設定。省略、null、空配列はいずれも既存のデータ権限を維持します。新規アカウントまたは新たにプロジェクトへ参加するアカウントで未指定の場合は、既定の全データ権限を使用します。配列の要素にnullは指定できません。 |
| authUsers[].dataPowers[].projectId | Integer | はい | データ権限のプロジェクトID。実在する0以上の整数で、同じリクエストの当該アカウントのrolesに含まれている必要があります。同じアカウントで同じプロジェクトを重複して設定できません。 |
| authUsers[].dataPowers[].dataPowerName | String | どちらか一方 | プロジェクト内に存在するカスタムデータ権限の元の完全な名称。完全一致する設定が1つだけ存在する必要があります。内部IDは指定できず、あいまい検索や自動作成にも対応していません。全データを意味する名称であっても、カスタム権限として解釈します。名称を指定する場合、allDataは省略するかnullにしてください。 |
| authUsers[].dataPowers[].allData | Boolean | どちらか一方 | 指定できる値はtrueのみで、リクエスト言語に関係なく全データ権限を明示的に付与します。この場合、dataPowerNameは省略するかnullにしてください。false、空白の名称、両方未指定、両方指定はいずれも拒否されます。 |
動作ルール
- アカウントが存在しない場合は初期パスワードta2020で作成します。既存アカウントは再利用し、パスワードはリセットしません。新たにプロジェクトへ参加するアカウントは既定のユーザーグループに追加されます。
- 指定した各プロジェクトの分析ロールを、追加ではなく全量置換します。例えば、既存のロールがAとBで今回Bのみ指定した場合、成功後はBのみ残ります。各対象プロジェクトで維持する完全なロール一覧を渡してください。指定していないプロジェクトは変更しません。
- dataPowersに明示したプロジェクトのデータ権限のみを変更し、指定していないプロジェクトは変更しません。dataPowersの省略、null、空配列はいずれも既存のデータ権限を維持します。新規アカウントまたは新たにプロジェクトへ参加するアカウントで未指定の場合は、既定の全データ権限を使用します。同名のカスタム権限が複数プロジェクトに存在する場合は、それぞれのプロジェクトの設定を使用します。
- カスタムデータ権限名が存在しない、重複している、または別のプロジェクトにのみ存在する場合はバッチ全体が失敗し、全データ権限への置き換えは行いません。権限名を変更しても既存の割り当ては維持されますが、以降のリクエストでは新しい名称を使用してください。データ権限を指定する場合、アカウントは現在の会社に属している必要があります。
- このAPIでスーパー管理者権限を付与することはできません。既存のスーパー管理者アカウントのロールとデータ権限は変更しません。今回プロジェクトオーナーロールを付与し、同時にそのプロジェクトのデータ権限を指定する場合は、allData: trueのみ使用できます。dataPowersを省略して従来の動作を維持することも可能です。
- バッチ全体を一括で処理します。いずれかのアカウントでパラメータ、アクセス権、ロール、データ権限の検証に失敗した場合、またはアカウント、ロール、既定グループ、データ権限の書き込みに失敗した場合は、バッチ全体をロールバックします。部分的な成功結果は返しません。
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1006,
"return_message": "This API is Forbidden in SAAS"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1006 | Integer | リターンコード |
| return_message | This API is Forbidden in SAAS | String | リターンメッセージ |
9. SSOユーザーの作成
- ssoユーザー情報の作成に使用します
インターフェースURL
/open/create/ssoUser?token=xxx&loginType=dingtalk&loginName=user007
リクエストメソッド
GET
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| loginType | dingtalk | String | はい | サードパーティログインタイプ |
| loginName | user007 | String | はい | ログイン名 |
| password | - | String | いいえ | ログインパスワード(省略した場合はシステムが自動生成します) |
成功レスポンスの例
{
"data": true,
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| data | true | Object | レスポンスデータ |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1006,
"return_message": "操作する権限がありません。token値が正しいか確認してください"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1006 | Integer | リターンコード |
| 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パラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| projectId | 0 | Integer | はい | プロジェクトID |
| loginName | user007 | String | はい | 削除するユーザーのログイン名 |
| handoverToLoginName | user008 | String | はい | 譲渡先にできるユーザーのログイン名 |
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1023,
"return_message": "user user007が存在しません"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1023 | Integer | リターンコード |
| return_message | user user007が存在しません | String | リターンメッセージ |
11. システムからユーザーを削除(作業の譲渡を選択可能)
会社レベルのtokenのみ対応しています
インターフェースURL
/open/delete-auth-user-from-system?token=xxx&loginName=user007&handoverToLoginName=user008
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| loginName | user007 | Integer | はい | ログイン名 |
| handoverToLoginName | user008 | String | はい | 譲渡先ユーザーのログイン名 |
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1010,
"return_message": "Unsupported in SAAS"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1010 | Integer | リターンコード |
| return_message | Unsupported in SAAS | String | リターンメッセージ |
2. ユーザーグループ管理
1. ユーザーグループIDとメンバーリストのクエリ
インターフェースURL
/open/get-user-group-by-name?token=xxx&projectId=0&userGroupName=demo007
リクエストメソッド
GET
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| projectId | 0 | Integer | はい | プロジェクトID |
| userGroupName | demo007 | String | はい | ユーザーグループ名 |
成功レスポンスの例
{
"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.groupName | demo007 | String | グループ名 |
| data.id | 133 | Integer | id |
| data.isDefault | false | Boolean | デフォルトかどうか |
| data.members | - | List | メンバーリスト |
| data.members.userId | 16426 | Integer | ユーザーID |
| data.updateTime | 2021-11-22 19:22:15 | Date | 更新日時 |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1023,
"return_message": "ユーザーグループが存在しません"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1023 | Integer | リターンコード |
| return_message | ユーザーグループが存在しません | String | リターンメッセージ |
2. ユーザーグループの作成
インターフェースURL
/open/create-user-group?token=xxx&projectId=2
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| projectId | 2 | Integer | はい | プロジェクトID |
リクエストBodyパラメータ
{
"groupName": "demo007",
"isDefault": false,
"members": [
{
"userId": 16426,
"userName": "user007"
}
]
}
| $$パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| groupName | demo007 | String | はい | グループ名。最大64文字 |
| isDefault | false | Boolean | いいえ | 新規ユーザーをデフォルトでグループに追加するかどうか |
| members | - | List | いいえ | メンバーリスト |
| members.userId | 16426 | Integer | いいえ | メンバーのユーザーID |
| members.userName | user007 | String | いいえ | メンバーのユーザー氏名 |
成功レスポンスの例
{
"data": {
"id": 135
},
"return_code": 0,
"return_message": "success"
}
| $$パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| data | - | Object | レスポンスデータ |
| data.id | 135 | Integer | id |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1015,
"return_message": "既に存在します"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1015 | Integer | リターンコード |
| return_message | 既に存在します | String | リターンメッセージ |
3. ユーザーグループのメンバーリストの更新
ユーザーグループ名の追加・更新、グループメンバー情報の追加・更新に使用できます
送信したメンバーリストで、元のメンバーリスト全体が置き換えられます
インターフェースURL
/open/update-user-group?token=xxx&projectId=0
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| projectId | 0 | Integer | はい | プロジェクトID |
リクエストBodyパラメータ
{
"id": 99,
"groupName": "testGroup",
"isDefault": false,
"members": [
{
"userId": 88,
"userName": "test88"
},
{
"userId": 100,
"userName": "test100"
}
]
}
| $$パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| id | 99 | Integer | はい | ユーザーグループid |
| groupName | testGroup | String | いいえ | ユーザーグループ名。最大64文字 |
| isDefault | false | Boolean | いいえ | プロジェクトの新規ユーザーをデフォルトでこのグループに追加 |
| members | - | List | いいえ | ユーザーグループのメンバー |
| members.userId | 88 | String | いいえ | メンバーのユーザーID |
| members.userName | test88 | String | いいえ | メンバーのユーザー名 |
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1023,
"return_message": "ユーザーグループが存在しません"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1023 | Integer | リターンコード |
| return_message | ユーザーグループが存在しません | String | リターンメッセージ |
5. ユーザーグループの削除
インターフェースURL
/open/delete-user-group?token=xxx&projectId=0&groupId=1
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| projectId | 0 | Integer | はい | プロジェクトID |
| groupId | 1 | String | はい | グループID |
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1023,
"return_message": "ユーザーグループが存在しません"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1023 | Integer | リターンコード |
| 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パラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| projectId | 2 | Integer | はい | プロジェクトID |
| roleDesc | アナリスト007 | String | はい | ロールの説明 |
成功レスポンスの例
{
"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.projectId | 2 | Integer | プロジェクトID |
| data.roleDesc | アナリスト007 | String | ロールの説明 |
| data.roleName | analyst_1462717171385241600 | String | ロール名 |
| data.funcList | - | List | 機能リスト |
| data.funcList.functionClass | ダッシュボードの使用 | String | 機能分類 |
| data.funcList.functionDesc | ダッシュボードのフィルター条件の一時的な調整、全体フィルターの使用 | String | 機能の説明 |
| data.funcList.functionId | 35 | Integer | 機能ID |
| data.funcList.functionName | useDashbordFilter | String | 機能名 |
| data.funcList.functionType | 確認 | String | 機能タイプ |
| data.funcList.preFunctionId | 34 | Integer | 依存機能ID |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1023,
"return_message": "role testが存在しません"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1023 | Integer | リターンコード |
| return_message | role testが存在しません | String | リターンメッセージ |
2. (廃止)基本ロールの機能リストの取得
AE 5.0でロール権限管理機能がアップグレードされたため、baseRoleに基づいてカスタムロールを作成する必要はなくなりました
「すべての機能リストの取得」APIで全機能のリストをクエリし、ロールに必要な機能と機能の依存関係に基づいて、カスタムロールを直接作成してください。
3. すべての機能リストの取得
会社レベルのtokenのみ対応しています
インターフェースURL
/open/get-all-functions?token=xxx
リクエストメソッド
GET
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
成功レスポンスの例
{
"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.functionId | 8 | Integer | 機能ID |
| data.functionName | configProjectParm | String | 機能名 |
| data.functionDesc | プロジェクト構成情報を編集 | String | 機能の説明 |
| data.functionType | 編集 | String | 機能カテゴリ |
| data.functionClass | プロジェクト構成 | String | 機能モジュール |
| data.preFunctionId | 6 | Interger | 依存機能ID |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1008,
"return_message": "パラメータ(token)が空です"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1008 | Integer | リターンコード |
| return_message | パラメータ(token)が空です | String | リターンメッセージ |
3. プロジェクトロールの新規作成
プロジェクトロールを新規作成して権限を割り当てます。先に「すべての機能リストの取得」APIで必要な機能権限をクエリし、その中の権限IDに基づいてこのAPIを呼び出すことをお勧めします
インターフェースURL
/open/create-project-role?token=xxx&projectId=2
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| projectId | 2 | Integer | はい | プロジェクトID |
リクエストBodyパラメータ
{
"roleDesc": "アナリスト007",
"roleFuncList": [
14,34,53
]
}
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| roleDesc | アナリスト007 | String | はい | ロールの説明。最大60文字 |
| roleFuncList | [14] | List | はい | ロールの機能IDリスト。有効なIDである必要があります |
成功レスポンスの例
{
"data": {
"roleName": "analyst_1462717171385241600"
},
"return_code": 0,
"return_message": "success"
}
| $$パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| data | - | Object | レスポンスデータ |
| data.roleName | analyst_1462717171385241600 | String | ロール名 |
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -3004,
"return_message": "無効なプロジェクト"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -3004 | Integer | リターンコード |
| return_message | 無効なプロジェクト | String | リターンメッセージ |
4. プロジェクトロールの変更
インターフェースURL
/open/update-project-role?token=xxx&projectId=2&roleName=admin
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| projectId | 2 | Integer | はい | プロジェクトID |
| roleName | admin | String | はい | ロール名 |
リクエストBodyパラメータ
{
"roleDesc": "アナリスト009",
"roleFuncList": [
14,34,53
]
}
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| roleDesc | アナリスト009 | String | いいえ | ロールの説明 |
| roleFuncList | [14] | List | いいえ | ロールの機能IDリスト |
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -3004,
"return_message": "無効なプロジェクト"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -3004 | Integer | リターンコード |
| 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パラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| projectId | 0 | Integer | はい | プロジェクトID |
| roleName | role_1 | String | はい | ロール名 |
| newRoleName | role_2 | String | はい | 新しいロール名を指定 |
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1023,
"return_message": "role 'role_1' が存在しません"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1023 | Integer | リターンコード |
| return_message | role 'test' が存在しません | String | リターンメッセージ |
4. ダッシュボード共有のブラックリスト
使用シーン:ダッシュボード共有を設定する際、すべてのメンバーに表示されるよう共有した場合に、ブラックリストを使って特定のユーザーを除外できます
1. ブラックリストへの追加
会社レベルのtokenのみ対応しています
インターフェースURL
/open/share/add-black?token=xxx&loginName=root&blackProjectId=0
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| loginName | root | String | はい | ログイン名 |
| blackProjectId | 0 | Integer | はい | ブラックリストのプロジェクトID 0:すべてのプロジェクトで共有するブラックリスト プロジェクトID:そのプロジェクトのみのブラックリスト |
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
| data | Object | 戻り値 |
エラーレスポンスの例
{
"return_code": -1008,
"return_message": "パラメータ(token)が空です"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1008 | Integer | リターンコード |
| return_message | パラメータ(token)が空です | String | リターンメッセージ |
2. ブラックリストへの一括追加(csv)
会社レベルのtokenのみ対応しています
インターフェースURL
/open/share/add-black-list?token=xxx
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
ファイルのテンプレートは次のとおりです:
loginName,blackProjectId
demo@thinkingdata,-1
user1,298
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1008,
"return_message": "パラメータ(token)が空です"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1008 | Integer | リターンコード |
| 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パラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| groupIdList | [1] | List | はい | グループIDのリスト |
| groupType | 1 | Integer | はい | 1:ブラックリストグループ |
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1008,
"return_message": "パラメータ(token)が空です"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1008 | Integer | リターンコード |
| return_message | パラメータ(token)が空です | String | リターンメッセージ |
4. ブラックリストからの削除
- 会社レベルのtokenのみ対応しています
- 特定のユーザーを特定のプロジェクトのブラックリストから削除することも、すべてのブラックリストから削除することもできます
インターフェースURL
/open/share/cancel-black?token=xxx&loginName=root&blackProjectId=0
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
| loginName | root | String | はい | ログイン名 |
| blackProjectId | 0 | Integer | いいえ | ブラックリストのプロジェクトID |
成功レスポンスの例
{
"return_code": 0,
"return_message": "success"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | 0 | Integer | リターンコード |
| return_message | success | String | リターンメッセージ |
エラーレスポンスの例
{
"return_code": -1008,
"return_message": "パラメータ(token)が空です"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1008 | Integer | リターンコード |
| return_message | パラメータ(token)が空です | String | リターンメッセージ |
5. ブラックリストのダウンロード
- 会社レベルのtokenのみ対応しています
インターフェースURL
/open/share/download-share-black?token=xxx
リクエストメソッド
POST
Content-Type
application/json
リクエストQueryパラメータ
| パラメータ名 | サンプル値 | パラメータタイプ | 必須 | パラメータの説明 |
|---|---|---|---|---|
| token | xxx | String | はい | クエリキー |
成功レスポンスの例
csvファイル。サンプルのスクリーンショットは次のとおりです
エラーレスポンスの例
{
"return_code": -1008,
"return_message": "パラメータ(token)が空です"
}
| パラメータ名 | サンプル値 | パラメータタイプ | パラメータの説明 |
|---|---|---|---|
| return_code | -1008 | Integer | リターンコード |
| return_message | パラメータ(token)が空です | String | リターンメッセージ |

