Getting a list of roles assigned to a specific user group

Ops Center Common Services REST API Reference Guide

Version
10.7.x
File Size
577 KB
Audience
anonymous
Part Number
MK-99OPS003-03
The following request gets a list of roles assigned to a specific user group.

Execution permission

You must be a system administrator or a security administrator.

Request line

GET base-URL/security/v1/user-groups/object-ID-of-the-user-group/role-mappings/portal

Request message

Object ID of the user group

Specify the value of id acquired by using the request for getting information about a list of user groups.

Attribute

Type

Description

id

string

(Required) Object ID of the user group

Query parameters
None.
Body
None.

Response message

Body
[
    {
        "id": "6eb98bb9-43cc-4062-a25c-185e78afa438",
        "name": "opscenter-system-administrator",
        "description": null,
        "builtin": true,
        "essential": false
    },
    {
        "id": "8c9db2e1-9abb-4f9a-a6a0-d0486faa75c1",
        "name": "opscenter-user",
        "description": null,
        "builtin": true,
        "essential": true
    }
]

Attribute

Type

Description

id

string

Object ID of the role

name

string

Role name

description

string

Description of the role

builtin

boolean

Whether the role is a built-in role

  • true: The role is a built-in role.
  • false: The role is not a built-in role.

essential

boolean

Whether the role is an essential role (opscenter-user)

  • true: The role is an essential role.
  • false: The role is not an essential role.

Coding example

curl -v -X GET -s "https://example.com:443/portal/security/v1/user-groups/4760d4c0-c593-42fe-b44a-553da4793882/role-mappings/portal" -H "Authorization:Bearer eyJhbxxx"
Tip: Because this request uses SSL communication, you must either run the curl command with the root certificate of the Common Services server certificate specified for the --cacert option, or run the command with the -k option specified. (The -k option runs the command by ignoring SSL errors.)