2023-03-25
▼ ▲ iam.locations.workforcePools.providers.keys.list
Parameter Order: parent
Path: v1/{+parent}/keys
Flat Path: v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Lists all non-deleted WorkforcePoolProviderKeys in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted keys are also listed.
Parameters:
parent
Pattern: ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The provider resource to list encryption keys for. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`
pageToken
Type: string
Location: query
Description: A page token, received from a previous `ListWorkforcePoolProviderKeys` call. Provide this to retrieve the subsequent page.
showDeleted
Description: Whether to return soft-deleted keys.
Type: boolean
Location: query
pageSize
Description: The maximum number of keys to return. If unspecified, all keys are returned. The maximum value is 10; values above 10 are truncated to 10.
Format: int32
Type: integer
Location: query
▼ ▲ iam.locations.workforcePools.providers.keys.delete
Parameter Order: name
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameters:
name
Location: path
Pattern: ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/keys/[^/]+$
Type: string
Required: Yes
Description: Required. The name of the key to delete.
Flat Path: v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}
Description: Deletes a WorkforcePoolProviderKey. You can undelete a key for 30 days. After 30 days, deletion is permanent.
▼ ▲ iam.locations.workforcePools.providers.keys.undelete
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}:undelete
Parameters:
name
Description: Required. The name of the key to undelete.
Pattern: ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/keys/[^/]+$
Location: path
Type: string
Required: Yes
Description: Undeletes a WorkforcePoolProviderKey, as long as it was deleted fewer than 30 days ago.
Parameter Order: name
HTTP Method: POST
Path: v1/{+name}:undelete
▼ ▲ iam.locations.workforcePools.providers.keys.get
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+name}
Parameter Order: name
Description: Gets a WorkforcePoolProviderKey.
Flat Path: v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys/{keysId}
Parameters:
name
Description: Required. The name of the key to retrieve.
Type: string
Pattern: ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/keys/[^/]+$
Required: Yes
Location: path
▼ ▲ iam.locations.workforcePools.providers.keys.create
Path: v1/{+parent}/keys
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/keys
Parameters:
workforcePoolProviderKeyId
Description: Required. The ID to use for the key, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-].
Location: query
Type: string
parent
Pattern: ^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+$
Type: string
Required: Yes
Location: path
Description: Required. The provider to create this key in.
HTTP Method: POST
Description: Creates a new WorkforcePoolProviderKey in a WorkforcePoolProvider.
▼ ▲ iam.projects.locations.workloadIdentityPools.providers.keys.undelete
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/providers/[^/]+/keys/[^/]+$
Description: Required. The name of the encryption key to undelete.
Parameter Order: name
Description: Undeletes an WorkloadIdentityPoolProviderKey, as long as it was deleted fewer than 30 days ago.
HTTP Method: POST
Path: v1/{+name}:undelete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}:undelete
▼ ▲ iam.projects.locations.workloadIdentityPools.providers.keys.list
Parameters:
parent
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/providers/[^/]+$
Type: string
Description: Required. The parent provider resource to list encryption keys for.
pageToken
Type: string
Location: query
Description: A page token, received from a previous `ListWorkloadIdentityPoolProviderKeys` call. Provide this to retrieve the subsequent page.
showDeleted
Description: Whether to return soft deleted resources as well.
Type: boolean
Location: query
pageSize
Type: integer
Description: The maximum number of keys to return. If unspecified, all keys are returned. The maximum value is 10; values above 10 are truncated to 10.
Format: int32
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all non-deleted WorkloadIdentityPoolProviderKeys in a project. If show_deleted is set to `true`, then deleted pools are also listed.
Path: v1/{+parent}/keys
HTTP Method: GET
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys
▼ ▲ iam.projects.locations.workloadIdentityPools.providers.keys.delete
HTTP Method: DELETE
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/providers/[^/]+/keys/[^/]+$
Location: path
Description: Required. The name of the encryption key to delete.
Description: Deletes an WorkloadIdentityPoolProviderKey. You can undelete a key for 30 days. After 30 days, deletion is permanent.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}
▼ ▲ iam.projects.locations.workloadIdentityPools.providers.keys.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys
Parameters:
workloadIdentityPoolProviderKeyId
Location: query
Type: string
Description: Required. The ID to use for the key, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-].
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/providers/[^/]+$
Type: string
Required: Yes
Description: Required. The parent provider resource to create the key in.
HTTP Method: POST
Description: Create a new WorkloadIdentityPoolProviderKey in a WorkloadIdentityPoolProvider.
Path: v1/{+parent}/keys
Parameter Order: parent
▼ ▲ iam.projects.locations.workloadIdentityPools.providers.keys.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets an individual WorkloadIdentityPoolProviderKey.
Parameters:
name
Description: Required. The name of the key to retrieve.
Pattern: ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/providers/[^/]+/keys/[^/]+$
Required: Yes
Type: string
Location: path
Parameter Order: name
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/providers/{providersId}/keys/{keysId}
Path: v1/{+name}