---
title: "Retrieve an existing group"
method: GET
path: "/scim/v2/Groups/{group_id}"
tags: ["SCIM"]
---

# Retrieve an existing group

`GET /scim/v2/Groups/{group_id}`

## Request

- Base URL: `https://api.byndid.com`
- URL: `https://api.byndid.com/scim/v2/Groups/{group_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/docs/scim/v2/Groups/:group_id/get.ts> (a function with typed inputs; its response is checked against the schema)

To retrieve an existing group, send a GET request to `/Groups/$GROUP_ID`.
The response will contain a full representation of the Group resource matching
the specified identifier. Per [RFC-7644 §3.4.1](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.1),
the server will respond with HTTP status 200 and the resource if found, or 404 if not found.

Note that this method can be used to retrieve RBAC permission groups
as well as other groups created through the Admin Console.

## Path parameters

- `group_id` string, required

## Response `200`

Successfully returns the requested Group resource. As per [RFC-7643 §4.2](https://datatracker.ietf.org/doc/html/rfc7643#section-4.2),
the response includes:
- schemas: Array of schema identifiers
- id: Unique identifier for the Group
- displayName: Human-readable name of the Group
- members: Array of Group members (if any)
- meta: Resource metadata (lastModified, created, etc.)

- SCIMGroup: A group is a collection of users corresponding to [RFC 7643 Section 4.2](https://www.rfc-editor.org/rfc/rfc7643#section-4.2).
  - `schemas` string[], required: The list of schemas used to define the group. This must contain the core Group schema ("urn:ietf:params:scim:schemas:core:2.0:Group") and may include the custom Beyond Identity Group schema extension ("urn:scim:schemas:extension:byndid:1.0:Group").
  - `id` string, required: The unique ID of the group. This is automatically generated on creation. This field is immutable and output-only.
  - `displayName` string, required: The unique display name of the group. This name is used for display purposes.
  - `members` object[]: The list of the group's members.
    - `display` string: The display name of the group member, primarily used for display purposes.
    - `value` string: ID of the user resource corresponding to the group member. This field is immutable.
    - `$ref` string: The URI to another user resource that is a member of the group. This is field is only used for requests and is not returned on the response.
    - `type` string: The resource type of the group member. Currently, only users are supported as group members. This field is only used for requests and is not returned on the response. Specifying a group as a group member on a request is unsupported and will result in undefined behavior.
  - `urn:scim:schemas:extension:byndid:1.0:Group` object, required: The Beyond Identity Group schema extension.
    - `description` string, required: Description of the group.
  - `meta` Meta, required (unresolved $ref)

## Other responses

- `400`: Bad request. This could also be returned if the group is one of the RBAC permission groups. Please consult the error message for more details.
- `401`: Unauthorized.
- `404`: Returns 404 if: - The group was not found - The group exists but was created through the Admin Console Note that if the group is one of the RBAC permission groups, this method will return a 400 error instead.
- `429`: Rate limit exceeded.
- `500`: Server error.

---

[API](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api.md) - [All operations](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/revisions/562e14b2e4ba?raw)
