AccessTokenPayload

string

Decrypted payload of the access token (Base64-encoded).

Only present for APIs secured by IDP Introspection or IDP Client Credentials flow on the API Platform.

One of ‘X-Token’ or ‘X-SSL-Client-DER’ must be provided.

Example

RestrictionRootType

object
attributestring

Name of the attribute to be restricted, filtered or searched

Example:high

typestring

Type of the value to be searched. This is used to validate the transformation done in the backend once the list is received

Allowed values:integerdecimalstringboolean

Example:decimal

operatorstringrequired

Operator applied in the value comparision.

Allowed values:andor

Example:and

valuesarray[object]

List of restrictions to be applied with the operator in the attribute

Show Child Parameters
Example

RestrictionType

object
restrictionstring

Type of restriction to be set in the search, if applies

Allowed values:ltltegtgteeqtneqtlike

Example:lt

valuestring

Value of the filter or restriction done.

Example:2.3

Example

Error

object

Description of an error to help remediation.

messagestringrequired

A human-readable explanation specific to this error.

Example:Unauthorized

errorDetailobject

Additional information about the error.

Show Child Parameters
Example

ParameterLocation

string

The location of the invalid parameter.

Allowed values:BODYPATHQUERYHEADER