users_get_api_keys: Show the specified API key

In civis: R Client for the 'Civis Platform API'

Show the specified API key

Description

Show the specified API key

Usage

users_get_api_keys(id, key_id)

Arguments

id	string required. The ID of the user or 'me'.
key_id	integer required. The ID of the API key.

Value

A list containing the following elements:

id	integer, The ID of the API key.
name	string, The name of the API key.
expiresAt	string, The date and time when the key expired.
createdAt	string, The date and time when the key was created.
revokedAt	string, The date and time when the key was revoked.
lastUsedAt	string, The date and time when the key was last used.
scopes	array, The scopes which the key is permissioned on.
useCount	integer, The number of times the key has been used.
expired	boolean, True if the key has expired.
active	boolean, True if the key has neither expired nor been revoked.
constraints	array, An array containing the following fields: constraint string, The path matcher of the constraint. constraintType string, The type of constraint (exact/prefix/regex/verb). getAllowed boolean, Whether the constraint allows GET requests. headAllowed boolean, Whether the constraint allows HEAD requests. postAllowed boolean, Whether the constraint allows POST requests. putAllowed boolean, Whether the constraint allows PUT requests. patchAllowed boolean, Whether the constraint allows PATCH requests. deleteAllowed boolean, Whether the constraint allows DELETE requests.

civis documentation built on Aug. 30, 2025, 1:08 a.m.