List groups for the tenant

GET

/v1/groups

curl --request GET \
  --url 'https://example.com/v1/groups?limit=50&source=local' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Tenant-ID

required

string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Query Parameters

limit

integer

default: 50 <= 250

Maximum number of items to return.

cursor

string

Opaque pagination cursor from a previous response. Omit for the first page.

source

string

Allowed values: local scim

Filter groups by source.

Responses

200

OK

Media type application/json

object

data

required

Array<object>

object

id

required

string format: uuid

name

required

string

source

required

string

Allowed values: local scim

description

string

nullable

member_count

integer

role_mappings

Array<string>

created_at

required

string format: date-time

updated_at

required

string format: date-time

next_cursor

string

nullable

has_more

required

boolean

Example

{
  "data": [
    {
      "source": "local"
    }
  ]
}

401

Unauthenticated

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

403

Forbidden

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}