Create a SCIM connection

Creates a SCIM connection and its token. The token is only returned in this response.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

Body

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:

Responses

201

SCIM connection created

application/json

A SCIM connection with its token, returned only when the token is created.

tokenstringRequired

Bearer token to configure in the identity provider. It can't be retrieved again.

400

Bad Request

application/json

404

Not Found

application/json

412

The organization has SAML providers configured.

application/json

post/orgs/{organizationId}/scim/connections

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

{
  "label": "text",
  "provider": "okta"
}

{
  "connection": {
    "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"
    }
  },
  "token": "text"
}