Skip to content

Endpoint

  • Method: GET
  • Path: /admin/auth-settings
  • Edition: Core
  • Controller: AdminController@getAuthSettings
  • Route source: fluent-community/app/Http/Routes/api.php:108
  • Controller source: fluent-community/app/Http/Controllers/AdminController.php

GET Get Auth Settings

GET
/admin/auth-settings

Get Auth Settings for the FluentCommunity Admin API.

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

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Responses

Successful response

application/json
JSON
{
  
"settings": {
  
  
"login": {
  
  
  
"banner": {
  
  
  
  
"hidden": true,
  
  
  
  
"type": "string",
  
  
  
  
"position": "string",
  
  
  
  
"logo": "string",
  
  
  
  
"title": "string",
  
  
  
  
"description": "string",
  
  
  
  
"title_color": "string",
  
  
  
  
"text_color": "string",
  
  
  
  
"background_image": "string",
  
  
  
  
"background_color": "string"
  
  
  
},
  
  
  
"form": {
  
  
  
  
"type": "string",
  
  
  
  
"position": "string",
  
  
  
  
"title": "string",
  
  
  
  
"description": "string",
  
  
  
  
"title_color": "string",
  
  
  
  
"text_color": "string",
  
  
  
  
"button_label": "string",
  
  
  
  
"button_color": "string",
  
  
  
  
"button_label_color": "string",
  
  
  
  
"background_image": "string",
  
  
  
  
"background_color": "string"
  
  
  
}
  
  
},
  
  
"signup": {
  
  
  
"banner": {
  
  
  
  
"hidden": true,
  
  
  
  
"type": "string",
  
  
  
  
"position": "string",
  
  
  
  
"logo": "string",
  
  
  
  
"title": "string",
  
  
  
  
"description": "string",
  
  
  
  
"title_color": "string",
  
  
  
  
"text_color": "string",
  
  
  
  
"background_image": "string",
  
  
  
  
"background_color": "string"
  
  
  
},
  
  
  
"form": {
  
  
  
  
"type": "string",
  
  
  
  
"position": "string",
  
  
  
  
"title": "string",
  
  
  
  
"description": "string",
  
  
  
  
"button_label": "string",
  
  
  
  
"terms_label": "string",
  
  
  
  
"title_color": "string",
  
  
  
  
"text_color": "string",
  
  
  
  
"button_color": "string",
  
  
  
  
"button_label_color": "string",
  
  
  
  
"background_image": "string",
  
  
  
  
"background_color": "string",
  
  
  
  
"fields": {
  
  
  
  
  
"terms": {
  
  
  
  
  
  
"disabled": true,
  
  
  
  
  
  
"required": true,
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"label": "string",
  
  
  
  
  
  
"inline_label": "string"
  
  
  
  
  
}
  
  
  
  
}
  
  
  
}
  
  
}
  
}
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation