Create Central Identity User API

This page describes the Create Central Identity User API methods you can use to create central identity(ci) users in the current account. This API is only available when the current account is configured with the CI_USER_CREATION property.

Attention: You must be the account owner or have the administer user permissions to use the Create Central Identity User API.

SAML and LDAP user creations are not supported. You can only create permissions through the UI. See Manage Custom Roles.

ユーザーの作成

要求ペイロードでは、email、displayName、および security_provider_type を指定する必要があります。ユーザ ID はサーバによって生成されます。

形式

POST /controller/api/rbac/v1/ci-user

入力パラメータ


パラメータ名	Parameter Type	値	必須
`email`	要求ペイロード		あり
security_provider_type	要求ペイロード	`"INTERNAL"`	あり
displayName	要求ペイロード		あり

例

curl -H "Content-Type: application/vnd.appd.cntrl+json;v=1" -X POST -d '{"email": "user10@domain.com", "security_provider_type": "INTERNAL", "displayName": "user10"}' -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/ci-user
Response status code 200 :
{
"id": 10,
"name": "user10@domain.com",
"email": "user10@domain.com",
"displayName": "user10",
"security_provider_type": "INTERNAL"
}

ID でユーザを取得する

これを使用して、現在のアカウントで userId を使用して、関連するグループとロールの概要を含む完全なユーザー情報を取得できます。

形式

GET /controller/api/rbac/v1/users/userId

例

curl -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/users/4
Response status code 200 :
{
"id": 4,
"name": "user1",
"email": "user1@customer1.com",
"displayName": "user1",
"security_provider_type": "INTERNAL",
"roles":
[
{"id": 17,"name": "Workflow Executor"},
{"id": 18,"name": "DB Monitoring Administrator"},
{"id": 19,"name": "DB Monitoring User"},
{"id": 20,"name": "Analytics Administrator"},
{"id": 21,"name": "Server Monitoring Administrator"},
{"id": 22,"name": "Server Monitoring User"},
{"id": 13,"name": "Account Administrator"},
{"id": 14,"name": "Administrator"},
{"id": 15,"name": "User"},
{"id": 16,"name": "Dashboard Viewer"}
],
"groups":
[
{"id": 1,"name": "group_01"}
]
}

名前でユーザを取得する

これを使用して、現在のアカウントで userName を使用して、関連するグループとロールの概要を含む完全なユーザー情報を取得できます。

形式

GET /controller/api/rbac/v1/users/name/name

例

curl -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/users/name/user1
Response status code 200 :
{
"id": 4,
"name": "user1",
"email": "user1@customer1.com",
"displayName": "user1",
"security_provider_type": "INTERNAL",
"roles":
[
{"id": 17,"name": "Workflow Executor"},
{"id": 18,"name": "DB Monitoring Administrator"},
{"id": 19,"name": "DB Monitoring User"},
{"id": 20,"name": "Analytics Administrator"},
{"id": 21,"name": "Server Monitoring Administrator"},
{"id": 22,"name": "Server Monitoring User"},
{"id": 13,"name": "Account Administrator"},
{"id": 14,"name": "Administrator"},
{"id": 15,"name": "User"},
{"id": 16,"name": "Dashboard Viewer"}
],
"groups":
[
{"id": 1,"name": "group_01"}
]

すべてのユーザの取得

これを使用して、現在のアカウント内のすべてのユーザのリストを取得できます。リストには、userId や userName などのユーザの概要が含まれています。

形式

GET /controller/api/rbac/v1/users

例

curl -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/users
Response status code 200 :
{
"users":
[
{"id": 4,"name": "user1"},
{"id": 10,"name": "user10"}
]
}

ユーザーの更新

これを使用して、現在のアカウントの userId でユーザを更新できます。ユーザオブジェクト自体のみが更新され、ロールやグループに対するリレーションシップは影響を受けません。

形式

PUT /controller/api/rbac/v1/users/userId

入力パラメータ


パラメータ名	Parameter Type	値	必須
`id`	要求ペイロード		あり
`name`	要求ペイロード		あり
displayName	要求ペイロード		あり
security_provider_type	要求ペイロード	`"INTERNAL"`	あり

例

curl -H "Content-Type: application/vnd.appd.cntrl+json;v=1" -X PUT -d '{"id": 11,"name": "updated_user9","displayName": "user9","security_provider_type": "INTERNAL"}' -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/users/11
Response status code 200 :
{
"id": 11,
"name": "updated_user9",
"displayName": "user9",
"security_provider_type": "INTERNAL"
}

ユーザの削除

これを使用して、現在のアカウントの userId でユーザを削除できます。

形式

DELETE /controller/api/rbac/v1/users/userId

例

curl -X DELETE -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/users/11
Response status code 200 :

グループの作成

これを使用して、現在のアカウントでグループを作成できます。groupId はサーバによって生成されます。

形式

POST /controller/api/rbac/v1/groups

入力パラメータ


パラメータ名	Parameter Type	値	必須
`name`	要求ペイロード		あり
`description`	要求ペイロード		いいえ
security_provider_type	要求ペイロード	`"INTERNAL"`	あり

例

curl -H "Content-Type: application/vnd.appd.cntrl+json;v=1" -X POST -d '{"name": "group100","description": "new description", "security_provider_type": "INTERNAL"}' -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/groups
Response status code 200 :
{
"id": 2,
"name": "group100",
"security_provider_type": "INTERNAL",
"description": "new description"
}

ID でグループを取得する

これを使用して、現在のアカウントの groupId によって完全なグループ情報を取得できます。

形式

GET /controller/api/rbac/v1/groups/groupId

例

curl -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/groups/1
Response status code 200 :
{
"id": 1,
"name": "group_03",
"security_provider_type": "INTERNAL"
"description": "",
"roles":
[
{"id": 19,"name": "DB Monitoring User"},
{"id": 20,"name": "Analytics Administrator"},
{"id": 21,"name": "Server Monitoring Administrator"},
{"id": 22,"name": "Server Monitoring User"},
{"id": 13,"name": "Account Administrator"},
{"id": 16,"name": "Dashboard Viewer"}
]
}

名前でグループを取得する

これを使用して、現在のアカウントの groupName によって完全なグループ情報を取得できます。

形式

GET /controller/api/rbac/v1/groups/name/name

例

curl -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/groups/name/group_03
Response status code 200 :
{
"id": 1,
"name": "group_03",
"security_provider_type": "INTERNAL"
"description": "",
"roles":
[
{"id": 19,"name": "DB Monitoring User"},
{"id": 20,"name": "Analytics Administrator"},
{"id": 21,"name": "Server Monitoring Administrator"},
{"id": 22,"name": "Server Monitoring User"},
{"id": 13,"name": "Account Administrator"},
{"id": 16,"name": "Dashboard Viewer"}
]
}

すべてのグループを取得する

これを使用して、現在のアカウント内のすべてのグループを取得できます。これは、groupId や groupName などのグループの概要のみを返します。

形式

GET /controller/api/rbac/v1/groups

例

curl -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/groups
Response status code 200 :
{
"groups":
[
{"id": 1,"name": "group_03"},
{"id": 2,"name": "group100"}
]
}

グループの更新

これを使用して、現在のアカウントの groupId でグループを更新できます。グループ自体のみが更新され、ユーザとロールのリレーションシップは影響を受けません。

形式

PUT /controller/api/rbac/v1/groups/groupId

入力パラメータ


パラメータ名	Parameter Type	値	必須
`id`	要求ペイロード		あり
`name`	要求ペイロード		あり
`description`	要求ペイロード		いいえ
security_provider_type	要求ペイロード	`"INTERNAL"`	あり

例

curl -H "Content-Type: application/vnd.appd.cntrl+json;v=1" -X PUT -d '{"id": 1, "name": "group2","description": "new description", "security_provider_type": "INTERNAL"}' -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/groups/1
Response status code 200 :
{
"id": 1,
"name": "group2",
"security_provider_type": "INTERNAL",
"description": "new description",
"roles":
[
{"id": 19,"name": "DB Monitoring User"},
{"id": 20,"name": "Analytics Administrator"},
{"id": 21,"name": "Server Monitoring Administrator"},
{"id": 22,"name": "Server Monitoring User"},
{"id": 13,"name": "Account Administrator"},
{"id": 16,"name": "Dashboard Viewer"}
]
}

グループの削除

これを使用して、現在のアカウントの groupId でグループを削除できます。

形式

DELETE /controller/api/rbac/v1/groups/groupId

例

curl -X DELETE -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/groups/1
Response status code 200 :

ユーザをグループに追加する

これを使用し、 userId と groupIdによってグループにユーザーを追加します。

形式

PUT /controller/api/rbac/v1/groups/groupId/users/userId

例

curl -H "Content-Type: application/vnd.appd.cntrl+json;v=1" -X PUT -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/groups/2/users/10
Response status code 200 :

ユーザをグループから削除する

これを使用し、 userId と groupIdによってグループからユーザーを削除します。

形式

DELETE /controller/api/rbac/v1/groups/groupId/users/userId

例

curl -X DELETE -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/groups/2/users/10
Response status code 200 :

ロールを作成する

これを使用して、現在のアカウントでロールを作成できます。ID はサーバによって生成されます。

形式

POST /controller/api/rbac/v1/roles

入力パラメータ


パラメータ名	Parameter Type	値	必須
`name`	要求ペイロード		あり
`description`	要求ペイロード		いいえ

例

curl -H "Content-Type: application/vnd.appd.cntrl+json;v=1" -X POST -d '{"name": "role2","description": "new description"}' -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles
Response status code 200 :
{
"id": 49,
"name": "role2",
"description": "new description"
}

ロールをユーザへ追加する

これを使用し、 roleId と userIdによってユーザーにロールを追加します。

形式

PUT /controller/api/rbac/v1/roles/roleId/users/userId

例

curl -H "Content-Type: application/vnd.appd.cntrl+json;v=1" -X PUT -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles/50/users/10
Response status code 200 :

ユーザからロールを削除する

これを使用し、 roleId および userIdでユーザーからロールを削除します。

形式

DELETE /controller/api/rbac/v1/roles/roleId/users/userId

例

curl -X DELETE -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles/50/users/10
Response status code 200 :

ロールをグループに追加する

これを使用して、roleId および groupId によってロールをグループに追加できます。

形式

PUT /controller/api/rbac/v1/roles/roleId/groups/groupId

例

curl -H "Content-Type: application/vnd.appd.cntrl+json;v=1" -X PUT -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles/50/groups/2
Response status code 200 :

グループからロールを削除する

これを使用して、roleId および groupId によってロールをグループから削除できます。

形式

DELETE /controller/api/rbac/v1/roles/roleId/groups/groupId

例

curl -X DELETE -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles/50/groups/2
Response status code 200 :

ID でロールを取得する

これを使用して、現在のアカウントの roleId で完全なロール情報を取得します。これによって、ロールオブジェクトのみが返されます。

形式

GET /controller/api/rbac/v1/roles/roleId

例

curl -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles/15
Response status code 200 :
{
"id": 15,
"name": "User",
"description": "Can view applications and dashboards but not modify their configuration"
}

名前でロールを取得する

これを使用して、現在のアカウントの roleName で完全なロール情報を取得します。

形式

GET /controller/api/rbac/v1/roles/name/name

例

curl -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles/name/User
Response status code 200 :
{
"id": 15,"name":
"User",
"description": "Can view applications and dashboards but not modify their configuration"
}

すべてのロールを取得する

これを使用して、現在のアカウント内のすべてのロールを取得できます。これは、roleId や roleName などのロールの概要のみを返します。

形式

GET /controller/api/rbac/v1/roles

例

curl -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles
Response status code 200 :
{
"roles":
[
{"id": 13,"name": "Account Administrator"},
{"id": 14,"name": "Administrator"},
{"id": 20,"name": "Analytics Administrator"},
{"id": 16,"name": "Dashboard Viewer"},
{"id": 18,"name": "DB Monitoring Administrator"},
{"id": 19,"name": "DB Monitoring User"},
{"id": 21,"name": "Server Monitoring Administrator"},
{"id": 22,"name": "Server Monitoring User"},
{"id": 15,"name": "User"},
{"id": 17,"name": "Workflow Executor"}
]
}

ロールを更新する

これを使用して、現在のアカウントの roleId でロールを更新できます。これにより、ロールオブジェクト自体のみが更新され、ユーザおよびグループとの関係は影響を受けません。

形式

PUT /controller/api/rbac/v1/roles/roleId

入力パラメータ


パラメータ名	Parameter Type	必須
`id`	要求ペイロード	あり
`name`	要求ペイロード	あり
`description`	要求ペイロード	いいえ

例

curl -H "Content-Type: application/vnd.appd.cntrl+json;v=1" -X PUT -d '{"id": 49, "name": "role1","description": "new description" }' -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles/49
Response status code 200 :
{
"id": 49,
"name": "role1",
"description": "new description"
}

ロールの削除

これを使用して、現在のアカウントでロールを削除できます。

形式

DELETE /controller/api/rbac/v1/roles/roleId

例

curl -X DELETE -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles/49
Response status code 200 :