tokens

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

Overview

Name	tokens
Type	Resource
Id	google.iam.tokens

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the SCIM Token. Format: locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}
displayName	string	Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
securityToken	string	Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
state	string	Output only. The state of the token.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the SCIM Token. Format: locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}
displayName	string	Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
securityToken	string	Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
state	string	Output only. The state of the token.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	locationsId, workforcePoolsId, providersId, scimTenantsId, tokensId		Gets an individual WorkforcePoolProviderScimToken.
list	select	locationsId, workforcePoolsId, providersId, scimTenantsId	pageSize, pageToken, showDeleted	Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If show_deleted is set to true, then deleted SCIM tokens are also listed.
create	insert	locationsId, workforcePoolsId, providersId, scimTenantsId	workforcePoolProviderScimTokenId	Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.
patch	update	locationsId, workforcePoolsId, providersId, scimTenantsId, tokensId	updateMask	Updates an existing WorkforcePoolProviderScimToken.
delete	delete	locationsId, workforcePoolsId, providersId, scimTenantsId, tokensId		Deletes a WorkforcePoolProviderScimToken. You can undelete a scim token for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tokens. However, you can view and list them.
undelete	exec	locationsId, workforcePoolsId, providersId, scimTenantsId, tokensId		Undeletes a WorkforcePoolProviderScimToken, 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
locationsId	string
providersId	string
scimTenantsId	string
tokensId	string
workforcePoolsId	string
pageSize	integer (int32)
pageToken	string
showDeleted	boolean
updateMask	string (google-fieldmask)
workforcePoolProviderScimTokenId	string

SELECT examples

get

Gets an individual WorkforcePoolProviderScimToken.

SELECT
name,
displayName,
securityToken,
state
FROM google.iam.tokens
WHERE locationsId = '{{ locationsId }}' -- required
AND workforcePoolsId = '{{ workforcePoolsId }}' -- required
AND providersId = '{{ providersId }}' -- required
AND scimTenantsId = '{{ scimTenantsId }}' -- required
AND tokensId = '{{ tokensId }}' -- required;

list

Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If show_deleted is set to true, then deleted SCIM tokens are also listed.

SELECT
name,
displayName,
securityToken,
state
FROM google.iam.tokens
WHERE locationsId = '{{ locationsId }}' -- required
AND workforcePoolsId = '{{ workforcePoolsId }}' -- required
AND providersId = '{{ providersId }}' -- required
AND scimTenantsId = '{{ scimTenantsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND showDeleted = '{{ showDeleted }}';

INSERT examples

create

Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.

INSERT INTO google.iam.tokens (
data__name,
data__displayName,
locationsId,
workforcePoolsId,
providersId,
scimTenantsId,
workforcePoolProviderScimTokenId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ locationsId }}',
'{{ workforcePoolsId }}',
'{{ providersId }}',
'{{ scimTenantsId }}',
'{{ workforcePoolProviderScimTokenId }}'
RETURNING
name,
displayName,
securityToken,
state
;

Manifest

# Description fields are for documentation purposes
- name: tokens
  props:
    - name: locationsId
      value: string
      description: Required parameter for the tokens resource.
    - name: workforcePoolsId
      value: string
      description: Required parameter for the tokens resource.
    - name: providersId
      value: string
      description: Required parameter for the tokens resource.
    - name: scimTenantsId
      value: string
      description: Required parameter for the tokens resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
        
    - name: displayName
      value: string
      description: >
        Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
        
    - name: workforcePoolProviderScimTokenId
      value: string

UPDATE examples

patch

Updates an existing WorkforcePoolProviderScimToken.

UPDATE google.iam.tokens
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}'
WHERE 
locationsId = '{{ locationsId }}' --required
AND workforcePoolsId = '{{ workforcePoolsId }}' --required
AND providersId = '{{ providersId }}' --required
AND scimTenantsId = '{{ scimTenantsId }}' --required
AND tokensId = '{{ tokensId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
displayName,
securityToken,
state;

DELETE examples

delete

Deletes a WorkforcePoolProviderScimToken. You can undelete a scim token for 30 days. After 30 days, deletion is permanent. You cannot update deleted scim tokens. However, you can view and list them.

DELETE FROM google.iam.tokens
WHERE locationsId = '{{ locationsId }}' --required
AND workforcePoolsId = '{{ workforcePoolsId }}' --required
AND providersId = '{{ providersId }}' --required
AND scimTenantsId = '{{ scimTenantsId }}' --required
AND tokensId = '{{ tokensId }}' --required;

Lifecycle Methods

undelete

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

EXEC google.iam.tokens.undelete 
@locationsId='{{ locationsId }}' --required, 
@workforcePoolsId='{{ workforcePoolsId }}' --required, 
@providersId='{{ providersId }}' --required, 
@scimTenantsId='{{ scimTenantsId }}' --required, 
@tokensId='{{ tokensId }}' --required;