GitBook Site Users API

openapi: 3.2.0
info:
  title: GitBook Site Users API
  description: The GitBook API
  termsOfService: https://policies.gitbook.com
  contact:
    name: API Support
    url: https://gitbook.com/support
    email: support@gitbook.com
  version: 0.0.1-beta
servers:
- url: '{host}/v1'
  variables:
    host:
      default: https://api.gitbook.com
security:
- user: []
- user-internal: []
- user-staff: []
- integration: []
- integration-installation: []
tags:
- name: site-users
paths:
  /orgs/{organizationId}/sites/{siteId}/permissions/aggregate:
    get:
      operationId: listPermissionsAggregateInSite
      summary: List all sites users permissions
      tags:
      - site-users
      security:
      - user: []
      - oauth:
        - site:permissions:read
      parameters:
      - $ref: '#/components/parameters/organizationId'
      - $ref: '#/components/parameters/siteId'
      - $ref: '#/components/parameters/listPage'
      - $ref: '#/components/parameters/listLimit'
      - $ref: '#/components/parameters/listOrder'
      - $ref: '#/components/parameters/memberRoleFilter'
      - $ref: '#/components/parameters/memberSearch'
      - $ref: '#/components/parameters/memberSort'
      - name: team
        in: query
        description: Team identifier. Filter the list to members of a specific team.
        schema:
          type: string
      responses:
        '200':
          description: Listing of users who can access the site.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/List'
                - type: object
                  required:
                  - items
                  - membersCount
                  properties:
                    membersCount:
                      type: integer
                      minimum: 0
                      description: Number of users with a role in the site, guests excluded. It ignores the filters and the pagination of the request.
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/UserSitePermission'
  /orgs/{organizationId}/sites/{siteId}/permissions/users:
    get:
      operationId: listUserPermissionsInSite
      summary: List site user permissions
      tags:
      - site-users
      security:
      - user: []
      - oauth:
        - site:permissions:read
      parameters:
      - $ref: '#/components/parameters/organizationId'
      - $ref: '#/components/parameters/siteId'
      - $ref: '#/components/parameters/listPage'
      - $ref: '#/components/parameters/listLimit'
      responses:
        '200':
          description: Listing of users who have been added to a site.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/List'
                - type: object
                  required:
                  - items
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/UserSitePermissionOverride'
        '404':
          description: No site was found with the given Id
          $ref: '#/components/responses/NotFoundError'
  /orgs/{organizationId}/sites/{siteId}/permissions/users/{userId}:
    patch:
      operationId: updateUserPermissionInSite
      summary: Update site user permissions
      tags:
      - site-users
      security:
      - user: []
      - oauth:
        - site:permissions:write
      parameters:
      - $ref: '#/components/parameters/organizationId'
      - $ref: '#/components/parameters/siteId'
      - $ref: '#/components/parameters/userId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                role:
                  $ref: '#/components/schemas/MemberRole'
      responses:
        '204':
          description: User permission was updated
        '404':
          description: No user found with the given ID
          $ref: '#/components/responses/NotFoundError'
    delete:
      operationId: removeUserFromSite
      summary: Remove a site user
      tags:
      - site-users
      security:
      - user: []
      - oauth:
        - site:permissions:write
      parameters:
      - $ref: '#/components/parameters/organizationId'
      - $ref: '#/components/parameters/siteId'
      - $ref: '#/components/parameters/userId'
      responses:
        '204':
          description: The user was not found in the site
        '205':
          description: The user has been removed from the site
components:
  schemas:
    UserSitePermissionOverride:
      type: object
      description: Permission override of a user in a site.
      properties:
        permission:
          $ref: '#/components/schemas/MemberRoleOrGuest'
        user:
          $ref: '#/components/schemas/User'
      required:
      - permission
      - user
    MemberRoleOrGuest:
      description: The role of a member in an organization, null for guests
      oneOf:
      - $ref: '#/components/schemas/MemberRole'
      - type: 'null'
    OrganizationPointer:
      type: object
      properties:
        type:
          type: string
          enum:
          - organization
        organization:
          type: string
          description: Unique identifier for the organization
      required:
      - type
      - organization
    UserSitePermission:
      type: object
      description: Permission of a user in a site.
      properties:
        permission:
          $ref: '#/components/schemas/MemberRoleOrGuest'
        user:
          $ref: '#/components/schemas/User'
        origin:
          $ref: '#/components/schemas/UserSitePermissionOrigin'
        disabled:
          type: boolean
          description: Whether the user is disabled
        lastSeenAt:
          description: Date at which the user was last seen
          $ref: '#/components/schemas/Timestamp'
      required:
      - permission
      - user
      - origin
      - disabled
    SpacePointer:
      type: object
      properties:
        type:
          type: string
          enum:
          - space
        space:
          type: string
          description: Unique identifier for the space
      required:
      - type
      - space
    MemberRole:
      type: string
      description: '"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.

        '
      enum:
      - admin
      - create
      - edit
      - review
      - comment
      - read
    UserSitePermissionSiteOrigin:
      type: object
      description: Direct site permission origin.
      properties:
        type:
          type: string
          enum:
          - site
        site:
          type: string
          description: Unique identifier for the site
        reason:
          type: string
          description: Why the permission was enforced at the site level.
          enum:
          - member
          - team
          - default
        team:
          type: string
          description: Unique identifier for the team when the permission comes from a team override.
      required:
      - type
      - site
      - reason
    Timestamp:
      type: string
      format: date-time
    UserSitePermissionOrigin:
      description: The origin that enforced the effective permission level for a user in a site.
      oneOf:
      - $ref: '#/components/schemas/SpacePointer'
      - $ref: '#/components/schemas/OrganizationPointer'
      - $ref: '#/components/schemas/UserSitePermissionSiteOrigin'
    EntityId:
      type: string
      pattern: ^[a-zA-Z0-9_-]+$
      description: A unique entity identifier
    User:
      type: object
      properties:
        object:
          type: string
          description: Type of Object, always equals to "user"
          enum:
          - user
        id:
          type: string
          description: Unique identifier for the user
        displayName:
          type: string
          description: Full name for the user
        email:
          type: string
          description: Email address of the user
        photoURL:
          type: string
          description: URL of the user's profile picture
        urls:
          type: object
          description: URLs associated with the object
          properties:
            location:
              type: string
              description: URL of the user in the API
              format: uri
          required:
          - location
      required:
      - object
      - id
      - displayName
      - urls
    List:
      type: object
      properties:
        next:
          type: object
          properties:
            page:
              type: string
              description: Unique identifier to query the next results page
          required:
          - page
        count:
          type: number
          description: Total count of objects in the list
  parameters:
    memberSearch:
      name: search
      in: query
      description: A query to filter the list by display name and email
      schema:
        type: string
    listLimit:
      name: limit
      in: query
      description: The number of results per page
      schema:
        type: number
        minimum: 0
        maximum: 1000
    siteId:
      name: siteId
      in: path
      required: true
      description: The unique id of the site
      schema:
        type: string
    listOrder:
      name: order
      in: query
      description: An order for the items in the list
      schema:
        type: string
        default: desc
        enum:
        - asc
        - desc
    memberSort:
      name: sort
      in: query
      description: The property to sort the list by
      schema:
        type: string
        default: joinedAt
        enum:
        - joinedAt
        - lastSeenAt
        - name
    listPage:
      name: page
      in: query
      description: Identifier of the page results to fetch.
      schema:
        type: string
    memberRoleFilter:
      name: role
      in: query
      description: The role to filter the list by
      schema:
        oneOf:
        - $ref: '#/components/schemas/MemberRole'
        - type: string
          enum:
          - guest
    userId:
      name: userId
      in: path
      required: true
      description: The unique ID of the User
      schema:
        type: string
    organizationId:
      name: organizationId
      in: path
      required: true
      description: The unique id of the organization
      schema:
        $ref: '#/components/schemas/EntityId'
  responses:
    NotFoundError:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    enum:
                    - 404
                  message:
                    type: string
                required:
                - code
                - message
  securitySchemes:
    user:
      type: http
      scheme: bearer
    user-internal:
      type: http
      scheme: bearer
    user-staff:
      type: http
      scheme: bearer
    integration:
      type: http
      scheme: bearer
    integration-installation:
      type: http
      scheme: bearer
    oauth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://oauth.gitbook.com/authorize
          tokenUrl: https://oauth.gitbook.com/token
          scopes:
            user:read: Read your GitBook user profile.
            organization:read: Read the organizations you belong to, their settings and metadata, and their AI agent conversations.
            organization:write: Create organizations, and update organization settings and AI agent conversations.
            organization:members:read: Read organization members, teams, invites and link invites.
            organization:members:write: Manage organization members, teams, invites and link invites.
            organization:ask: Ask AI questions across an organization's content.
            organization:search: Search across an organization's content.
            space:read: Read spaces and their content, including pages, change requests and their reviews, comments, files and revision history.
            space:write: Create, update and delete spaces and their content, including change requests (create, edit, review), comments, and content imports and exports. Merging a change request also requires change-request:merge.
            space:permissions:read: Read the users and teams who have access to spaces and collections.
            space:permissions:write: Manage who has access to spaces and collections, including inviting users and teams.
            change-request:merge: Merge change requests, publishing their changes to the space. Creating, editing and reviewing change requests only requires space:write.
            site:read: Read sites and their settings, including navigation structure, linked spaces, customization, redirects, topics, AI configuration and documentation issues.
            site:write: Create, update and delete sites and their settings, including navigation structure (sections, linked spaces, external links), customization, redirects, topics and AI configuration.
            site:publish: Publish and unpublish sites, controlling their public exposure.
            site:permissions:read: Read the users and teams who have access to sites.
            site:permissions:write: Manage who has access to sites, including inviting users and teams.
            site:auth:read: Read how visitors authenticate on a site and its security configuration, including private share links.
            site:auth:write: Manage how visitors authenticate on a site and its security configuration, including private share links.
            site:insights:read: Read site analytics and insights, including the questions visitors asked Ask AI and the answers they received.
            site:ask: Ask AI questions across a site's content.
            site:search: Search across a site's content.
            integration:read: Read integrations, their status and where they are installed.
            integration:installations:read: Read integration installations and their configuration, which can include credentials for third-party services.
            integration:installations:write: Install and configure integrations on an organization, its spaces and its sites.
            integration:publish: Publish integrations, which can request their own permissions on your content, and route their events to a development tunnel.
            integration:delete: Unpublish integrations, permanently deleting them and every installation of them.
            openapi:read: Read OpenAPI specifications.
            openapi:write: Create, update and delete OpenAPI specifications.
x-provenance:
  method: harvested
  publisher: GitBook
  source: https://api.gitbook.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)