access_summaries
Creates, updates, deletes, gets or lists an access_summaries resource.
Overview
| Name | access_summaries |
| Type | Resource |
| Id | google.agentidentity.access_summaries |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
name | string | Output only. Identifier. Name of the AccessSummary |
authProvider | string | Output only. The auth_provider that this access summary is associated with. |
authProviderType | string | Output only. The type of the connector that was used to create this access summary. (AUTH_PROVIDER_TYPE_UNSPECIFIED, AUTH_PROVIDER_TYPE_THREE_LEGGED_OAUTH, AUTH_PROVIDER_TYPE_TWO_LEGGED_OAUTH, AUTH_PROVIDER_TYPE_API_KEY, AUTH_PROVIDER_TYPE_GEMINI_ENTERPRISE) |
firstAccessTime | string (google-datetime) | Output only. The first time this user has interacted with this workload. Rounded to the previous hour. |
labels | object | Optional. Labels as key value pairs |
lastAccessTime | string (google-datetime) | Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour. |
purgeTime | string (google-datetime) | Output only. The time when this access summary is permanently deleted. |
scopes | array | Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200. |
tokenUrl | string | Output only. The url of the authentication server that was accessed. |
userId | string | Output only. The user_id provided by the workload application for this user. Not verified by Google. |
workloadId | string | Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id |
| Name | Datatype | Description |
|---|---|---|
name | string | Output only. Identifier. Name of the AccessSummary |
authProvider | string | Output only. The auth_provider that this access summary is associated with. |
authProviderType | string | Output only. The type of the connector that was used to create this access summary. (AUTH_PROVIDER_TYPE_UNSPECIFIED, AUTH_PROVIDER_TYPE_THREE_LEGGED_OAUTH, AUTH_PROVIDER_TYPE_TWO_LEGGED_OAUTH, AUTH_PROVIDER_TYPE_API_KEY, AUTH_PROVIDER_TYPE_GEMINI_ENTERPRISE) |
firstAccessTime | string (google-datetime) | Output only. The first time this user has interacted with this workload. Rounded to the previous hour. |
labels | object | Optional. Labels as key value pairs |
lastAccessTime | string (google-datetime) | Output only. The most recent time this user has interacted with this workload. Rounded to the previous hour. |
purgeTime | string (google-datetime) | Output only. The time when this access summary is permanently deleted. |
scopes | array | Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200. |
tokenUrl | string | Output only. The url of the authentication server that was accessed. |
userId | string | Output only. The user_id provided by the workload application for this user. Not verified by Google. |
workloadId | string | Output only. The identity bound to the workload that this user interacted with to produce this AccessSummary. Will typically be an agentic spiffe id |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | projectsId, locationsId, accessSummariesId | Gets details of a single AccessSummary. | |
list | select | projectsId, locationsId | filter, pageSize, orderBy, pageToken | Lists AccessSummaries in a given project and location. Supported Filters: - workload_id: Filter by the SPIFFE ID of the agent. Example: workload_id="spiffe://example.com/ns/default/sa/my-agent" |
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 |
|---|---|---|
accessSummariesId | string | |
locationsId | string | |
projectsId | string | |
filter | string | |
orderBy | string | |
pageSize | integer (int32) | |
pageToken | string |
SELECT examples
- get
- list
Gets details of a single AccessSummary.
SELECT
name,
authProvider,
authProviderType,
firstAccessTime,
labels,
lastAccessTime,
purgeTime,
scopes,
tokenUrl,
userId,
workloadId
FROM google.agentidentity.access_summaries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND accessSummariesId = '{{ accessSummariesId }}' -- required
;
Lists AccessSummaries in a given project and location. Supported Filters: - workload_id: Filter by the SPIFFE ID of the agent. Example: workload_id="spiffe://example.com/ns/default/sa/my-agent"
SELECT
name,
authProvider,
authProviderType,
firstAccessTime,
labels,
lastAccessTime,
purgeTime,
scopes,
tokenUrl,
userId,
workloadId
FROM google.agentidentity.access_summaries
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
;