Versions Compared

    Key

    • This line was added.
    • This line was removed.
    • Formatting was changed.
    Comment: Published by Scroll Versions from this space and version 20.8-next
    sv-translation
    languageen

    This page describes the Role-Based Access Control (RBAC) API methods you can use to manage users, groups, and roles for AppDynamics features. These operations provide more flexibility and automation with RBAC management. Relationship settings such as addUserToGroup and removeUserToGroup are supported.

    Appd permissions
    Width800px

    You must be the account owner or have administer user permissions to use the RBAC API.

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

    Create User

    Use this to create users in the current account. The request payload should specify name, security_provider_typedisplayName, and password. The user ID is generated by the server.

    Format

    POST /controller/api/rbac/v1/users

    Input Parameters

    Parameter NameParameter TypeValueMandatory
    nameRequest payload
    Yes

    security_provider_type

    Request payload"INTERNAL"Yes

    displayName

    Request payload
    Yes

    password

    Request payload
    Yes

    Example

    No Format
    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"
    }

    Get User by ID

    Use this to get full user information, including a summary of affiliated groups and roles, using the userId in the current account.

    Format

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

    Example

    No Format
    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"} 
          ] 
    }

    Get User by Name

    Use this to get full user information, including a summary of affiliated groups and roles, using the userName in the current account.

    Format

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

    Example

    No Format
    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"} 
          ] 
    }

    Get All Users

    Use this to get a list of all users in the current account. The list includes user summaries, which includes userId and userName.

    Format

    GET /controller/api/rbac/v1/users

    Example

    No Format
    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"}
          ]
    }

    Update User

    Use this to update a user by userId in the current account. Only the user object itself is updated, with the relationship to roles and groups remaining unaffected.

    Format

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

    Input Parameters

    Parameter NameParameter TypeValueMandatory
    idRequest payload
    Yes
    nameRequest payload
    Yes

    displayName

    Request payload
    Yes

    security_provider_type

    Request payload"INTERNAL"Yes

    Example

    No Format
    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" 
    }

    Delete User

    Use this to delete a user by userId in the current account.

    Format

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

    Example

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

    Create Group

    Use this to create a group in the current account. The groupId is generated by the server.

    Format

    POST /controller/api/rbac/v1/groups 

    Input Parameters

    Parameter NameParameter TypeValueMandatory
    nameRequest payload
    Yes
    descriptionRequest payload
    No

    security_provider_type

    Request payload"INTERNAL"Yes 

    Example

    No Format
    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"
    }

    Get Group by ID

    Use this to get full group information by groupId in the current account.

    Format

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

    Example

    No Format
    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"}
          ]
    }

    Get Group by Name

    Use this to get full group information by groupName in the current account.

    Format

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

    Example

    No Format
    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"}
          ]
    }

    Get All Groups

    Use this to get all groups in the current account. This only returns group summaries, which includes groupId and groupName.

    Format

    GET /controller/api/rbac/v1/groups

    Example 

    No Format
    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"}
          ]
    }

    Update Group

    Use this to update a group by groupId in the current account. Only the group itself is updated, while the relationships with users and roles remain unaffected.

    Format

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

    Input Parameters

    Parameter NameParameter TypeValueMandatory
    idRequest payload
    Yes
    nameRequest payload
    Yes
    descriptionRequest payload
    No

    security_provider_type

    Request payload"INTERNAL"Yes

    Example

    No Format
    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"}
          ]
    }

    Delete Group 

    Use this to delete a group by groupId in the current account.

    Format

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

    Example

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

    Add User to Group

    Use this to add a user to a group by userId and groupId.

    Format

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

    Example

    No Format
    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 :

    Remove User from Group

    Use this to remove a user from a group by userId and groupId.

    Format

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

    Example

    No Format
    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 NameParameter TypeValueMandatory
    nameRequest payload
    Yes
    description
    Request payload
    No

    Example

    No Format
    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" 
    }

    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

    No Format
    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 :

    Remove Role from User

    Use this to remove a role from a user by roleId and userId.

    Format

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

    Example

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

    Add Role to Group

    Use this to add a role to a group by roleId and groupId.

    Format

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

    Example

    No Format
    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 :

    Remove Role from Group

    Use this to remove a role from a group by roleId and groupId.

    Format

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

    Example

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

    Get Role by ID

    Use this to get full role information by roleId in the current account. This only returns the role object.

    Format

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

    Example

    No Format
    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"
    }

    Get Role by Name

    Use this to get full role information by roleName in the current account.

    Format

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

    Example

    No Format
    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"
    }

    Get All Roles

    Use this to get all roles in the current account. This only returns role summaries, which includes roleId and roleName.

    Format

    GET /controller/api/rbac/v1/roles 

    Example

    No Format
    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"}
          ]
    }

    Update Role

    Use this to update a role by roleId in the current account. This only updates the role object itself, while leaving the relationship with users and groups unaffected.

    Format

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

    Input Parameters

    Parameter NameParameter TypeValueMandatory
    idRequest payload
    Yes
    nameRequest payload
    Yes
    descriptionRequest payload
    No

    Example

    No Format
    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 Role

    Use this to delete a role in the current account.

    Format

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

    Example

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



    sv-translation
    languageja
    Appd tocbox
    Width325px

    On this page

    Table of Contents
    maxLevel2

    ロール ベース アクセス コントロール(RBAC)REST API を使用すると、AppDynamics 機能のユーザ、グループ、およびロールを管理できます。これらの操作により柔軟性が向上し、RBAC 管理による自動化が実現します。addUserToGroup および removeUserToGroup などのリレーションシップの設定がサポートされています。

    RBAC REST API を使用するには、アカウントの所有者であるか、または管理ユーザ権限を持っている必要があります。

    SAML および LDAP ユーザの作成はサポートされていません。また、UI を使用して権限のみ作成することもできます。

    ユーザとグループについては、「Manage Users and Groups」を参照してください。

    ユーザの作成

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

    形式

    POST /controller/api/rbac/v1/users

    入力パラメータ

    パラメータ名Parameter Type必須
    name要求ペイロード あり

    security_provider_type

    要求ペイロード内部あり

    displayName

    要求ペイロード Yes

    password

    要求ペイロード あり

    No Format
    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

    No Format
    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

    No Format
    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"} 
          ] 
    }

    すべてのユーザを取得する

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

    形式

    GET/controller/api/rbac/v1/users

    No Format
    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

    要求ペイロード内部あり

    No Format
    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

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

    グループの作成

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

    形式

    POST /controller/api/rbac/v1/groups

    入力パラメータ

    パラメータ名Parameter Type必須
    name要求ペイロード あり
    説明要求ペイロード なし

    security_provider_type

    要求ペイロード内部対応

    No Format
    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

    No Format
    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

    No Format
    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"}
          ]
    }

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

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

    形式

    GET /controller/api/rbac/v1/groups

     

    No Format
    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要求ペイロード あり
    説明要求ペイロード なし

    security_provider_type

    要求ペイロード内部あり

    No Format
    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

    No Format
    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

    No Format
    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 

    No Format
    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
    要求ペイロード なし

    No Format
    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

    No Format
    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 

    No Format
    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

    No Format
    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

    No Format
    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

    No Format
    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

    No Format
    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"
    }

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

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

    形式

    GET /controller/api/rbac/v1/roles

    No Format
    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 でロールを更新できます。これにより、ロールオブジェクト自体のみが更新され、ユーザおよびグループとの関係は影響を受けません。

    形式

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

    入力パラメータ

    パラメータ名Parameter Type必須
    id要求ペイロード あり
    name要求ペイロード あり
    説明要求ペイロード なし

    No Format
    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

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