Get a list of user groups

Edit online

Description

URL

scheme://domain:port/platform/ws/usergroups

Description

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

Gets a list of all user groups.

HTTP-Method

GET

Parameters

None

Request

Request-Method

GET

Request-URI

/platform/ws/usergroups

Request-Header

Name

Value

Accept

application/xml or application/json

Message-body

empty

Response

Response-Code

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

Response-Header

Name

Value

Content-Type

application/xml or application/json
Message Body Success Message

If successful, returns a list of user group names.

For additional information, refer to the schema file ./schemas/rbac/usergroups.xsd.

<userGroups total=”%s”>
<atom:link rel="self" href="%s"/>
<userGroup name="%s" />
...
</userGroups>
Failure Message

If not successful, returns an error message.

For additional information, refer to the schema file ./schemas/rbac/error.xsd.

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

Example: Get a list of user group names

# Request
GET /platform/ws/usergroups HTTP/1.1
Host: www.example.org
# Response
200 Successful
Content-Type: application/xml;
<userGroups total=”2”>
<atom:link rel="self" href="http://www.example.org/ws/usergroups"/>
<userGroup name="group0" />
<userGroup name="group1" />
</userGroups>