Update Organization | SSOReady Docs

Updates an organization.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

ID of the organization to update.

Request

This endpoint expects an object.

idstringOptional

Unique identifier for this organization.

environmentIdstringOptional

The environment this organization belongs to.

displayNamestringOptional

An optional human-friendly name for this organization.

externalIdstringOptional

An identifier you can attach to an organization. Meant to be used to correlate an SSOReady organization to your internal equivalent concept. External IDs are unique within an environment. No two organizations in the same environment can have the same external ID.

domainslist of stringsOptional

A list of domains that users from this organization use.

SAML connections and SCIM directories within this organization will only produce users whose email are included in domains. SSOReady will reject SAML and SCIM users that do not fall within domains.

Response

organizationobject

The updated organization.

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

ID of the organization to update.

This endpoint expects an object.

Unique identifier for this organization.

The environment this organization belongs to.

An optional human-friendly name for this organization.

A list of domains that users from this organization use.

The updated organization.

$	curl -X PATCH https://api.ssoready.com/v1/organizations/id \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"organization": {
3	"id": "id",
4	"environmentId": "environmentId",
5	"displayName": "displayName",
6	"externalId": "externalId",
7	"domains": [
8	"domains"
9	]
10	}
11	}

$	curl -X PATCH https://api.ssoready.com/v1/organizations/id \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"organization": {
3	"id": "id",
4	"environmentId": "environmentId",
5	"displayName": "displayName",
6	"externalId": "externalId",
7	"domains": [
8	"domains"
9	]
10	}
11	}