Getting information about a specific user group

Execution permission

Security Administrator (View Only)

Request line

GET base-URL/v1/objects/user-groups/object-ID

Request message

Object ID

Set the userGroupObjectId value obtained by getting the information about the user group.

Attribute	Type	Description
userGroupObjectId	string	(Required) The object ID for a user group ID The object ID is case sensitive.

Query parameters

None.

Body

None.

Response message

Body

{
  "userGroupObjectId": "devGroup",
  "userGroupId": "devGroup",
  "roleNames":[
    "Security Administrator (View Only)"
  ],
  "resourceGroupIds": [
    1,
    2,
    3
  ],
  "isBuiltIn":false,
  "hasAllResourceGroup":false
}

Attribute	Type	Description
userGroupObjectId	string	The object ID for a user group ID An encoded character string is output if the user group ID includes reserved characters defined in RFC 3986.
userGroupId	string	The user group ID
roleNames	string[]	The role name assigned to the user group
resourceGroupIds	int[]	The IDs of the resource groups assigned to the user group
isBuiltIn	boolean	Information about whether the user group is a built-in user group. true: A built-in user group. false: A user group created by a user.
hasAllResourceGroup	boolean	Information about whether all the resource groups are assigned to the target. true: All the resource groups are assigned. false: The specified resource groups are assigned.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/user-groups/devGroup