Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []
No Additional Items

Each item of this array must be:

Type: object

Parameter 2: options

options

Type: object

Default:

{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

No Additional Properties

Relationships

Type: boolean Default: true

Extend

Default: null

Type: string

Type: null

Extend Context

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Prefix

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Extra

Type: object Default: {}

Order By

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

Select

Type: array Default: []
No Additional Items

Each item of this array must be:

Any of

Option 1
Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

Count

Type: boolean Default: false

Get

Type: boolean Default: false

Offset

Type: integer Default: 0

Limit

Type: integer Default: 0

Force Sql Filters

Type: boolean Default: false

Result

Any of

Type: array of object
No Additional Items

Each item of this array must be:

ApiKeyQueryResultItem

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

Username

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

User Identifier

Any of

Option 1
Option 2

Type: integer

Type: string

Keyhash

Type: string

Created At

Type: stringFormat: date-time

Expires At

Any of

Option 1
Option 2

Type: stringFormat: date-time

Type: null

Local

Type: boolean

Revoked

Type: boolean

ApiKeyQueryResultItem

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string

Must be at least 1 characters long

Must be at most 200 characters long

Username

Any of

Option 1
Option 2

Type: string

Must be at least 1 characters long

User Identifier

Any of

Option 1
Option 2

Type: integer

Type: string

Keyhash

Type: string

Created At

Type: stringFormat: date-time

Expires At

Any of

Option 1
Option 2

Type: stringFormat: date-time

Type: null

Local

Type: boolean

Revoked

Type: boolean

Type: integer

Call parameters

Tuple Validation

Parameter 1: filters

filters

Each item of this array must be:

Parameter 2: options

options

relationships

Relationships

extend

Extend

Any of

extend_context

Extend Context

Any of

prefix

Prefix

Any of

extra

Extra

order_by

Order By

Each item of this array must be:

select

Select

Each item of this array must be:

Any of

Each item of this array must be:

count

Count

get

Get

offset

Offset

limit

Limit

force_sql_filters

Force Sql Filters

Return value

Result

Any of

Each item of this array must be:

ApiKeyQueryResultItem

id

Id

name

Name

username

Username

Any of

user_identifier

User Identifier

Any of

keyhash

Keyhash

created_at

Created At

expires_at

Expires At

Any of

local

Local

revoked

Revoked

ApiKeyQueryResultItem

id

Id

name

Name

username

Username

Any of

user_identifier

User Identifier

Any of

keyhash

Keyhash

created_at

Created At

expires_at