Method: projects.locations.keys.getKeyString

Stay organized with collections Save and categorize content based on your preferences.

Get the key string for an API key.

NOTE: Key is a global resource; hence the only supported value for location is global.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The resource name of the API key to be retrieved.

Authorization requires the following IAM permission on the specified resource name:

  • apikeys.keys.getKeyString

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for keys.getKeyString method.

JSON representation
  "keyString": string


An encrypted and signed value of the key.

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apikeys.keys.getKeyString

For more information, see the IAM documentation.