Replace the SCIM token of an identity provider connection

Creates a new SCIM token for a connection. The previous token stops working immediately, and the new 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_-]+$
idpConnectionIdstringRequired

The unique id of the identity provider connection

Responses
200

Token replaced

application/json

An identity provider connection, with the SCIM token the request created. The token can't be retrieved again.

tokenstringRequired

SCIM bearer token to configure in the identity provider.

post/orgs/{organizationId}/idp-connections/{idpConnectionId}/token
POST /v1/orgs/{organizationId}/idp-connections/{idpConnectionId}/token HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "connection": {
    "object": "idp-connection",
    "id": "text",
    "label": "text",
    "provider": "okta",
    "status": "pending",
    "defaultRole": "admin",
    "defaultTeam": {
      "object": "team",
      "id": "text",
      "title": "text",
      "members": 1,
      "spaces": 1,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "permissions": {
        "admin": true,
        "view": true
      }
    },
    "defaultTeamFromDomain": true,
    "saml": {
      "ssoURL": "https://example.com",
      "entityID": "text",
      "certificate": "text",
      "domains": [
        {
          "domain": "text",
          "status": "verified"
        }
      ],
      "service": {
        "acsURL": "https://example.com",
        "startURL": "https://example.com",
        "entityID": "text"
      },
      "lastUsedAt": "2026-01-01T00:00:00.000Z"
    },
    "scim": {
      "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"
}

Last updated

Was this helpful?

Powered by GitBook