SSOReadyService

PATCH /v1/organizations/{id}

Changed on

Updates an organization.

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

idstring required

ID of the organization to update.

Request body

idstring

Unique identifier for this organization.

environmentIdstring

The environment this organization belongs to.

displayNamestring

An optional human-friendly name for this organization.

externalIdstring

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.

domainsstring[]

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

OK

Changes

    • info

      added the new optional request property

    • info

      added the optional property ///// to the response with the status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status