- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
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
GET https://apikeys.googleapis.com/v2/{name=projects/*/locations/*/keys/*}/keyString
The URL uses gRPC Transcoding syntax.
Path parameters
name
string
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
Response message for keys.getKeyString
method.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{ "keyString" : string } |
| Fields | |
|---|---|
keyString
|
An encrypted and signed value of the key. |
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform.read-only -
https://www.googleapis.com/auth/cloud-platform
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 .
