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
GET https://apikeys.googleapis.com/v2/{name=projects/*/locations/*/keys/*}/keyString
The URL uses gRPC Transcoding syntax.
Path parameters
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
If successful, the response body contains data with the following structure:
Response message for keys.getKeyString
method.
JSON representation |
{
"keyString": string
} |
Fields |
keyString |
string
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-05-25 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2022-05-25 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2022-05-25 UTC."]]