Projects.hmacKeys: list

Retrieves a list of HMAC keys matching the criteria. Try it now.

The authenticated user must have storage.hmacKeys.list permission for the project in which the key exists.

For general information about HMAC keys in Cloud Storage, see HMAC Keys.

Request

GET https://storage.googleapis.com/storage/v1/projects/projectId/hmacKeys

In addition to standard query parameters, the following query parameters apply to this method.

To see an example of how to include query parameters in a request, see the JSON API Overview page.

Parameter name	Value	Description
Path parameters
`projectId`	`string`	The project ID of the project in which to look for HMAC keys.
Optional query parameters
`maxResults`	`unsigned integer`	Maximum number of `items` to return in a single page of responses. The service may return fewer results than the specified maximum. If the response includes a `nextPageToken`, there are more results not included in this response.
`pageToken`	`string`	A previously-returned page token representing part of the larger set of results to view.
`serviceAccountEmail`	`string`	If present, only HMAC keys for the given service account are returned.
`showDeletedKeys`	`boolean`	If true, include keys in the `DELETED` state. Default is false.

Do not supply a request body with this method.

If successful, this method returns a response body with the following structure:

{
  "kind": "storage#hmacKeysMetadata",
  "nextPageToken": string,
  "items": [
    Metadata portion of an hmacKeys resource
  ]
}

Property name	Value	Description
`kind`	`string`	The kind of item this is. For lists of hmacKeys, this is always `storage#hmacKeysMetadata`.
`nextPageToken`	`string`	The continuation token, included only if there are more items to return. Provide this value as the `pageToken` of a subsequent request in order to return the next page of results.
`items[]`	`list`	The list of items.

Use the APIs Explorer below to call this method on live data and see the response.