SCscanopy
User API Keys
internal

List user API key field values

Changed on

Every distinct value of one User API Key field across the User API Keys the caller can list, with how many hold each. Takes the list's filters; ignores pagination, search and ordering.

get/api/v1/user-api-keys/field-values/{field}

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/user-api-keys/field-values/{field}
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Path parameters

field'created_at' | 'name' | 'updated_at' | 'permissions' | 'is_enabled' | 'last_used' | 'expires_at' required

Fields the user API key list can be ordered and grouped by.

The field whose values to count

Query parameters

permissionsUserOrgPermissions[] nullable

Only keys limited to one of these roles. Repeat for several.

site_idsstring[] nullable

Only keys with access to one of these sites. Repeat for several.

is_enabledboolean[] nullable

Only enabled keys (true), disabled ones (false), or both (repeat it). Sent empty, matches none.

tag_idsstring[] nullable

Filter by tag IDs (returns keys that have ANY of the specified tags)

tag_setsstring[] nullable

Tag sets the key must hold one tag from each of. Each entry is a comma-separated list of tag ids. One entry per tag group the list is filtered by.

searchstring nullable

Free-text search. Case-insensitive substring match against the key's name.

group_by'created_at' | 'name' | 'updated_at' | 'permissions' | 'is_enabled' | 'last_used' | 'expires_at'

Fields the user API key list can be ordered and grouped by.

Primary ordering field (used for grouping). Always sorts ASC to keep groups together.

order_by'created_at' | 'name' | 'updated_at' | 'permissions' | 'is_enabled' | 'last_used' | 'expires_at'

Fields the user API key list can be ordered and grouped by.

Secondary ordering field (sorting within groups or standalone sort).

group_by_tag_groupstring uuid nullable

Group by the tag each row holds from this tag group. Takes the place of group_by.

order_by_tag_groupstring uuid nullable

Sort by the position of the tag each row holds from this tag group. Takes the place of order_by.

order_direction'asc' | 'desc'

Direction for ORDER BY clauses.

Direction for order_by field (group_by always uses ASC).

limitinteger nullable

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offsetinteger nullable

Number of results to skip. Default: 0.

Response

Distinct values and their User API Key counts

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes