Sign in
BackendService

Update Organization

Update an Organization.

patch/v1/organizations/{id}

Path parameters

idstring required

The Organization ID.

Request body

idstring

The Organization ID. Starts with org_....

displayNamestring

A human-friendly name for the Organization.

createTimestring date-time

When the Organization was created.

updateTimestring date-time

When the Organization was last updated.

logInWithGoogleboolean

Whether the Organization supports "Log in with Google".

logInWithMicrosoftboolean

Whether the Organization supports "Log in with Microsoft".

logInWithGithubboolean

Whether the Organization supports Log in with GitHub.

logInWithEmailboolean

Whether the Organization supports "Log in with email".

logInWithPasswordboolean

Whether the Organization supports "Log in with password".

logInWithSamlboolean

Whether the Organization supports "Log in with SAML".

logInWithOidcboolean

Whether the Organization supports "Log in with OIDC".

logInWithAuthenticatorAppboolean

Whether the Organization supports authenticator apps as a secondary auth factor.

logInWithPasskeyboolean

Whether the Organization supports passkeys as a secondary auth factor.

requireMfaboolean

Whether the Organization requires a secondary auth factor.

scimEnabledboolean

Whether the Organization has SCIM enabled.

customRolesEnabledboolean

Whether the Organization's Users can create Organization-specific Roles.

apiKeysEnabledboolean

Whether API Keys are enabled for the Organization.

Response

OK

Changes

Changed in 6 of the 10 revisions of this API.52110

  • fe83f78ae20a2See the full diff
    • ○

      added the new optional request property logInWithOidc

      new-optional-request-property

    • ○

      added the optional property organization/allOf[Organization]/logInWithOidc to the response with the 200 status

      response-optional-property-added

  • 3ea9a7bcd4984See the full diff
    • ○

      added the new optional request property apiKeysEnabled

      new-optional-request-property

    • ○

      added the new optional request property logInWithGithub

      new-optional-request-property

    • ○

      added the optional property organization/allOf[Organization]/apiKeysEnabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property organization/allOf[Organization]/logInWithGithub to the response with the 200 status

      response-optional-property-added

  • 18208de692432See the full diff
    • ○

      added the new optional request property customRolesEnabled

      new-optional-request-property

    • ○

      added the optional property organization/allOf[Organization]/customRolesEnabled to the response with the 200 status

      response-optional-property-added

  • e3ac0347dfbe1131See the full diff
    • ▲

      the organization response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property organization/createTime from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/displayName from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/logInWithAuthenticatorApp from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/logInWithEmail from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/logInWithGoogle from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/logInWithMicrosoft from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/logInWithPasskey from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/logInWithPassword from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/logInWithSaml from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/requireMfa from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/scimEnabled from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property organization/updateTime from the response with the 200 status

      response-optional-property-removed

    • ○

      added Organization to the organization response property allOf list for the response status 200

      response-property-all-of-added

  • aae16339e1e148See the full diff
    • ▲

      the details/items/ response's property type/format changed from object/ to / for status 400

      response-property-type-changed

    • ▲

      the details/items/ response's property type/format changed from object/ to / for status 401

      response-property-type-changed

    • ▲

      the details/items/ response's property type/format changed from object/ to / for status 403

      response-property-type-changed

    • ▲

      the details/items/ response's property type/format changed from object/ to / for status 404

      response-property-type-changed

    • ●

      removed the optional property details/items/description from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property details/items/description from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property details/items/description from the response with the 403 status

      response-optional-property-removed

    • ●

      removed the optional property details/items/description from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property details/items/docsLink from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property details/items/docsLink from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property details/items/docsLink from the response with the 403 status

      response-optional-property-removed

    • ●

      removed the optional property details/items/docsLink from the response with the 404 status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b9fc18a0eac31See the full diff
    • ○

      endpoint added

      endpoint-added