Get a single group | Unleash Documentation

{
  "name": "DX team",
  "id": 1,
  "description": "Current members of the DX squad",
  "mappingsSSO": [
    "SSOGroup1",
    "SSOGroup2"
  ],
  "rootRole": 1,
  "createdBy": "admin",
  "createdAt": "2023-06-30T11:41:00.123Z",
  "users": [
    {
      "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",
        "seatType": "Regular",
        "companyRole": "Developer",
        "productUpdatesEmailConsent": false,
        "activeSessions": 2,
        "deletedSessions": 1
      },
      "joinedAt": "2023-06-30T11:41:00.123Z",
      "createdBy": "admin"
    }
  ],
  "projects": [
    "default",
    "my-project"
  ],
  "userCount": 1,
  "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
}

Enterprise feature

Get a single user group by group id

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

groupIdstringRequired

Response

groupSchema

namestring

The name of the group

idintegerOptional

The group id

descriptionstring or nullOptional

A custom description of the group

mappingsSSOlist of stringsOptional

A list of SSO groups that should map to this Unleash group

rootRoledouble or nullOptional

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.

createdBystring or nullOptional

A user who created this group

createdAtstring or nullOptionalformat: "date-time"

When was this group created

userslist of objectsOptional

A list of users belonging to this group

projectslist of stringsOptional

A list of projects where this group is used

userCountintegerOptional>=0

The number of users that belong to this group

scimIdstring or nullOptional

The SCIM ID of the group, only present if managed by SCIM

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

$	curl https://app.unleash-instance.example.com/api/admin/groups/groupId \
>	-H "Authorization: <apiKey>"