Skip to content
Authrim

Create a consent policy.

POST
/api/admin/consent-policies
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/consent-policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "description": "example", "is_active": true }'

Creates a reusable consent policy set for the tenant.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
display_name
required
string
description
string
is_active
boolean
Example generated
{
  "display_name": "example",
  "description": "example",
  "is_active": true
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created consent policy.

Media type application/json
object
policy
required
object
Example generated
{
  "policy": {}
}

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

409

Section titled “409 ”

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