Get UI routing configuration

GET

/api/admin/settings/ui-routing

Code sample: Shell / cURL

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

Returns role path overrides and policy redirect rules used by the UI.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Current UI routing configuration.

Media type application/json

object

routing

object

rolePathOverrides

object

key

additional properties

object

key

additional properties

string

policyRedirects

Array<object>

object

key

additional properties

key

additional properties

key

additional properties

Example

{
  "routing": {
    "rolePathOverrides": {
      "support_admin": {
        "dashboard": "/admin/support"
      }
    },
    "policyRedirects": [
      {
        "conditions": [
          {
            "field": "mfa_required",
            "equals": true
          }
        ],
        "redirectPath": "/admin/security/mfa"
      }
    ]
  }
}

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