List API keys

  • Updated on Apr 7, 2025
  • Published on Mar 4, 2025
  • 1 minute(s) read
Prev
Get
/v1alpha/api-keys

Returns a list of all API keys for the current workspace.

Security
HTTP
Type bearer
Responses
200

The list of API keys was retrieved successfully.

Expand All
object
api_keys
Array of object (v1alphaApiKey)

The list of API keys returned.

object
client_id
string

The client ID of the API key.

Example74e19393-3e94-48d2-8b60-26f2d2665942
name
string

The name of the API key.

type
string
  • API_KEY_TYPE_UNSPECIFIED: The type of the API key is unknown.
  • API_KEY_TYPE_SERVICE: The API key is a service API key, meaning it is not associated with a specific user.
  • API_KEY_TYPE_PRIVATE: The API key is a private API key.
Valid values[ "API_KEY_TYPE_UNSPECIFIED", "API_KEY_TYPE_SERVICE", "API_KEY_TYPE_PRIVATE" ]
Default"API_KEY_TYPE_UNSPECIFIED"
role_id
string (uuid)

The ID of the role associated with the API key.

Example74e19393-3e94-48d2-8b60-26f2d2665942
role_name
string

The role associated with the API key.

created_time
string (date-time)

The timestamp when the API key was created.

Example2022-03-09T08:40:18.490Z
last_authenticated_time
string (date-time)

The timestamp when the API key was last used to generate an access token.

Example2022-03-09T08:40:18.490Z
user
object (usersv1alphaUser)

The user object

id
string (uuid)

The unique identifier of the user.

Example74e19393-3e94-48d2-8b60-26f2d2665942
email
string (email)

The email address of the user.

Exampleuser@email.com
role_id
string (uuid)

The unique identifier of the role assigned to the user.

Example74e19393-3e94-48d2-8b60-26f2d2665942
status
string
  • STATUS_UNSPECIFIED: Default value. This value is unused.
  • INVITATION_SENT: Invitation email has been sent.
  • VERIFIED: Membership verified.
Valid values[ "STATUS_UNSPECIFIED", "INVITATION_SENT", "VERIFIED" ]
Default"STATUS_UNSPECIFIED"
sso_provision
boolean

If true, the user was provisioned in Torq with the SSO IdP.

ExampleTrue
created_time
string (date-time)

The timestamp when the user was created.

Example2022-03-09T08:40:18.490Z
last_login_time
string (date-time)

The timestamp when the user last logged in to Torq via the UI or the API.

Example2022-03-09T08:40:18.490Z
401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

object
403

You don't have permission to access this resource.

object