Update a SCIM connection

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

scimConnectionIdstringRequired

The unique id of the SCIM connection

Body

labelstring · min: 1 · max: 100Required

Name of the SCIM connection, shown to organization admins.

Responses

200

SCIM connection updated

application/json

A SCIM connection through which an identity provider provisions organization members.

objectstring · enumRequired

The object type, which is always "scim-connection"

Possible values:

idstringRequired

Unique identifier of the SCIM connection

labelstring · min: 1 · max: 100Required

Name of the SCIM connection, shown to organization admins.

providerstring · enumRequired

Identity provider that provisions members through the SCIM connection.

Possible values:

baseURLstring · uri · max: 2048Required

SCIM base URL to configure in the identity provider

tokenHintstringRequired

Last characters of the current token, to identify it

tokenCreatedAtstring · date-timeRequired

Date the current token was created

lastUsedAtstring · date-timeOptional

Date of the last request authenticated with the token

createdAtstring · date-timeRequired

Date of creation

updatedAtstring · date-timeRequired

Date of the last update

400

Bad Request

application/json

404

Not Found

application/json

patch/orgs/{organizationId}/scim/connections/{scimConnectionId}

PATCH /v1/orgs/{organizationId}/scim/connections/{scimConnectionId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "label": "text"
}

{
  "object": "scim-connection",
  "id": "text",
  "label": "text",
  "provider": "okta",
  "baseURL": "https://example.com",
  "tokenHint": "text",
  "tokenCreatedAt": "2026-01-01T00:00:00.000Z",
  "lastUsedAt": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "urls": {
    "location": "https://example.com"
  }
}