SSO

Configure Single Sign-On solutions to unify your organization’s authentication.

Tie GitBook into your corporate identity management and authentication providers (like SAML or OAuth). This centralizes user authentication and improves security.

The Subdomain object

Attributes

objectstring · enumRequiredPossible values:

subdomainstring · min: 3 · max: 32Required

The GitBook subdomain, for example "my-company" in "my-company.gitbook.io"

Pattern: ^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$

targetone ofRequired

isActivebooleanRequired

The Subdomain object

{
  "object": "subdomain",
  "subdomain": "text",
  "target": {
    "type": "organization",
    "organization": "text"
  },
  "isActive": true
}

List all SAML providers

get

Lists SAML providers configured for the specified organization.

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/saml HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "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": "2025-05-05T12:16:23.306Z",
        "permissions": {
          "admin": true,
          "view": true
        }
      },
      "defaultRole": "admin",
      "createdAt": "2025-05-05T12:16:23.306Z",
      "service": {
        "acsURL": "https://example.com",
        "startURL": "https://example.com",
        "entityID": "text"
      },
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Create a new SAML provider

post

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

Body

labelstring · min: 1 · max: 30Required

entityIDstring · max: 1024Optional

certificatestring · max: 10000Optional

ssoURLstring · uri · max: 2048Optional

defaultTeamstringOptional

defaultRoleone ofOptional

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

string · enum | nullableOptional

"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.

Possible values:

Responses

201

SAML Provider created

application/json

post

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/saml 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"
}

201

SAML Provider created

{
  "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": "2025-05-05T12:16:23.306Z",
    "permissions": {
      "admin": true,
      "view": true
    }
  },
  "defaultRole": "admin",
  "createdAt": "2025-05-05T12:16:23.306Z",
  "service": {
    "acsURL": "https://example.com",
    "startURL": "https://example.com",
    "entityID": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

Get a SAML provider by its ID

get

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

samlProviderIdstringRequired

The unique id of the SAML provider

Responses

200

OK

application/json

404

No matching provider found

application/json

get

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/saml/{samlProviderId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2025-05-05T12:16:23.306Z",
    "permissions": {
      "admin": true,
      "view": true
    }
  },
  "defaultRole": "admin",
  "createdAt": "2025-05-05T12:16:23.306Z",
  "service": {
    "acsURL": "https://example.com",
    "startURL": "https://example.com",
    "entityID": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

Delete a SAML provider

delete

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

samlProviderIdstringRequired

The unique id of the SAML provider

Responses

204

SAML provider has been deleted

delete

HTTPcURLJavaScriptPython

DELETE /v1/orgs/{organizationId}/saml/{samlProviderId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

SAML provider has been deleted

No content

Update a SAML provider

patch

Authorizations

Path parameters

organizationIdstringRequired

The unique id of the organization

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

defaultRoleone ofOptional

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

string · enum | nullableOptional

"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.

Possible values:

Responses

200

SAML provider has been updated

application/json

patch

HTTPcURLJavaScriptPython

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": "2025-05-05T12:16:23.306Z",
    "permissions": {
      "admin": true,
      "view": true
    }
  },
  "defaultRole": "admin",
  "createdAt": "2025-05-05T12:16:23.306Z",
  "service": {
    "acsURL": "https://example.com",
    "startURL": "https://example.com",
    "entityID": "text"
  },
  "urls": {
    "location": "https://example.com"
  }
}

List all SSO provider login infos

get

Authorizations

useruser-internaluser-staffintegrationintegration-installation

Path parameters

organizationIdstringRequired

The unique id of the organization

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sso HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "items": [
    {
      "id": "text",
      "label": "text",
      "startURL": "https://example.com"
    }
  ]
}