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 Organizations

List Organizations

GET

https://api.ssoready.com/v1/organizations

GET

/v1/organizations

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

200Retrieved

1 {
2   "organizations": [
3     {
4       "id": "id",
5       "environmentId": "environmentId",
6       "displayName": "displayName",
7       "externalId": "externalId",
8       "domains": [
9         "domains"
10       ]
11     }
12   ],
13   "nextPageToken": "nextPageToken"
14 }

Gets a list of organizations.

Was this page helpful?

Create Organization

Built with

API Reference Management API Organizations

List Organizations

GET

https://api.ssoready.com/v1/organizations

GET

/v1/organizations

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

200Retrieved

1 {
2   "organizations": [
3     {
4       "id": "id",
5       "environmentId": "environmentId",
6       "displayName": "displayName",
7       "externalId": "externalId",
8       "domains": [
9         "domains"
10       ]
11     }
12   ],
13   "nextPageToken": "nextPageToken"
14 }

Gets a list of organizations.

Authentication

AuthorizationBearer

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

Query parameters

pageTokenstringOptional

Pagination token. Leave empty to get the first page of results.

Response

organizationslist of objects

List of organizations.

nextPageTokenstring

Value to use as pageToken for the next page of data. Empty if there is no more data.

Was this page helpful?

Create Organization

Built with

Authentication

AuthorizationBearer

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

Query parameters

pageTokenstringOptional

Pagination token. Leave empty to get the first page of results.

Response

organizationslist of objects

List of organizations.

nextPageTokenstring

Value to use as pageToken for the next page of data. Empty if there is no more data.

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

1	{
2	"organizations": [
3	{
4	"id": "id",
5	"environmentId": "environmentId",
6	"displayName": "displayName",
7	"externalId": "externalId",
8	"domains": [
9	"domains"
10	]
11	}
12	],
13	"nextPageToken": "nextPageToken"
14	}