Get a single group
GET <your-unleash-url>/api/admin/groups/:groupId
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Get a single user group by group id
Request
Path Parameters
- groupId string required
- 200
- 400
- 401
- 403
- 404
groupSchema
- application/json
- Schema
- Example (from schema)
Schema
- id integer
The group id
- name string required
The name of the group
- description string nullable
A custom description of the group
- mappingsSSO string[]
A list of SSO groups that should map to this Unleash group
- rootRole number nullable
A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.
- createdBy string nullable
A user who created this group
- createdAt date-time nullable
When was this group created
users object[]
- projects string[]
A list of projects where this group is used
- userCount integer
The number of users that belong to this group
- scimId string nullable
The SCIM ID of the group, only present if managed by SCIM
{
"id": 1,
"name": "DX team",
"description": "Current members of the DX squad",
"mappingsSSO": [
"SSOGroup1",
"SSOGroup2"
],
"rootRole": 1,
"createdBy": "admin",
"createdAt": "2023-06-30T11:41:00.123Z",
"users": [
{
"joinedAt": "2023-06-30T11:41:00.123Z",
"createdBy": "admin",
"user": {
"id": 123,
"name": "User",
"email": "user@example.com",
"username": "hunter",
"imageUrl": "https://example.com/242x200.png",
"inviteLink": "http://localhost:4242/invite-link/some-secret",
"loginAttempts": 3,
"emailSent": false,
"rootRole": 1,
"seenAt": "2023-06-30T11:42:00.345Z",
"createdAt": "2023-06-30T11:41:00.123Z",
"accountType": "User",
"permissions": [
"string"
],
"scimId": "01HTMEXAMPLESCIMID7SWWGHN6"
}
}
],
"projects": [
"default",
"my-project"
],
"userCount": 1,
"scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
}
The request data does not match what we expect.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "ValidationError",
"message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}
Authorization information is missing or invalid. Provide a valid API token as the authorization
header, e.g. authorization:*.*.my-admin-token
.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "AuthenticationRequired",
"message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}
The requested resource was not found.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Request
Request
curl -L -X GET '<your-unleash-url>/api/admin/groups/:groupId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/groups/:groupId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/groups/:groupId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/groups/:groupId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/groups/:groupId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/groups/:groupId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/groups/:groupId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/groups/:groupId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/groups/:groupId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'