API ReferenceManagementTenantsGroups
POST
/v1/mgmt/group/all

Load all external groups for a tenant, using a valid management key.

This API endpoint allows administrators to load all external groups that are associated to a tenant. The response contains an array of group objects including the group id, display name, and an array of associated members.

Next Steps

Administrators can review this information and make changes within their IdP or if necessary, Create a SCIM Group, Update an Existing SCIM Group (adding new members), or Delete an Existing SCIM Group

See also

  • See SSO Configuration for further details on managing SSO Configurations on a tenant.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/group/all

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

tenantIdstring

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/group/all" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "tenantId": "string"
}'

{
  "groups": [
    {
      "id": "string",
      "display": "string",
      "members": [
        {
          "loginId": "string",
          "userId": "string",
          "display": "string"
        }
      ]
    }
  ]
}

Was this helpful?

Previous

Group Management API Overview

Next

Load All External Groups for Specific Members