---
title: "PATCH /v1/organizations/{id}"
method: PATCH
path: "/v1/organizations/{id}"
tags: ["SSOReadyService"]
---

# PATCH /v1/organizations/{id}

`PATCH /v1/organizations/{id}`

Updates an organization.

## Path parameters

- `id` string, required

## Request body

- Organization
  - `id` string — Unique identifier for this organization.
  - `environmentId` string — The environment this organization belongs to.
  - `displayName` string — An optional human-friendly name for this organization.
  - `externalId` string — 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.
  - `domains` string[] — 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 `200`

OK

- UpdateOrganizationResponse
  - `organization` Organization
    - `id` string — Unique identifier for this organization.
    - `environmentId` string — The environment this organization belongs to.
    - `displayName` string — An optional human-friendly name for this organization.
    - `externalId` string — 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.
    - `domains` string[] — 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`.

## Other responses

- `default` — Default error response

## Changes

- **2024-10-15** `0827d713f08e` — 2 info
  - added the new optional request property `displayName`
  - added the optional property `organization/allOf[#/components/schemas/Organization]/displayName` to the response with the `200` status
- **2024-08-17** `9a895b843207` — 1 breaking, 4 warning, 1 info
  - the `organization` response's property type/format changed from `object`/`` to ``/`` for status `200`
  - removed the optional property `organization/domains` from the response with the `200` status
  - removed the optional property `organization/environmentId` from the response with the `200` status
  - removed the optional property `organization/externalId` from the response with the `200` status
  - …2 more
- **2024-08-16** `132245ed6de0` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/ssoready/apis/ssoreadyservice-api/changes/v1/organizations/:id/patch.md)

---

[API](https://skmtc.dev/ssoready/apis/ssoreadyservice-api.md) · [All operations](https://skmtc.dev/ssoready/apis/ssoreadyservice-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ssoready/ssoreadyservice-api/revisions/0827d713f08e/schema)