Set a user as an SSO member of an organization

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

userIdstringRequired

The unique ID of the User

Responses

200

The user has been added as an SSO member of the organization.

application/json

objectstring · enumRequired

Type of Object, always equals to "member"

Possible values:

idstringRequired

Unique identifier for the user.

rolestring · enum · nullableRequired

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

Possible values:

disabledbooleanRequired

Whatever the membership of this user is disabled and prevent them from accessing content.

joinedAtstring · date-timeRequired

Date at which the user joined the organization.

lastSeenAtstring · date-timeOptional

Date at which the user was last seen active in the organization.

ssobooleanRequired

Whether the user can login with SSO.

spacesnumberRequired

teamsnumberRequired

sitesnumberRequired

post/orgs/{organizationId}/members/{userId}/sso

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

200

The user has been added as an SSO member of the organization.

{
  "object": "member",
  "id": "text",
  "role": "admin",
  "user": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "disabled": true,
  "joinedAt": "2026-01-01T00:00:00.000Z",
  "lastSeenAt": "2026-01-01T00:00:00.000Z",
  "sso": true,
  "spaces": 1,
  "teams": 1,
  "sites": 1
}