Returns the login and signup configuration together with the resolved form field definitions the auth screens render.

Endpoint

• Method: GET

• Path: /admin/auth-settings

• Edition: Core

• Controller: AdminController@getAuthSettings

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

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

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

• Reading is available in core, but saving these settings is a Pro endpoint.

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.

GET Get Auth Settings

GET

/admin/auth-settings

Returns the login and signup configuration together with the resolved form field definitions the auth screens render.

Controller: AdminController@getAuthSettings
Route source: fluent-community/app/Http/Routes/api.php:112

Authorizations

ApplicationPasswords

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

Type

API Key (header: Authorization)

Responses

Successful response

Content-Type

application/json

{

  

"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"

  

  

  

}

  

  

}

  

}

}

GET

/admin/auth-settings

Playground

Authorization

ApplicationPasswords

Samples

Powered by VitePress OpenAPI