Cloud Storage JSON API . projects . hmacKeys

create(projectId=*, serviceAccountEmail=*, userProject=None)

Creates a new HMAC key for the specified service account.

Args:
  projectId: string, Project ID owning the service account. (required)
  serviceAccountEmail: string, Email address of the service account. (required)
  userProject: string, The project to be billed for this request.

Returns:
  An object of the form:

    { # JSON template to produce a JSON-style HMAC Key resource for Create responses.
    "kind": "storage#hmacKey", # The kind of item this is. For HMAC keys, this is always storage#hmacKey.
    "secret": "A String", # HMAC secret key material.
    "metadata": { # JSON template to produce a JSON-style HMAC Key metadata resource. # Key metadata.
      "kind": "storage#hmacKeyMetadata", # The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
      "updated": "A String", # The last modification time of the HMAC key metadata in RFC 3339 format.
      "timeCreated": "A String", # The creation time of the HMAC key in RFC 3339 format.
      "projectId": "A String", # Project ID owning the service account to which the key authenticates.
      "accessId": "A String", # The ID of the HMAC Key.
      "state": "A String", # The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
      "etag": "A String", # HTTP 1.1 Entity tag for the HMAC key.
      "serviceAccountEmail": "A String", # The email address of the key's associated service account.
      "id": "A String", # The ID of the HMAC key, including the Project ID and the Access ID.
      "selfLink": "A String", # The link to this resource.
    },
  }

delete(projectId=*, accessId=*, userProject=None)

Deletes an HMAC key.

Args:
  projectId: string, Project ID owning the requested key (required)
  accessId: string, Name of the HMAC key to be deleted. (required)
  userProject: string, The project to be billed for this request.

get(projectId=*, accessId=*, userProject=None)

Retrieves an HMAC key's metadata

Args:
  projectId: string, Project ID owning the service account of the requested key. (required)
  accessId: string, Name of the HMAC key. (required)
  userProject: string, The project to be billed for this request.

Returns:
  An object of the form:

    { # JSON template to produce a JSON-style HMAC Key metadata resource.
    "kind": "storage#hmacKeyMetadata", # The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
    "updated": "A String", # The last modification time of the HMAC key metadata in RFC 3339 format.
    "timeCreated": "A String", # The creation time of the HMAC key in RFC 3339 format.
    "projectId": "A String", # Project ID owning the service account to which the key authenticates.
    "accessId": "A String", # The ID of the HMAC Key.
    "state": "A String", # The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
    "etag": "A String", # HTTP 1.1 Entity tag for the HMAC key.
    "serviceAccountEmail": "A String", # The email address of the key's associated service account.
    "id": "A String", # The ID of the HMAC key, including the Project ID and the Access ID.
    "selfLink": "A String", # The link to this resource.
  }

list(projectId=*, pageToken=None, showDeletedKeys=None, userProject=None, maxResults=None, serviceAccountEmail=None)

Retrieves a list of HMAC keys matching the criteria.

Args:
  projectId: string, Name of the project in which to look for HMAC keys. (required)
  pageToken: string, A previously-returned page token representing part of the larger set of results to view.
  showDeletedKeys: boolean, Whether or not to show keys in the DELETED state.
  userProject: string, The project to be billed for this request.
  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.
  serviceAccountEmail: string, If present, only keys for the given service account are returned.

Returns:
  An object of the form:

    { # A list of hmacKeys.
    "nextPageToken": "A 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.
    "items": [ # The list of items.
      { # JSON template to produce a JSON-style HMAC Key metadata resource.
        "kind": "storage#hmacKeyMetadata", # The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
        "updated": "A String", # The last modification time of the HMAC key metadata in RFC 3339 format.
        "timeCreated": "A String", # The creation time of the HMAC key in RFC 3339 format.
        "projectId": "A String", # Project ID owning the service account to which the key authenticates.
        "accessId": "A String", # The ID of the HMAC Key.
        "state": "A String", # The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
        "etag": "A String", # HTTP 1.1 Entity tag for the HMAC key.
        "serviceAccountEmail": "A String", # The email address of the key's associated service account.
        "id": "A String", # The ID of the HMAC key, including the Project ID and the Access ID.
        "selfLink": "A String", # The link to this resource.
      },
    ],
    "kind": "storage#hmacKeysMetadata", # The kind of item this is. For lists of hmacKeys, this is always storage#hmacKeysMetadata.
  }

list_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    

update(projectId=*, accessId=*, body=None, userProject=None)

Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.

Args:
  projectId: string, Project ID owning the service account of the updated key. (required)
  accessId: string, Name of the HMAC key being updated. (required)
  body: object, The request body.
    The object takes the form of:

{ # JSON template to produce a JSON-style HMAC Key metadata resource.
  "kind": "storage#hmacKeyMetadata", # The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
  "updated": "A String", # The last modification time of the HMAC key metadata in RFC 3339 format.
  "timeCreated": "A String", # The creation time of the HMAC key in RFC 3339 format.
  "projectId": "A String", # Project ID owning the service account to which the key authenticates.
  "accessId": "A String", # The ID of the HMAC Key.
  "state": "A String", # The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
  "etag": "A String", # HTTP 1.1 Entity tag for the HMAC key.
  "serviceAccountEmail": "A String", # The email address of the key's associated service account.
  "id": "A String", # The ID of the HMAC key, including the Project ID and the Access ID.
  "selfLink": "A String", # The link to this resource.
}

  userProject: string, The project to be billed for this request.

Returns:
  An object of the form:

    { # JSON template to produce a JSON-style HMAC Key metadata resource.
    "kind": "storage#hmacKeyMetadata", # The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
    "updated": "A String", # The last modification time of the HMAC key metadata in RFC 3339 format.
    "timeCreated": "A String", # The creation time of the HMAC key in RFC 3339 format.
    "projectId": "A String", # Project ID owning the service account to which the key authenticates.
    "accessId": "A String", # The ID of the HMAC Key.
    "state": "A String", # The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
    "etag": "A String", # HTTP 1.1 Entity tag for the HMAC key.
    "serviceAccountEmail": "A String", # The email address of the key's associated service account.
    "id": "A String", # The ID of the HMAC key, including the Project ID and the Access ID.
    "selfLink": "A String", # The link to this resource.
  }