Skip to content
Authrim

List policy condition types.

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

Return the condition types a policy rule may use (those the Check API can evaluate), with the parameter names rules must use, and their UI categories for the Admin policy builder.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Policy condition type metadata response.

Media type application/json
object
condition_types
required
Array<object>
object
type
required
string
category
required
string
label
required
string
description
required
string
params
required
Array<object>
object
name
required
string
type
required
string
required
required
boolean
label
required
string
key
additional properties
key
additional properties
categories
required
Array<object>
object
id
required
string
label
required
string
icon
required
string
key
additional properties
key
additional properties
Example generated
{
  "condition_types": [
    {
      "type": "example",
      "category": "example",
      "label": "example",
      "description": "example",
      "params": [
        {
          "name": "example",
          "type": "example",
          "required": true,
          "label": "example"
        }
      ]
    }
  ],
  "categories": [
    {
      "id": "example",
      "label": "example",
      "icon": "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"
}