BackendService

Update SCIM API Key

Update a SCIM API Key.

patch/v1/scim-api-keys/{id}

Path parameters

idstring required

The SCIM API Key ID.

Request body

idstring

The SCIM API Key ID. Starts with scim_api_key_....

organizationIdstring

The Organization this SCIM API Key belongs to.

createTimestring date-time

When the SCIM API Key was created.

updateTimestring date-time

When the SCIM API Key was last updated.

displayNamestring

A human-readable display name for this SCIM API Key.

secretTokenstring

The secret token for this SCIM API Key.

revokedboolean

Whether this SCIM API Key is revoked.

Response

Changes

Changed in 3 of the 10 revisions of this API.5152

Mar 11, 2025e3ac0347dfbe171See the full diff
- ▲
  the scimApiKey response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ●
  removed the optional property scimApiKey/createTime from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property scimApiKey/displayName from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property scimApiKey/id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property scimApiKey/organizationId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property scimApiKey/revoked from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property scimApiKey/secretToken from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property scimApiKey/updateTime from the response with the 200 status
  response-optional-property-removed
- ○
  added SCIMAPIKey to the scimApiKey response property allOf list for the response status 200
  response-property-all-of-added
Mar 5, 2025aae16339e1e148See 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
Mar 4, 2025b9fc18a0eac31See the full diff
- ○
  endpoint added
  endpoint-added

Full history