credentials

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

Overview

Name	credentials
Type	Resource
Id	google.agentidentitycredentials.credentials

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
retrieve	exec	projectsId, locationsId, authProvidersId		Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the token field in the response is populated, credential retrieval was successful. If one of the fields in the status oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on RetrieveCredentialsResponse for more information.
finalize	exec	projectsId, locationsId, authProvidersId		Finalizes the credentials after a successful consent flow.

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
authProvidersId	string
locationsId	string
projectsId	string

Lifecycle Methods

retrieve

Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the token field in the response is populated, credential retrieval was successful. If one of the fields in the status oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on RetrieveCredentialsResponse for more information.

EXEC google.agentidentitycredentials.credentials.retrieve 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@authProvidersId='{{ authProvidersId }}' --required 
@@json=
'{
"scopes": "{{ scopes }}", 
"userId": "{{ userId }}", 
"continueUri": "{{ continueUri }}", 
"forceRefreshToken": "{{ forceRefreshToken }}"
}'
;

finalize

Finalizes the credentials after a successful consent flow.

EXEC google.agentidentitycredentials.credentials.finalize 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@authProvidersId='{{ authProvidersId }}' --required 
@@json=
'{
"userIdValidationState": "{{ userIdValidationState }}", 
"consentNonce": "{{ consentNonce }}", 
"userId": "{{ userId }}"
}'
;