The request for a call to ApiKeyService.CreateApiKey.
Field
Type
Label
Description
name
string
The name for the new ApiKey. Required.
user_id
string
The id of the user the new key will authenticate as. Must equal the id of the calling user; creating an API key on behalf of another user is no longer supported and the service will return INVALID_ARGUMENT if the values differ. The field is retained for backwards compatibility with existing clients and may be marked deprecated in a future revision.
CreatedApiKey includes the key, which will only be returned on creation, so having a separate type makes the “never return the key a second time” semantics clear
The request for a call to ApiKeyService.ListApiKeys.
Field
Type
Label
Description
page_size
uint32
The maximum number of api keys to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token
string
A page token, received from a previous ListApiKeys call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListApiKeys must match the call that provided the page token.
filter
string
A Common Expression Language (CEL) filter string. Available fields to filter by are api_key_id, user_id, created_by_user_id, and name. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.
order_by
string
How to order the retrieved channels. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are name and created_date. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: “name desc,created_date”
