Skip to content

Update general settings

PUT
/api/v1/admin/settings/general
Code sample: Shell / cURL
curl --request PUT \
--url http://localhost:9090/api/v1/admin/settings/general \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "appName": "example", "issuer": "example", "selfRegistrationEnabled": true, "selfRegistrationRequiresEmailVerification": true, "dynamicClientRegistrationEnabled": true, "passwordPolicy": "none", "pkceRequired": true, "implicitFlowEnabled": true, "resourceOwnerPasswordCredentialsEnabled": true, "accountDeletionEnabled": true }'

Update general system settings.

Media typeapplication/json
object
appName

The App name, required, at most 30 characters once surrounding spaces are removed, and without < or >. It is stored trimmed. A refusal is 400 with handler.settings_general.app_name_required, handler.settings_general.app_name_too_long or validator.settings.app_name_angle_brackets.

string
issuer

The issuer: surrounding spaces are removed, and it is stored that way. It is an https URL with no query, fragment or user info, or exactly the auth server’s base URL (GOIABADA_AUTHSERVER_BASEURL), whatever its scheme. A changed issuer outside that rule is refused with 400 handler.settings_general.issuer_uri_invalid, any issuer longer than 60 characters once its spaces are removed with 400 handler.settings_general.issuer_too_long, and one holding < or > with 400 validator.settings.issuer_angle_brackets.

string
selfRegistrationEnabled
boolean
selfRegistrationRequiresEmailVerification
boolean
dynamicClientRegistrationEnabled
boolean
passwordPolicy

The policy every new password is held to: none, at least 1 character; low, at least 6; medium, at least 8, with a lowercase letter, an uppercase letter and a number; high, at least 10, with a symbol too; nist, at least 15 characters of any kind, refusing a commonly used password (validator.password.too_common) and one too close to the account’s details or the app name (validator.password.too_close_to_account). Every policy accepts at most 72 bytes. Passwords already set are not checked again. Surrounding spaces are ignored, and any other value is refused with 400 handler.settings_general.password_policy_invalid.

string
Allowed values: none low medium high nist
pkceRequired

When true, confidential clients must use PKCE. Public clients always require PKCE regardless of this setting

boolean
implicitFlowEnabled

When true, allows the implicit flow (response_type=token, id_token, id_token token). Deprecated in OAuth 2.1

boolean
resourceOwnerPasswordCredentialsEnabled

When true, allows grant_type=password at the token endpoint (RFC 6749 section 4.3). Deprecated in OAuth 2.1

boolean
accountDeletionEnabled
required

When true, users can delete their own account from their account pages in the admin console. Administrators can delete any user either way. Required: a request without it, or with it null, is refused with 400 handler.settings_general.account_deletion_enabled_required.

boolean

Settings updated

Media typeapplication/json
object
appName
required
string
issuer
required
string
selfRegistrationEnabled
required
boolean
selfRegistrationRequiresEmailVerification
required
boolean
dynamicClientRegistrationEnabled
required
boolean
passwordPolicy
required

The policy every new password is held to. See UpdateSettingsGeneralRequest for the values.

string
Allowed values: none low medium high nist
pkceRequired
required

When true, confidential clients must use PKCE. Public clients always require PKCE regardless of this setting

boolean
implicitFlowEnabled
required

When true, the implicit flow is enabled server-wide. Deprecated in OAuth 2.1

boolean
resourceOwnerPasswordCredentialsEnabled
required

When true, grant_type=password is enabled server-wide (RFC 6749 section 4.3). Deprecated in OAuth 2.1

boolean
accountDeletionEnabled
required

When true, users can delete their own account from their account pages in the admin console. Administrators can delete any user either way.

boolean

Example

{
"passwordPolicy": "none"
}

Invalid request body or parameters

Media typeapplication/json

Admin/account API error envelope. Routing by HTTP status code: 4xx is a client-correctable failure (validation, not found, permission denied, rate limited); 5xx is a server-side problem. The body provides a stable error_code and an error_description for people to read. Protocol endpoints (/auth/token, /auth/authorize, /connect/register, /userinfo) use their RFC-defined error envelopes instead of this one.

object
error_code

Stable identifier for the failure. UPPER_SNAKE for legacy codes (e.g. VALIDATION_ERROR), dotted lowercase for codes named after the sentence’s catalog key (e.g. validator.email.required). Never translated, whatever the request’s language.

string
error_description
required

A sentence for people to read: in the request’s language, from the ui_locales query parameter or else the Accept-Language header, when the server has the sentence in that language, and in English otherwise. Route on error_code, not on this text.

string
error_field

A JSON Pointer (RFC 6901) to the member of the request body the refusal is about, such as /footerLinks/1/url, /footerLinks/0/labels/pt-BR or /palette/light/brand. Left out when the refusal names no member. It’s set by the refusals of a brand’s footer links, palette and custom CSS, and of an email template’s text and brandId.

string

Example generated

{
"error_code": "example",
"error_description": "example",
"error_field": "example"
}
WWW-Authenticate
string

Bearer challenge when token transport is malformed; ordinary validation errors omit it.

Missing or invalid access token (ACCESS_TOKEN_REQUIRED, INVALID_TOKEN), or a refused DPoP proof (INVALID_DPOP_PROOF)

Media typeapplication/json

Admin/account API error envelope. Routing by HTTP status code: 4xx is a client-correctable failure (validation, not found, permission denied, rate limited); 5xx is a server-side problem. The body provides a stable error_code and an error_description for people to read. Protocol endpoints (/auth/token, /auth/authorize, /connect/register, /userinfo) use their RFC-defined error envelopes instead of this one.

object
error_code

Stable identifier for the failure. UPPER_SNAKE for legacy codes (e.g. VALIDATION_ERROR), dotted lowercase for codes named after the sentence’s catalog key (e.g. validator.email.required). Never translated, whatever the request’s language.

string
error_description
required

A sentence for people to read: in the request’s language, from the ui_locales query parameter or else the Accept-Language header, when the server has the sentence in that language, and in English otherwise. Route on error_code, not on this text.

string
error_field

A JSON Pointer (RFC 6901) to the member of the request body the refusal is about, such as /footerLinks/1/url, /footerLinks/0/labels/pt-BR or /palette/light/brand. Left out when the refusal names no member. It’s set by the refusals of a brand’s footer links, palette and custom CSS, and of an email template’s text and brandId.

string

Example generated

{
"error_code": "example",
"error_description": "example",
"error_field": "example"
}
WWW-Authenticate
string

A Bearer challenge, then a DPoP challenge naming the accepted proof algorithms, on token refusals, the error in the challenge of the scheme the token was sent with: Bearer realm="goiabada", error="invalid_token", error_description="...", DPoP realm="goiabada", algs="ES256 ...". An operation may also return a handler-level 401 without this header.

The token is valid but does not authorise this request. A caller tells the refusals apart by error_code.

INSUFFICIENT_SCOPE comes from the route’s authorisation middleware, before the handler runs: an Admin operation needs one of the scopes its route names, and an Account operation needs authserver:manage-account.

USER_CONTEXT_REQUIRED comes from the same middleware on the Account operations, which also require the token to have been issued for a user: one obtained through the client credentials grant carries no auth_time claim and is refused here.

FORBIDDEN comes from the handler, on the account endpoints that resolve a resource by id and then check it belongs to the caller, so a valid token for the wrong user reaches this rather than a 404.

CLIENT_NOT_ALLOWED comes from the route on the two Account operations only the admin console’s own client may call, deleteAccount and exportAccount. ACCOUNT_DELETION_DISABLED comes from deleteAccount while an administrator has turned off Let users delete their own account.

MANAGE_SCOPE_REQUIRED comes from the handler, on the Admin operations the administrative policy guards. Only authserver:manage creates an administrator, changes one, or changes what reaches one, so no granular scope will ever be enough: the remedy is a token holding authserver:manage, not requesting the route’s scope as for INSUFFICIENT_SCOPE. An administrator is a user, group or client holding any of the six administrative permissions (manage, admin-read, manage-users, manage-clients, manage-settings, browser-sessions), a user directly or through any of its groups, the admin console’s own client whatever it holds, and a client allowed to request the administrative scopes. A granular scope is refused here when it:

  • grants or revokes an administrative permission, directly or by moving a user into or out of a group that holds one, or deletes such a group;
  • writes to an administrator user (profile, credentials, enabled, sessions, consents, attributes, memberships, permissions, deletion), an administrative group (settings, attributes, members, permissions, deletion), or an administrator client (settings, authentication, flows, redirect URIs, sign-out redirect URIs, back-channel logout, DPoP, web origins, token settings, permissions, introspection resources, logo, deletion);
  • switches whether a client may request the administrative scopes, on or off, on any client;
  • adds the authserver resource to a client’s introspection resources;
  • reads an administrator client’s secret, or reads or sets the secret of a client listed for the authserver resource among its introspection resources;
  • sets or changes a client’s back-channel logout URI;
  • changes the email or the audit-log settings;
  • changes an administrative permission’s description. Granular scopes still read administrators. The refusal is answered after the request’s 400 and 404, writes nothing, carries the insufficient_scope challenge of the scheme the token was sent with, such as WWW-Authenticate: Bearer realm="goiabada", error="insufficient_scope", error_description="...", scope="authserver:manage", and leaves an administrator_change_refused audit record.
Media typeapplication/json

Admin/account API error envelope. Routing by HTTP status code: 4xx is a client-correctable failure (validation, not found, permission denied, rate limited); 5xx is a server-side problem. The body provides a stable error_code and an error_description for people to read. Protocol endpoints (/auth/token, /auth/authorize, /connect/register, /userinfo) use their RFC-defined error envelopes instead of this one.

object
error_code

Stable identifier for the failure. UPPER_SNAKE for legacy codes (e.g. VALIDATION_ERROR), dotted lowercase for codes named after the sentence’s catalog key (e.g. validator.email.required). Never translated, whatever the request’s language.

string
error_description
required

A sentence for people to read: in the request’s language, from the ui_locales query parameter or else the Accept-Language header, when the server has the sentence in that language, and in English otherwise. Route on error_code, not on this text.

string
error_field

A JSON Pointer (RFC 6901) to the member of the request body the refusal is about, such as /footerLinks/1/url, /footerLinks/0/labels/pt-BR or /palette/light/brand. Left out when the refusal names no member. It’s set by the refusals of a brand’s footer links, palette and custom CSS, and of an email template’s text and brandId.

string

Example generated

{
"error_code": "example",
"error_description": "example",
"error_field": "example"
}
WWW-Authenticate
string

An insufficient_scope challenge in the scheme the token was sent with, Bearer or DPoP, on every refusal but FORBIDDEN and ACCOUNT_DELETION_DISABLED, which omit it.

The request failed inside the server, most often a storage error. error_code is INTERNAL_SERVER_ERROR: no detail about the failure, only the request id an operator can find the log line by, and retrying is reasonable. Key rotation’s 500 also answers KEY_SET_INCOMPLETE, which names its cause and no retry clears.

Media typeapplication/json

Admin/account API error envelope. Routing by HTTP status code: 4xx is a client-correctable failure (validation, not found, permission denied, rate limited); 5xx is a server-side problem. The body provides a stable error_code and an error_description for people to read. Protocol endpoints (/auth/token, /auth/authorize, /connect/register, /userinfo) use their RFC-defined error envelopes instead of this one.

object
error_code

Stable identifier for the failure. UPPER_SNAKE for legacy codes (e.g. VALIDATION_ERROR), dotted lowercase for codes named after the sentence’s catalog key (e.g. validator.email.required). Never translated, whatever the request’s language.

string
error_description
required

A sentence for people to read: in the request’s language, from the ui_locales query parameter or else the Accept-Language header, when the server has the sentence in that language, and in English otherwise. Route on error_code, not on this text.

string
error_field

A JSON Pointer (RFC 6901) to the member of the request body the refusal is about, such as /footerLinks/1/url, /footerLinks/0/labels/pt-BR or /palette/light/brand. Left out when the refusal names no member. It’s set by the refusals of a brand’s footer links, palette and custom CSS, and of an email template’s text and brandId.

string

Example generated

{
"error_code": "example",
"error_description": "example",
"error_field": "example"
}