2023-01-17
▼ ▲ kmsinventory.organizations.protectedResources.search
Description: Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: scope
HTTP Method: GET
Path: v1/{+scope}/protectedResources:search
Parameters:
cryptoKey
Type: string
Location: query
Description: Required. The resource name of the CryptoKey.
pageToken
Type: string
Location: query
Description: A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token.
scope
Type: string
Pattern: ^organizations/[^/]+$
Location: path
Required: Yes
Description: Required. Resource name of the organization. Example: organizations/123
pageSize
Description: The maximum number of resources to return. The service may return fewer than this value. If unspecified, at most 500 resources will be returned. The maximum value is 500; values above 500 will be coerced to 500.
Location: query
Format: int32
Type: integer
Flat Path: v1/organizations/{organizationsId}/protectedResources:search
▼ ▲ kmsinventory.projects.locations.keyRings.cryptoKeys.getProtectedResourcesSummary
HTTP Method: GET
Parameter Order: name
Path: v1/{+name}/protectedResourcesSummary
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Description: Required. The resource name of the CryptoKey.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.*$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/protectedResourcesSummary
Description: Returns aggregate information about the resources protected by the given Cloud KMS CryptoKey. Only resources within the same Cloud organization as the key will be returned. The project that holds the key must be part of an organization in order for this call to succeed.
▼ ▲ kmsinventory.projects.cryptoKeys.list
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+$
Required: Yes
Location: path
Description: Required. The Google Cloud project for which to retrieve key metadata, in the format `projects/*`
pageSize
Format: int32
Type: integer
Location: query
Description: Optional. The maximum number of keys to return. The service may return fewer than this value. If unspecified, at most 1000 keys will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
Location: query
Type: string
Description: Optional. Pass this into a subsequent request in order to receive the next page of results.
Path: v1/{+parent}/cryptoKeys
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/cryptoKeys
Description: Returns cryptographic keys managed by Cloud KMS in a given Cloud project. Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.