List
|
|||||
|
|
||||
Retrieves a list of HMAC keys matching the criteria
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View your data across Google Cloud Platform services
- Manage your data and permissions in Google Cloud Storage
- View your data in Google Cloud Storage
Input
This building block consumes 6 input parameters
| Name | Format | Description |
|---|---|---|
projectId Required |
STRING |
Name of the project in which to look for HMAC keys |
maxResults |
INTEGER |
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 |
pageToken |
STRING |
A previously-returned page token representing part of the larger set of results to view |
serviceAccountEmail |
STRING |
If present, only keys for the given service account are returned |
showDeletedKeys |
BOOLEAN |
Whether or not to show keys in the DELETED state |
userProject |
STRING |
The project to be billed for this request |
= Parameter name
= Format
|
projectId STRING Required Name of the project in which to look for HMAC keys |
|
maxResults INTEGER 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 |
|
pageToken STRING A previously-returned page token representing part of the larger set of results to view |
|
serviceAccountEmail STRING If present, only keys for the given service account are returned |
|
showDeletedKeys BOOLEAN Whether or not to show keys in the DELETED state |
|
userProject STRING The project to be billed for this request |
Output
This building block provides 13 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
JSON template to produce a JSON-style HMAC Key metadata resource |
items[].accessId |
STRING |
The ID of the HMAC Key |
items[].etag |
STRING |
HTTP 1.1 Entity tag for the HMAC key |
items[].id |
STRING |
The ID of the HMAC key, including the Project ID and the Access ID |
items[].kind |
STRING |
The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata |
items[].projectId |
STRING |
Project ID owning the service account to which the key authenticates |
items[].selfLink |
STRING |
The link to this resource |
items[].serviceAccountEmail |
STRING |
The email address of the key's associated service account |
items[].state |
STRING |
The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED |
items[].timeCreated |
DATE_TIME |
The creation time of the HMAC key in RFC 3339 format |
items[].updated |
DATE_TIME |
The last modification time of the HMAC key metadata in RFC 3339 format |
kind |
STRING |
The kind of item this is. For lists of hmacKeys, this is always storage#hmacKeysMetadata |
nextPageToken |
STRING |
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results |
= Parameter name
= Format
|
items[] OBJECT JSON template to produce a JSON-style HMAC Key metadata resource |
|
items[].accessId STRING The ID of the HMAC Key |
|
items[].etag STRING HTTP 1.1 Entity tag for the HMAC key |
|
items[].id STRING The ID of the HMAC key, including the Project ID and the Access ID |
|
items[].kind STRING The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata |
|
items[].projectId STRING Project ID owning the service account to which the key authenticates |
|
items[].selfLink STRING The link to this resource |
|
items[].serviceAccountEmail STRING The email address of the key's associated service account |
|
items[].state STRING The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED |
|
items[].timeCreated DATE_TIME The creation time of the HMAC key in RFC 3339 format |
|
items[].updated DATE_TIME The last modification time of the HMAC key metadata in RFC 3339 format |
|
kind STRING The kind of item this is. For lists of hmacKeys, this is always storage#hmacKeysMetadata |
|
nextPageToken STRING The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results |