Storage.projects.hmac Keys.list

Retrieves a list of HMAC keys matching the criteria.

GET/projects/{projectId}/hmacKeys

Use it in a workflow

Add a step and choose the Google Cloud Storage connector.
Pick the Storage.projects.hmac Keys.list action (under projects).
Fill in the fields below, then reference the result from later steps as {{storageProjectsHmacKeysList.response.data}}.

Request

Path parameters

projectIdstringrequired

Name of the project in which to look for HMAC keys.

Query parameters

altstring

Data format for the response.

One ofjson

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

uploadTypestring

Upload protocol for media (e.g. "media", "multipart", "resumable").

userIpstring

Deprecated. Please use quotaUser instead.

maxResultsinteger

Maximum number of items to return in a single page of responses. The service uses this parameter or 250 items, whichever is smaller. The max number of items per page will also be limited by the number of distinct service accounts in the response. If the number of service accounts in a single response is too high, the page will truncated and a next page token will be returned.

pageTokenstring

A previously-returned page token representing part of the larger set of results to view.

serviceAccountEmailstring

If present, only keys for the given service account are returned.

showDeletedKeysboolean

Whether or not to show keys in the DELETED state.

userProjectstring

The project to be billed for this request.

Response

Returns 200 with an object. Read it in later steps with {{storageProjectsHmacKeysList.response.data.<field>}}.

itemsarray<object>

The list of items.

accessIdstring

The ID of the HMAC Key.

etagstring

HTTP 1.1 Entity tag for the HMAC key.

idstring

The ID of the HMAC key, including the Project ID and the Access ID.

kindstring

The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.

Default "storage#hmacKeyMetadata"

projectIdstring

Project ID owning the service account to which the key authenticates.

selfLinkstring

The link to this resource.

serviceAccountEmailstring

The email address of the key's associated service account.

statestring

The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.

timeCreatedstring (date-time)

The creation time of the HMAC key in RFC 3339 format.

updatedstring (date-time)

The last modification time of the HMAC key metadata in RFC 3339 format.

kindstring

The kind of item this is. For lists of hmacKeys, this is always storage#hmacKeysMetadata.

Default "storage#hmacKeysMetadata"

nextPageTokenstring

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

json

{
  "items": [
    {
      "accessId": "string",
      "etag": "string",
      "id": "string",
      "kind": "storage#hmacKeyMetadata",
      "projectId": "string",
      "selfLink": "string",
      "serviceAccountEmail": "string",
      "state": "string",
      "timeCreated": "2025-01-01T00:00:00Z",
      "updated": "2025-01-01T00:00:00Z"
    }
  ],
  "kind": "storage#hmacKeysMetadata",
  "nextPageToken": "string"
}

Need more? See the Google Cloud Storage guide for connection setup and behaviour shared by every action.

Was this page helpful?