RBAC API

このページでは、Splunk AppDynamics 機能のユーザー、グループ、およびロールを管理するために使用できる、ロールベースアクセスコントロール（RBAC）API メソッドについて説明します。これらの操作により柔軟性が向上し、RBAC 管理による自動化が実現します。addUserToGroup および removeUserToGroup などのリレーションシップの設定がサポートされています。

Support

To access the RBAC API, you require the Account Owner role. Alternatively, you can create a new custom role that includes permissions for 'Administration,' 'Agents,' and the 'Getting Started Wizard.'

SAML and LDAP user creations are not supported. You can only create permissions through the UI. See Manage Controller Tenant Users and Groups.

ユーザーの作成

これを使用して、現在のアカウントでユーザを作成できます。要求ペイロードでは、name、security_provider_type、displayName、および password を指定する必要があります。ユーザ ID はサーバによって生成されます。

形式

 POST /controller/api/rbac/v1/users

入力パラメータ


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

例

curl -H "Content-Type: application/vnd.appd.cntrl+json;v=1" -X POST -d '{"name": "user10", "security_provider_type": "INTERNAL", "displayName": "user10", "password": "welcome"}' -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/users
Response status code 200 :
{
"id": 10,
"name": "user10",
"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": 23,"name": "Universal Agent Administrator"},
{"id": 24,"name": "Universal Agent 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": 23,"name": "Universal Agent Administrator"},
{"id": 24,"name": "Universal Agent 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"}
]

注:

この API は内部ユーザの取得のみをサポートし、SAML または LDAP はサポートしません。
SAML/LDAP ユーザを検索するには、オプションのパラメータ（securityProviderType を含める必要があります。

すべてのユーザの取得

これを使用して、現在のアカウント内のすべてのユーザのリストを取得できます。リストには、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": 23,"name": "Universal Agent Administrator"},
{"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": 23,"name": "Universal Agent Administrator"},
{"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": 23,"name": "Universal Agent Administrator"},
{"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 :

Create Role

Use this to create a role in the current account. The ID is generated by the server.

Format

 POST /controller/api/rbac/v1/roles

Input Parameters


Parameter Name	Parameter Type	Mandatory
`name`	Request payload	Yes
`description`	Request payload	No
`type` 注: You can use the static or dynamic types.	Request payload	No
`permissions` 注: The `permissions` block now supports both static and dynamic permission definition.	Request payload	No

Example

curl -X POST /controller/api/rbac/v1/roles \
-H 'Content-Type: application/vnd.appd.cntrl+json;v=1' \
-d '{
"name": "SampleRole2", 
"Type": "static",
"permissions": [
{
"entityType": "APPLICATION",
"action": "CONFIG_ACTIONS"
},
{
"entityType": "APPLICATION",
"action": "CONFIG_BASELINES"
},
{
"entityType": "APPLICATION",
"action": "CONFIG_BUSINESS_TRANSACTIONS"
},
{
"entityType": "APPLICATION",
"action": "CONFIG_ERROR_DETECTION"
},
{
"entityType": "APPLICATION",
"action": "CONFIG_EUM"
},
{
"entityType": "APPLICATION",
"action": "CONFIG_EVENT_REACTOR"
},
{
"entityType": "APPLICATION",
"action": "CONFIG_POLICIES"
},
{
"entityType": "APPLICATION",
"action": "CONFIG_TRANSACTION_DETECTION"
},
{
"entityType": "APPLICATION",
"action": "VIEW"
}
]
}'

Role Permissions for Entity Actions


Entity Type	Action	Permissions
ACCOUNT	`ADMINISTER_RBAC`	Administer users, groups, roles, authentication, view agents, and use the Getting Started Wizard. See Account Administration for administering users, groups, roles, and configuring authentication.
ACCOUNT	`CONFIG_LDAP`	Configure LDAP.
ACCOUNT	`CONFIG_SAML`	Configure SAML.
ACCOUNT	`ADMINISTER_LICENSE`	View and configure licenses.
ACCOUNT	`CONFIG_NOTIFICATIONS`	Configure Email/SMS.
ACCOUNT	`CONFIG_CUSTOM_EMAIL_ACTION_PLANS`	Configure Email Templates.
ACCOUNT	`CONFIG_HTTP_REQUEST_ACTION_PLANS`	Configure HTTP Request Templates.
ACCOUNT	`CREATE_WAR_ROOMS`	Create Virtual War Rooms.
ACCOUNT	`VIEW_BUSINESS_FLOW`	View Business Flow Maps.
ACCOUNT	`VIEW_SCHEDULED_REPORTS`	View scheduled reports.
ACCOUNT	`CONFIG_SCHEDULED_REPORTS`	Configure scheduled reports.
`APPLICATION`	VIEW_TAGS	The `VIEW_TAGS` permission is required for roles to view tags. The `MANAGE_TAGS` permission is required for roles to manage (create, edit, and delete) tags.
`APPLICATION`	MANAGE_TAGS	View Tags and Custom Tag APIs.
APPLICATION	`VIEW`	View business applications.
APPLICATION	`VIEW_DBMON_UI`	View Database Visibility.
APPLICATION	`CONFIG_TRANSACTION_DETECTION`	Configure Transaction Detection.
APPLICATION	`CONFIG_BACKEND_DETECTION`	Configure Backend Detection.
APPLICATION	`CONFIG_ERROR_DETECTION`	Configure Error Detection.
APPLICATION	`CONFIG_DIAGNOSTIC_DATA_COLLECTORS`	Configure Diagnostic Data Collectors.
APPLICATION	`CONFIG_CALLGRAPH_SETTINGS`	Configure Call Graph Settings.
APPLICATION	`CONFIG_JMX`	Configure JMX.
APPLICATION	`CONFIG_EUM`	Configure EUM.
APPLICATION	`CONFIG_INFO_POINTS`	Configure Information Points.
APPLICATION	`CONFIG_POLICIES`	Configure Health Rules.
APPLICATION	`CONFIG_EVENT_REACTOR`	Configure Policies.
APPLICATION	`CONFIG_ACTIONS`	Configure Actions.
APPLICATION	`CONFIG_BUSINESS_TRANSACTIONS`	Configure Business Transactions.
APPLICATION	`CONFIG_BASELINES`	Configure baselines.
APPLICATION	`CONFIG_SQL_BIND_VARIABLES`	Configure SQL capture settings.
APPLICATION	`CONFIG_AGENT_PROPERTIES`	Configure agent properties.
APPLICATION	`ENABLE_JMX_OPERATIONS`	Set JMX MBean attributes and invoke operations.
APPLICATION	`CONFIG_SERVICE_ENDPOINTS`	Configure service endpoints.
APPLICATION	`MANAGE_CUSTOM_DASHBOARD_TEMPLATES`	Configure custom dashboards for tiers and nodes.
APPLICATION	`CONFIG_TRIGGER_DIAGNOSTIC_SESSION`	Start diagnostic sessions.
APPLICATION	`VIEW_SIM`	View Server Visibility.
APPLICATION	`CONFIG_SIM`	Configure Server Visibility.
SIM_MACHINE	`VIEW_SIM`	View Server Visibility.
SIM_MACHINE	`CONFIG_SIM`	Configure Server Visibility

200 OK
{
"id": 87,
"name": "SampleRole2"
}

Add Role to User

Use this to add a role to a user by roleId and userId.

Format

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

Example

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 で完全なロール情報を取得します。これは role オブジェクトのみを返します。

注: この API は、分析イベントの権限を返しません。

形式

 GET /controller/api/rbac/v1/roles/[roleId]?include-permissions=true

入力パラメータ


パラメータ名	Parameter Type	値	必須
`id`	要求ペイロード		あり
include-permissions (>= v4.5.14)	要求ペイロード	`"true"`	いいえ

例

curl -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles/15?include-permissions=true
Response status code 200 :
{
"id": 15,
"name": "SampleRole",
"permissions": [
{
"id": 2619,
"entityType": "APPLICATION",
"action": "CONFIG_ACTIONS"
},
{
"id": 2621,
"entityType": "APPLICATION",
"action": "CONFIG_BASELINES"
},
{
"id": 2620,
"entityType": "APPLICATION",
"action": "CONFIG_BUSINESS_TRANSACTIONS"
},
{
"id": 2610,
"entityType": "APPLICATION",
"action": "CONFIG_ERROR_DETECTION"
},
{
"id": 2615,
"entityType": "APPLICATION",
"action": "CONFIG_EUM"
},
{
"id": 2618,
"entityType": "APPLICATION",
"action": "CONFIG_EVENT_REACTOR"
},
{
"id": 2617,
"entityType": "APPLICATION",
"action": "CONFIG_POLICIES"
},
{
"id": 2608,
"entityType": "APPLICATION",
"action": "CONFIG_TRANSACTION_DETECTION"
},
{
"id": 2606,
"entityType": "APPLICATION",
"action": "VIEW"
}
]
}

名前でロールを取得する

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

注: この API は、分析イベントの権限を返しません。

形式

 GET /controller/api/rbac/v1/roles/name/[RoleName]?include-permissions=true

入力パラメータ


パラメータ名	Parameter Type	値	必須
name	要求ペイロード		あり
include-permissions (>= v4.5.14)	要求ペイロード	`"true"`	いいえ

例

curl -u user1@customer1 http://localhost:8080/controller/api/rbac/v1/roles/name/SampleRole?include-permissions=true
Response status code 200 :
{
"id": 15,
"name": "SampleRole",
"permissions": [
{
"id": 2619,
"entityType": "APPLICATION",
"action": "CONFIG_ACTIONS"
},
{
"id": 2621,
"entityType": "APPLICATION",
"action": "CONFIG_BASELINES"
},
{
"id": 2620,
"entityType": "APPLICATION",
"action": "CONFIG_BUSINESS_TRANSACTIONS"
},
{
"id": 2610,
"entityType": "APPLICATION",
"action": "CONFIG_ERROR_DETECTION"
},
{
"id": 2615,
"entityType": "APPLICATION",
"action": "CONFIG_EUM"
},
{
"id": 2618,
"entityType": "APPLICATION",
"action": "CONFIG_EVENT_REACTOR"
},
{
"id": 2617,
"entityType": "APPLICATION",
"action": "CONFIG_POLICIES"
},
{
"id": 2608,
"entityType": "APPLICATION",
"action": "CONFIG_TRANSACTION_DETECTION"
},
{
"id": 2606,
"entityType": "APPLICATION",
"action": "VIEW"
}
]
}

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

これを使用して、現在のアカウント内のすべてのロールを取得できます。これは、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": 23,"name": "Universal Agent Administrator"},
{"id": 24,"name": "Universal Agent User"},
{"id": 15,"name": "User"},
{"id": 17,"name": "Workflow Executor"}
]
}

ロールを更新する

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

この API を使用してロール内の権限を更新することはできません。name および description パラメータのみ更新できます。

形式

 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 :