New: AI Insights are here.
See what your users are asking.
Ctrlk
Pricing Log in Sign up
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Site auth

Manage the authentication needed for publishing your site.

Configure the credentials or tokens required to publish documentation externally. This helps ensure your site is consistently kept up to date.

The SitePublishingAuth object

Attributes
anyOptional
or
and

The SitePublishingAuth object

Available in MCP

Get the published content authentication configuration for a site

get

Retrieves the authentication settings that protect a site's published content. Use this to review the current auth method before making changes or troubleshooting access issues.

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

Responses
200

OK

application/json
anyOptional
or
and
get/orgs/{organizationId}/sites/{siteId}/publishing/auth
Available in MCP

Update the published content authentication configuration for a site

patch

Modifies the authentication method used to protect a site's published content. Use this to enable, disable, or change the auth method for a published site.

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
anyOptional
or
and
Responses
200

OK

application/json
anyOptional
or
and
patch/orgs/{organizationId}/sites/{siteId}/publishing/auth
Available in MCP

Regenerate the private key for a site's published content authentication

post

Re-generates the private key used for the site's publishing authentication (e.g., JWT signing key for SSO). Existing tokens signed with the old key will become invalid immediately. Use this to rotate credentials after a security incident or as part of a regular key rotation policy.

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

Responses
200

OK

application/json
anyOptional
or
and
post/orgs/{organizationId}/sites/{siteId}/publishing/auth/regenerate

Last updated

Was this helpful?

AltStyle によって変換されたページ (->オリジナル) /