kerberos.realm.query

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

 No Additional Items
Each item of this array must be:
Type: object

Examples:

[
    [
        "name",
        "=",
        "bob"
    ]
]

[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]
Parameter 2: options

options

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

Query options customize the results returned by a query method. More complete documentation with examples
are covered in the "Query methods" section of the TrueNAS API documentation.

No Additional Properties

Relationships

Type: boolean Default: true

Extend

Default: null

Type: string
Type: null

Extend Fk

Type: array of string Default: []
No Additional Items
Each item of this array must be:
Type: string

Extend Context

Default: null

Type: string
Type: null

Prefix

Default: null

Type: string
Type: null

Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated
query method.

Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may
also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place
any null values at the head of the results list), nulls_last: (place any null values at the tail of the
results list).

No Additional Items
Each item of this array must be:
Type: string

Example:

[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]

Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character .
may be used to explicitly select only subkeys of the query result.

No Additional Items
Each item of this array must be:

Type: string
Type: array
No Additional Items
Each item of this array must be:
Type: object

Example:

[
    "username",
    "Authentication.status"
]

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified query-filters. The query fails
if there specified query-filters return no results.

Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the limit query-option
it may be used to implement pagination of large results arrays. WARNING: some query methods provide
volatile results and the onus is on the developer to understand whether pagination is appropriate
for a particular query API method.

Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified query-filters to return. When
combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: some query methods provide volatile results and the onus is on the developer to understand whether
pagination is appropriate for a particular query API method.

Force Sql Filters

Type: boolean Default: false

Result


Type: array of object
No Additional Items
Each item of this array must be:

KerberosRealmQueryResultItem

Type: object
No Additional Properties

Id

Type: integer

Realm

Type: string

Kerberos realm name. This is external to TrueNAS and is case-sensitive.
The general convention for kerberos realms is that they are upper-case.

Must be at least 1 characters long

Kdc

Type: array of string

List of kerberos domain controllers. If the list is empty then the kerberos
libraries will use DNS to look up KDCs. In some situations this is undesirable
as kerberos libraries are, for intance, not active directory site aware and so
may be suboptimal.

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Admin Server

Type: array of string

List of kerberos admin servers. If the list is empty then the kerberos
libraries will use DNS to look them up.

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Kpasswd Server

Type: array of string

list of kerberos kpasswd servers. If the list is empty then DNS will be used
to look them up if needed.

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

KerberosRealmQueryResultItem

Type: object
No Additional Properties

Id

Type: integer

Realm

Type: string

Kerberos realm name. This is external to TrueNAS and is case-sensitive.
The general convention for kerberos realms is that they are upper-case.

Must be at least 1 characters long

Kdc

Type: array of string

List of kerberos domain controllers. If the list is empty then the kerberos
libraries will use DNS to look up KDCs. In some situations this is undesirable
as kerberos libraries are, for intance, not active directory site aware and so
may be suboptimal.

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Admin Server

Type: array of string

List of kerberos admin servers. If the list is empty then the kerberos
libraries will use DNS to look them up.

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Kpasswd Server

Type: array of string

list of kerberos kpasswd servers. If the list is empty then DNS will be used
to look them up if needed.

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Type: integer


Required roles: DIRECTORY_SERVICE_READ