Get UI configuration

GET

/api/admin/settings/ui-config

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/settings/ui-config \
  --header 'Authorization: Bearer <token>'

Returns UI base URL and path configuration with source, defaults, and metadata.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

UI configuration.

Media type application/json

object

config

object

baseUrl

string | null format: uri

paths

object

key

additional properties

string

key

additional properties

source

string

defaults

object

key

additional properties

string

metadata

object

key

additional properties

key

additional properties

Example

{
  "config": {
    "baseUrl": "https://auth.example.com",
    "paths": {
      "login": "/login",
      "signup": "/signup",
      "account": "/account"
    }
  },
  "source": {
    "baseUrl": "kv",
    "paths": "default"
  },
  "defaults": {
    "login": "/login",
    "signup": "/signup",
    "account": "/account"
  },
  "metadata": {
    "baseUrl": {
      "description": "UI base URL"
    },
    "paths": {
      "description": "UI paths"
    }
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}