Retrieve API Key Policy

GET 
/api-users/policy/

Responses

200

application/json

Schema

Schema

max_api_key_duration_days int64

Possible values: <= 4294967295

Sets the upper limit (in days) for how long an API key can be valid. This constraint is only active if 'enable_max_api_key_duration' is set to True.

enable_max_api_key_duration boolean

If enabled, the 'max_api_key_duration_days' setting will be enforced, limiting the validity period of created API keys.

disable_keys_on_user_disabled boolean

If enabled, all API keys created directly by a User (or by API users derived from them) will be automatically disabled when that user is disabled or deleted.

Example (from schema)

{
  "max_api_key_duration_days": 0,
  "enable_max_api_key_duration": true,
  "disable_keys_on_user_disabled": true
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...