Update the published content authentication configuration for a site

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.

Available in MCP

patch

Authorizations

useroauth

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

application/json

anyOptional

or

and

Responses

200

OK

application/json

anyOptional

or

and

400

Bad Request

application/json

patch/orgs/{organizationId}/sites/{siteId}/publishing/auth

HTTPcURLJavaScriptPython

PATCH /v1/orgs/{organizationId}/sites/{siteId}/publishing/auth HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "backend": "custom",
  "fallbackURL": null,
  "logoutURL": null
}

{
  "backend": "custom",
  "object": "publishing-auth",
  "privateKey": "text",
  "fallbackURL": "https://example.com",
  "logoutURL": "https://example.com",
  "integration": "text"
}