gcp_apikeys_key

ancestors

Type: UNORDERED_LIST_STRING

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. A timestamp identifying the time this key was originally created.

delete_time

Type: TIMESTAMP
Provider name: deleteTime
Description: Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.

etag

Type: STRING
Provider name: etag
Description: Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.

gcp_display_name

Type: STRING
Provider name: displayName
Description: Human-readable display name of this key that you can modify. The maximum length is 63 characters.

key_string

Type: STRING
Provider name: keyString
Description: Output only. An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString method.

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Output only. The resource name of the key. The name has the form: projects//locations/global/keys/. For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2 NOTE: Key is a global resource; hence the only supported value for location is global.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

restrictions

Type: STRUCT
Provider name: restrictions
Description: Key restrictions.

• android_key_restrictions
  Type: STRUCT
  Provider name: androidKeyRestrictions
  Description: The Android apps that are allowed to use the key.
  
  • allowed_applications
    Type: UNORDERED_LIST_STRUCT
    Provider name: allowedApplications
    Description: A list of Android applications that are allowed to make API calls with this key.
    
    • package_name
      Type: STRING
      Provider name: packageName
      Description: The package name of the application.
      
    • sha1_fingerprint
      Type: STRING
      Provider name: sha1Fingerprint
      Description: The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
      
• api_targets
  Type: UNORDERED_LIST_STRUCT
  Provider name: apiTargets
  Description: A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.
  
  • methods
    Type: UNORDERED_LIST_STRING
    Provider name: methods
    Description: Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get* translate.googleapis.com.Get*
    
  • service
    Type: STRING
    Provider name: service
    Description: The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.
    
• browser_key_restrictions
  Type: STRUCT
  Provider name: browserKeyRestrictions
  Description: The HTTP referrers (websites) that are allowed to use the key.
  
  • allowed_referrers
    Type: UNORDERED_LIST_STRING
    Provider name: allowedReferrers
    Description: A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.
    
• ios_key_restrictions
  Type: STRUCT
  Provider name: iosKeyRestrictions
  Description: The iOS apps that are allowed to use the key.
  
  • allowed_bundle_ids
    Type: UNORDERED_LIST_STRING
    Provider name: allowedBundleIds
    Description: A list of bundle IDs that are allowed when making API calls with this key.
    
• server_key_restrictions
  Type: STRUCT
  Provider name: serverKeyRestrictions
  Description: The IP addresses of callers that are allowed to use the key.
  
  • allowed_ips
    Type: UNORDERED_LIST_STRING
    Provider name: allowedIps
    Description: A list of the caller IP addresses that are allowed to make API calls with this key.
    

service_account_email

Type: STRING
Provider name: serviceAccountEmail
Description: Optional. The email address of the service account the key is bound to.

tags

Type: UNORDERED_LIST_STRING

uid

Type: STRING
Provider name: uid
Description: Output only. Unique id in UUID4 format.

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. A timestamp identifying the time this key was last updated.