admin

Get a list of all admin accounts.

Get a listing of all admin account records the currently authenticated admin user has permissions to.

This API's query parameters and responses are intended to be compatible with the DataTables server-side processing API.

get/api-umbrella/v1/admins

Request

The document declares no server URL.
Auth
- API key in header X-Api-Key
- or API key in header X-Admin-Auth-Token
TypeScript
https://skmtc.dev/gsa/apis/api-umbrella-admin-api/docs/api-umbrella/v1/admins/get.ts
A function with typed inputs. Its response is checked against the schema.

startinteger

Offset for pagination (0 based - 0 is the first record)

lengthinteger

Limit the number of records returned for pagination

search[value]string

Perform a text search across all records for this string

order[i][column]integer

Size of array

order[i][dir]'asc' | 'desc'

Size of array

columns[i][data]string

The database field name of the column displayed at index i

columns[i][name]string

The human-readable name of the column displayed at index i

Successful response

drawinteger

recordsTotalinteger

recordsFilteredinteger