Skip to main content
GET
/
directories
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "organization_id": "<string>",
  "workos_directory_id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "state": "<string>",
  "domain": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_count": 0,
  "group_count": 0
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource

Response

OK

Directory connection with synced user and group counts

​
id
string
required
​
organization_id
string
required
​
workos_directory_id
string
required
​
name
string
required
​
type
string
required
​
state
string
required
​
domain
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
user_count
integer
required

Number of users synced from this directory

Required range: -9007199254740991 <= x <= 9007199254740991
​
group_count
integer
required

Number of groups synced from this directory

Required range: -9007199254740991 <= x <= 9007199254740991