Retrieve registration settings
/settings/registrationReturns the registration settings of the account: public sign-up, domain restrictions, whether a document is required, and the highlight applied to users with free access.
The response includes an ETag representing the current revision. Send this value in the If-Match header when updating these settings to avoid overwriting a newer version.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/settings/registration"{ "data": { "defaults": {}, "document": { "required": true }, "domain_restriction": { "allowed": [ "string" ], "enabled": true }, "highlight_free": { "enabled": true, "icon": "string" }, "object": "settings", "propagation": {}, "public_signup": { "by_url": true, "enabled": true, "free_delivery_id": "string" }, "replica": {}, "revision": "string" }}Update authentication settings PATCH
Updates the authentication settings. Only the fields included in the request are changed: setting a field to `null` clears its configured value and restores the default, and omitted fields are left unchanged. Images are referenced by the ID of a file that belongs to the account. Secrets such as `recaptcha.secret` and `google_login.client_secret` are write-only. Changes take effect at the next login; active sessions are not terminated. To avoid overwriting a newer version, send the `ETag` returned by the retrieve operation in the `If-Match` header. The header is optional; when it is omitted, the update is applied to the current revision.
Update registration settings PATCH
Updates the registration settings. Only the fields included in the request are changed: setting a field to `null` clears its configured value and restores the default, and omitted fields are left unchanged. To avoid overwriting a newer version, send the `ETag` returned by the retrieve operation in the `If-Match` header. The header is optional; when it is omitted, the update is applied to the current revision.