Get detailed user group information by user group name

scheme://domain:port/platform/ws/usergroups/{userGroupName}

The logged on user must have view_configure permission on the setting resource to use this API.

Gets detailed information about user groups with the specified name.

To specify multiple user groups, separate with a comma(,). For example: group1,group2.

Use the keyword all to get detailed information for all user groups in the cluster.

Use the API /platform/ws/usergroups/ to get a list of user groups.

GET

None

GET

/platform/ws/usergroups/{userGroupName}

empty

• 200 Successful: Request was successful.
• 403 Forbidden: logged on user does not have the Cluster administrator role.
• 404 Not Found: No user groups found.
• 500 Internal Server Error: Exception occurred

If successful, returns detailed information about user groups.

For additional information, refer to the schema file GUID-e22cbcbf-f95d-43f4-a363-13cde34e1f15.xsd.

<userGroup name=”%s”>
<atom:link rel="self" href="%s"/>
 <admins>
  <user name=”%s”>
   ...
  </user>
  </admins>
 <users>
  <user name=”%s”>
   ...
 </users >
</userGroup>

If not successful, returns an error message.

<error>
  <message>
     %s
  </message>
</error>