For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

- Introduction
SAML (Enterprise SSO)
SCIM (Enterprise Directory Sync)
- SCIM Quickstart
SDKs
SAML-over-OAuth
- SAML over OAuth (SAML NextAuth.js integration)
- SAML for Firebase
IDP configuration
- Enabling self-service configuration for your customers
SSOReady concepts
Management API
- Management API
DummyIDP
- Testing SAML/SCIM with DummyIDP
Self-Hosting
- Self-Hosting SSOReady
API Reference

API Reference Management API Scim Directories

Get SCIM Directory

GET

https://api.ssoready.com/v1/scim-directories/:id

GET

/v1/scim-directories/:id

$ curl https://api.ssoready.com/v1/scim-directories/id \
>      -H "Authorization: Bearer <apiKey>"

200Retrieved

1 {
2   "scimDirectory": {
3     "id": "id",
4     "organizationId": "organizationId",
5     "primary": true,
6     "scimBaseUrl": "scimBaseUrl",
7     "hasClientBearerToken": true
8   }
9 }

Gets a SCIM directory.

Was this page helpful?

Update SCIM Directory

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The ID of the SCIM directory.

Response

OK

scimDirectoryobject

The requested SCIM directory.