コンテンツにスキップ
Authrim

Update UI routing configuration

PUT
/api/admin/settings/ui-routing
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/settings/ui-routing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "rolePathOverrides": { "support_admin": { "dashboard": "/admin/support", "users": "/admin/users" } }, "policyRedirects": [ { "conditions": [ { "field": "mfa_required", "equals": true } ], "redirectPath": "/admin/security/mfa" } ] }'

Updates role path overrides and policy redirect rules used by the admin UI. Values are merged into the current system settings and audit logged.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

Role-specific UI path overrides and policy redirect rules.

Media type application/json
object
rolePathOverrides
object
key
additional properties
object
key
additional properties
string
policyRedirects
Array<object>
object
conditions
required
Array<object>
object
key
additional properties
redirectPath
required
string
key
additional properties
key
additional properties
Example 
{
  "rolePathOverrides": {
    "support_admin": {
      "dashboard": "/admin/support",
      "users": "/admin/users"
    }
  },
  "policyRedirects": [
    {
      "conditions": [
        {
          "field": "mfa_required",
          "equals": true
        }
      ],
      "redirectPath": "/admin/security/mfa"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated UI routing configuration.

Media type application/json
object
success
boolean
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 
{
  "success": true,
  "routing": {
    "rolePathOverrides": {
      "support_admin": {
        "dashboard": "/admin/support",
        "users": "/admin/users"
      }
    },
    "policyRedirects": [
      {
        "conditions": [
          {
            "field": "mfa_required",
            "equals": true
          }
        ],
        "redirectPath": "/admin/security/mfa"
      }
    ]
  }
}

400

Section titled “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

Section titled “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

Section titled “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"
}