GET /groups/<sid>

Fetches information about a single user group identified by ID. Authentication is required.

Request format

When Forming RBAC API requests to this endpoint, provide authentication and specify a group ID, such as:

curl "https://$(puppet config print server):4433/rbac-api/v1/groups/<SID>" \
-H "X-Authentication:$(puppet-access show)"

To request information for multiple specific groups, use the GET /groups endpoint with the id parameter.

Response format

The response is a JSON object containing information about the requested group. For example:

{"id": "65a068a0-588a-11e4-8ed6-0800200c9a66",
"login": "hamsters",
"display_name": "Hamster club",
"role_ids": [2, 3],
"is_group" : true,
"is_remote" : true,
"is_superuser" : false,
"user_ids": ["07d9c8e0-5887-11e4-8ed6-0800200c9a66"]}

For information about keys in the response, refer to User groups endpoints keys.

Error responses

If the user who submits the GET request has not successfully authenticated, the endpoint returns a 401 Unauthorized response.

If the requesting user does not have the appropriate user permissions to request the group data, the endpoint returns a 403 Forbidden response.

For other error responses, refer to RBAC service errors .