Skip to main content
GET
/
directories
/
status
Get directory status
curl --request GET \
  --url https://app.usechar.ai/api/directories/status \
  --header 'Authorization: Bearer <token>'
{
  "has_directory": true,
  "has_active_directory": true,
  "directory_count": 0,
  "active_directory": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "domain": "<string>",
    "user_count": 0,
    "group_count": 0
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.usechar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

WorkOS JWT token. Obtain via WorkOS AuthKit authentication flow. The token must include organization_id claim for organization-scoped endpoints.

Response

OK

SSO/SCIM connection status summary for an organization

​
has_directory
boolean
required

Whether any directory connections exist

​
has_active_directory
boolean
required

Whether an active directory connection exists

​
directory_count
integer
required

Total number of directory connections

Required range: -9007199254740991 <= x <= 9007199254740991
​
active_directory
object
required

Details of the active directory, if any