authorizations

Creates, updates, deletes, gets or lists an authorizations resource.

Overview

Name	authorizations
Type	Resource
Id	google.agentidentity.authorizations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. name of resource
clientUserId	string	Output only. The client_user_id provided by the client application for their end user. Not verified by Google.
createTime	string (google-datetime)	Output only. [Output only] Create time stamp
scopes	array	Output only. The scopes actually granted by the end user during the consent flow.
state	string	Output only. The state of the authorization. (STATE_UNSPECIFIED, ACTIVE, SUSPENDED)
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp

list

Name	Datatype	Description
name	string	Identifier. name of resource
clientUserId	string	Output only. The client_user_id provided by the client application for their end user. Not verified by Google.
createTime	string (google-datetime)	Output only. [Output only] Create time stamp
scopes	array	Output only. The scopes actually granted by the end user during the consent flow.
state	string	Output only. The state of the authorization. (STATE_UNSPECIFIED, ACTIVE, SUSPENDED)
updateTime	string (google-datetime)	Output only. [Output only] Update time stamp

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, authProvidersId, authorizationsId		Gets details of a single Authorization.
list	select	projectsId, locationsId, authProvidersId	pageSize, orderBy, filter, pageToken	Lists Authorizations in a given project and location.
delete	delete	projectsId, locationsId, authProvidersId, authorizationsId	requestId	Deletes a single Authorization.

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
authorizationsId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single Authorization.

SELECT
name,
clientUserId,
createTime,
scopes,
state,
updateTime
FROM google.agentidentity.authorizations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND authProvidersId = '{{ authProvidersId }}' -- required
AND authorizationsId = '{{ authorizationsId }}' -- required
;

list

Lists Authorizations in a given project and location.

SELECT
name,
clientUserId,
createTime,
scopes,
state,
updateTime
FROM google.agentidentity.authorizations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND authProvidersId = '{{ authProvidersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
;

DELETE examples

delete

Deletes a single Authorization.

DELETE FROM google.agentidentity.authorizations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND authProvidersId = '{{ authProvidersId }}' --required
AND authorizationsId = '{{ authorizationsId }}' --required
AND requestId = '{{ requestId }}'
;