Skip to main content
POST
auth.directory.groups.sync

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

The end user who connected the directory administrator account.

Pattern: ^[A-Za-z0-9_.-]{1,128}$
app
enum<string>
required

Connected directory application key.

Available options:
google_admin,
microsoft_teams
groupRoleMap
object

Optional group-name to app-role suggestions; this call grants no permissions.

cursor
string

Opaque continuation from this same directory selection; expires after ten minutes.

Required string length: 1 - 128
limit
number

Maximum direct members in this page, 1 to 100; one group per page.

Required range: x >= 1

Response

The result

groups
object[]
required

One directory group and a page of its direct members, or an empty list.

complete
boolean
required

True only when there is no further page and no unmapped or nested member was encountered.

nextCursor
string

Continue the same snapshot traversal; append fragments of the same group.