workforce_pool_provider_keys

Creates, updates, deletes, gets or lists a workforce_pool_provider_keys resource.

Overview

Name	workforce_pool_provider_keys
Type	Resource
Id	google.iam.workforce_pool_provider_keys

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the key. Format: locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}/keys/{key_id}
expireTime	string (google-datetime)	Output only. The time after which the key will be permanently deleted and cannot be recovered. Note that the key may get purged before this time if the total limit of keys per provider is exceeded.
keyData	object	Immutable. Public half of the asymmetric key. (id: KeyData)
state	string	Output only. The state of the key.
use	string	Required. The purpose of the key.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the key. Format: locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}/keys/{key_id}
expireTime	string (google-datetime)	Output only. The time after which the key will be permanently deleted and cannot be recovered. Note that the key may get purged before this time if the total limit of keys per provider is exceeded.
keyData	object	Immutable. Public half of the asymmetric key. (id: KeyData)
state	string	Output only. The state of the key.
use	string	Required. The purpose of the key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	locationsId, workforcePoolsId, providersId, keysId		Gets a WorkforcePoolProviderKey.
list	select	locationsId, workforcePoolsId, providersId	pageSize, pageToken, showDeleted	Lists all non-deleted WorkforcePoolProviderKeys in a WorkforcePoolProvider. If show_deleted is set to true, then deleted keys are also listed.
create	insert	locationsId, workforcePoolsId, providersId	workforcePoolProviderKeyId	Creates a new WorkforcePoolProviderKey in a WorkforcePoolProvider.
delete	delete	locationsId, workforcePoolsId, providersId, keysId		Deletes a WorkforcePoolProviderKey. You can undelete a key for 30 days. After 30 days, deletion is permanent.
undelete	exec	locationsId, workforcePoolsId, providersId, keysId		Undeletes a WorkforcePoolProviderKey, as long as it was deleted fewer than 30 days ago.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
keysId	string
locationsId	string
providersId	string
workforcePoolsId	string
pageSize	integer (int32)
pageToken	string
showDeleted	boolean
workforcePoolProviderKeyId	string

SELECT examples

get

Gets a WorkforcePoolProviderKey.

SELECT
name,
expireTime,
keyData,
state,
use
FROM google.iam.workforce_pool_provider_keys
WHERE locationsId = '{{ locationsId }}' -- required
AND workforcePoolsId = '{{ workforcePoolsId }}' -- required
AND providersId = '{{ providersId }}' -- required
AND keysId = '{{ keysId }}' -- required;

list

Lists all non-deleted WorkforcePoolProviderKeys in a WorkforcePoolProvider. If show_deleted is set to true, then deleted keys are also listed.

SELECT
name,
expireTime,
keyData,
state,
use
FROM google.iam.workforce_pool_provider_keys
WHERE locationsId = '{{ locationsId }}' -- required
AND workforcePoolsId = '{{ workforcePoolsId }}' -- required
AND providersId = '{{ providersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND showDeleted = '{{ showDeleted }}';

INSERT examples

create

Creates a new WorkforcePoolProviderKey in a WorkforcePoolProvider.

INSERT INTO google.iam.workforce_pool_provider_keys (
data__name,
data__keyData,
data__use,
locationsId,
workforcePoolsId,
providersId,
workforcePoolProviderKeyId
)
SELECT 
'{{ name }}',
'{{ keyData }}',
'{{ use }}',
'{{ locationsId }}',
'{{ workforcePoolsId }}',
'{{ providersId }}',
'{{ workforcePoolProviderKeyId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: workforce_pool_provider_keys
  props:
    - name: locationsId
      value: string
      description: Required parameter for the workforce_pool_provider_keys resource.
    - name: workforcePoolsId
      value: string
      description: Required parameter for the workforce_pool_provider_keys resource.
    - name: providersId
      value: string
      description: Required parameter for the workforce_pool_provider_keys resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the key. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}/keys/{key_id}`
        
    - name: keyData
      value: object
      description: >
        Immutable. Public half of the asymmetric key.
        
    - name: use
      value: string
      description: >
        Required. The purpose of the key.
        
      valid_values: ['KEY_USE_UNSPECIFIED', 'ENCRYPTION']
    - name: workforcePoolProviderKeyId
      value: string

DELETE examples

delete

Deletes a WorkforcePoolProviderKey. You can undelete a key for 30 days. After 30 days, deletion is permanent.

DELETE FROM google.iam.workforce_pool_provider_keys
WHERE locationsId = '{{ locationsId }}' --required
AND workforcePoolsId = '{{ workforcePoolsId }}' --required
AND providersId = '{{ providersId }}' --required
AND keysId = '{{ keysId }}' --required;

Lifecycle Methods

undelete

Undeletes a WorkforcePoolProviderKey, as long as it was deleted fewer than 30 days ago.

EXEC google.iam.workforce_pool_provider_keys.undelete 
@locationsId='{{ locationsId }}' --required, 
@workforcePoolsId='{{ workforcePoolsId }}' --required, 
@providersId='{{ providersId }}' --required, 
@keysId='{{ keysId }}' --required;