Getting a list of roles that can be 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/available

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": "e219126f-c858-4fc6-8ad9-9622cc8bddf7",
        "name": "opscenter-security-administrator",
        "description": null,
        "builtin": true,
        "essential": false
    },
    {
        "id": "6eb98bb9-43cc-4062-a25c-185e78afa438",
        "name": "opscenter-system-administrator",
        "description": null,
        "builtin": true,
        "essential": false
    }
]

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/7a773ca8-49cf-4ee2-9456-eb4853b4c6c1/role-mappings/portal/available" -H "Authorization:Bearer eyJhbxxx"