Skip to content

Normalises and stores the login and signup configuration, then returns it with the recalculated form field definitions.

The payload is passed through the auth settings formatter, so unrecognised keys are dropped and each field is coerced to its expected shape. The saved settings are also written to a week-long cache used by the front-end auth screens.

Endpoint

  • Method: POST

  • Path: /admin/auth-settings

  • Edition: PRO

  • Controller: ProAdminController@saveAuthSettings

  • Route source: fluent-community-pro/app/Http/Routes/api.php:15

  • Controller source: fluent-community-pro/app/Http/Controllers/ProAdminController.php

  • Requires the FluentCommunity community-admin permission (or a WordPress super admin).

  • Requires FluentCommunity Pro.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

POST Save Auth Settings

POST
/admin/auth-settings

Normalises and stores the login and signup configuration, then returns it with the recalculated form field definitions.

Controller: ProAdminController@saveAuthSettings
Route source: fluent-community-pro/app/Http/Routes/api.php:15

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Request Body

application/json
JSON
{
  
"settings": {
  
}
}

Responses

Successful response

application/json
JSON
{
  
"message": "string",
  
"settings": {
  
  
"login": {
  
  
  
"banner": {
  
  
  
  
"background_color": "string",
  
  
  
  
"background_image": "string",
  
  
  
  
"description": "string",
  
  
  
  
"description_rendered": "string",
  
  
  
  
"hidden": true,
  
  
  
  
"logo": "string",
  
  
  
  
"position": "string",
  
  
  
  
"text_color": "string",
  
  
  
  
"title": "string",
  
  
  
  
"title_color": "string",
  
  
  
  
"type": "string"
  
  
  
},
  
  
  
"form": {
  
  
  
  
"background_color": "string",
  
  
  
  
"background_image": "string",
  
  
  
  
"button_color": "string",
  
  
  
  
"button_label": "string",
  
  
  
  
"button_label_color": "string",
  
  
  
  
"description": "string",
  
  
  
  
"description_rendered": "string",
  
  
  
  
"fields": {
  
  
  
  
  
"password": {
  
  
  
  
  
  
"label": "string",
  
  
  
  
  
  
"placeholder": "string",
  
  
  
  
  
  
"required": true,
  
  
  
  
  
  
"sanitize_callback": "string",
  
  
  
  
  
  
"type": "string"
  
  
  
  
  
},
  
  
  
  
  
"username": {
  
  
  
  
  
  
"label": "string",
  
  
  
  
  
  
"placeholder": "string",
  
  
  
  
  
  
"required": true,
  
  
  
  
  
  
"sanitize_callback": "string",
  
  
  
  
  
  
"type": "string"
  
  
  
  
  
}
  
  
  
  
},
  
  
  
  
"hidden": true,
  
  
  
  
"position": "string",
  
  
  
  
"text_color": "string",
  
  
  
  
"title": "string",
  
  
  
  
"title_color": "string",
  
  
  
  
"type": "string"
  
  
  
}
  
  
},
  
  
"signup": {
  
  
  
"banner": {
  
  
  
  
"background_color": "string",
  
  
  
  
"background_image": "string",
  
  
  
  
"description": "string",
  
  
  
  
"description_rendered": "string",
  
  
  
  
"hidden": true,
  
  
  
  
"logo": "string",
  
  
  
  
"position": "string",
  
  
  
  
"text_color": "string",
  
  
  
  
"title": "string",
  
  
  
  
"title_color": "string",
  
  
  
  
"type": "string"
  
  
  
},
  
  
  
"form": {
  
  
  
  
"background_color": "string",
  
  
  
  
"background_image": "string",
  
  
  
  
"button_color": "string",
  
  
  
  
"button_label": "string",
  
  
  
  
"button_label_color": "string",
  
  
  
  
"description": "string",
  
  
  
  
"description_rendered": "string",
  
  
  
  
"fields": {
  
  
  
  
  
"__truncated__": "string",
  
  
  
  
  
"email": {
  
  
  
  
  
  
"label": "string",
  
  
  
  
  
  
"placeholder": "string",
  
  
  
  
  
  
"readonly": true,
  
  
  
  
  
  
"required": true,
  
  
  
  
  
  
"sanitize_callback": "string",
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
},
  
  
  
  
  
"full_name": {
  
  
  
  
  
  
"label": "string",
  
  
  
  
  
  
"placeholder": "string",
  
  
  
  
  
  
"required": true,
  
  
  
  
  
  
"sanitize_callback": "string",
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
}
  
  
  
  
},
  
  
  
  
"hidden": true,
  
  
  
  
"position": "string",
  
  
  
  
"text_color": "string",
  
  
  
  
"title": "string",
  
  
  
  
"title_color": "string",
  
  
  
  
"type": "string"
  
  
  
}
  
  
}
  
}
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation