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

Name	Datatype	Description
name	string	Identifier. Gemini Enterprise only. 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. Gemini Enterprise only. The display name of the SCIM token. Cannot exceed 32 characters.
securityToken	string	Output only. Gemini Enterprise only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
state	string	Output only. Gemini Enterprise only. The state of the token. (STATE_UNSPECIFIED, ACTIVE, DELETED)

list

Name	Datatype	Description
name	string	Identifier. Gemini Enterprise only. 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. Gemini Enterprise only. The display name of the SCIM token. Cannot exceed 32 characters.
securityToken	string	Output only. Gemini Enterprise only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
state	string	Output only. Gemini Enterprise only. The state of the token. (STATE_UNSPECIFIED, ACTIVE, DELETED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	locationsId, workforcePoolsId, providersId, scimTenantsId, tokensId		Gemini Enterprise only. Gets an individual WorkforcePoolProviderScimToken.
list	select	locationsId, workforcePoolsId, providersId, scimTenantsId	showDeleted, pageToken, pageSize	Gemini Enterprise only. 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	Gemini Enterprise only. 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	Gemini Enterprise only. Updates an existing WorkforcePoolProviderScimToken.
delete	delete	locationsId, workforcePoolsId, providersId, scimTenantsId, tokensId		Gemini Enterprise only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.

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

Gemini Enterprise only. 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

Gemini Enterprise only. 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 showDeleted = '{{ showDeleted }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

create

Gemini Enterprise only. 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: "{{ locationsId }}"
    description: Required parameter for the tokens resource.
  - name: workforcePoolsId
    value: "{{ workforcePoolsId }}"
    description: Required parameter for the tokens resource.
  - name: providersId
    value: "{{ providersId }}"
    description: Required parameter for the tokens resource.
  - name: scimTenantsId
    value: "{{ scimTenantsId }}"
    description: Required parameter for the tokens resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Gemini Enterprise only. 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: "{{ displayName }}"
    description: |
      Optional. Gemini Enterprise only. The display name of the SCIM token. Cannot exceed 32 characters.
  - name: workforcePoolProviderScimTokenId
    value: "{{ workforcePoolProviderScimTokenId }}"

UPDATE examples

patch

Gemini Enterprise only. 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

Gemini Enterprise only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. 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
;