Update a SAML provider

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

samlProviderIdstringRequired

The unique id of the SAML provider

Body

labelstring · min: 1 · max: 30Optional

entityIDstring · max: 1024Optional

certificatestring · max: 10000Optional

ssoURLstring · uri · max: 2048Optional

defaultTeamstringOptional

defaultRolestring · enum · nullableOptional

The role of a member in an organization, null for guests

Possible values:

Responses

200

SAML provider has been updated

application/json

objectstring · enumRequired

Type of Object, always equals to "saml-provider"

Possible values:

idstringRequired

Unique identifier for the provider.

labelstring · min: 1 · max: 30Required

ssoURLstring · uri · max: 2048Required

entityIDstring · max: 1024Required

certificatestring · max: 10000Required

defaultRolestring · enum · nullableRequired

The role of a member in an organization, null for guests

Possible values:

createdAtstring · date-timeRequired

Date at which the provider was created.

statusstring · enumRequired

Status of the provider.

• active: The provider is active and can be used to authenticate users.
• pending: The provider is pending and is not yet fully configured.

Possible values:

patch/orgs/{organizationId}/saml/{samlProviderId}

PATCH /v1/orgs/{organizationId}/saml/{samlProviderId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "label": "text",
  "entityID": "text",
  "certificate": "text",
  "ssoURL": "https://example.com",
  "defaultTeam": "text",
  "defaultRole": "admin"
}

200

SAML provider has been updated

{
  "object": "saml-provider",
  "id": "text",
  "label": "text",
  "ssoURL": "https://example.com",
  "entityID": "text",
  "certificate": "text",
  "defaultTeam": {
    "object": "team",
    "id": "text",
    "title": "text",
    "members": 1,
    "spaces": 1,
    "createdAt": "2026-01-01T00:00:00.000Z",
    "permissions": {
      "admin": true,
      "view": true
    }
  },
  "defaultRole": "admin",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "status": "active",
  "service": {
    "acsURL": "https://example.com",
    "startURL": "https://example.com",
    "entityID": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}