For the complete documentation index, see llms.txt. This page is also available as Markdown.

Site permissions

Manage which members and teams can access or contribute to a docs site.

Invite, remove, or update users and teams permissions for a site. This provides a way to tightly control collaboration and visibility among your teammates.

Invite a user or a team to a site

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

siteIdstringRequired

The unique id of the site

Body

Responses

204

No content

404

No team or user with the provided Id

application/json

post/orgs/{organizationId}/sites/{siteId}/permissions

No content

List an org team's permission in a site

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

siteIdstringRequired

The unique id of the site

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

Listing of teams who have been added to a site.

application/json

404

No site was found with the given Id

application/json

get/orgs/{organizationId}/sites/{siteId}/permissions/teams

Remove an org team from a site

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

siteIdstringRequired

The unique id of the site

teamIdstringRequired

A unique entity identifier

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

Responses

204

The team was not found in the site

No content

205

The team has been removed from the site

delete/orgs/{organizationId}/sites/{siteId}/permissions/teams/{teamId}

No content

Update an org team's permission in a site

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

siteIdstringRequired

The unique id of the site

teamIdstringRequired

A unique entity identifier

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

Body

rolestring · enumOptional

"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

204

Team permission was updated

No content

404

No team found with the given ID

application/json

patch/orgs/{organizationId}/sites/{siteId}/permissions/teams/{teamId}

No content

Last updated 1 day ago

Was this helpful?