Skip to content
Authrim

List policy flags

GET
/api/admin/settings/policy-flags
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/settings/policy-flags \
  --header 'Authorization: Bearer <token>'

Returns policy flag values from AUTHRIM_CONFIG with default metadata.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Policy flags with source metadata.

Media type application/json
object
flags
object
key
additional properties
object
value
string | null
source
string
Allowed values: kv default
default
metadata

Policy flag metadata.

object
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "flags": {
    "enable_dynamic_policy": {
      "value": "true",
      "source": "kv",
      "default": false,
      "metadata": {
        "type": "boolean",
        "description": "Enable dynamic policy evaluation"
      }
    },
    "max_policy_rules": {
      "value": null,
      "source": "default",
      "default": 100,
      "metadata": {
        "type": "number",
        "min": 1,
        "max": 1000
      }
    }
  }
}

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

404

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

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