| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="agentidentity_v1.html">Agent Identity API</a> . <a href="agentidentity_v1.projects.html">projects</a> . <a href="agentidentity_v1.projects.locations.html">locations</a> . <a href="agentidentity_v1.projects.locations.accessSummaries.html">accessSummaries</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of a single access summary.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists access summaries 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"`</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets details of a single access summary. |
| |
| Args: |
| name: string, Required. The resource name of the access summary. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an access summary. |
| "authProvider": "A String", # Output only. The auth provider that this access summary is associated with. |
| "authProviderType": "A String", # Output only. The auth provider type used to create this access summary. |
| "firstAccessTime": "A String", # Output only. The first time this user interacted with this workload, rounded to the previous hour. |
| "labels": { # Optional. Labels as key-value pairs. |
| "a_key": "A String", |
| }, |
| "lastAccessTime": "A String", # Output only. The most recent time this user interacted with this workload, rounded to the previous hour. |
| "name": "A String", # Output only. Identifier. The resource name of the access summary. |
| "purgeTime": "A String", # Output only. The time when this access summary is permanently deleted. |
| "scopes": [ # Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200. |
| "A String", |
| ], |
| "tokenUrl": "A String", # Output only. The URL of the authentication server that was accessed. |
| "userId": "A String", # Output only. The user ID provided by the workload application for this user. Not verified by Google. |
| "workloadId": "A String", # Output only. The identity bound to the workload that this user interacted with to produce this access summary. Typically an agentic SPIFFE ID. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists access summaries 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"` |
| |
| Args: |
| parent: string, Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location} (required) |
| filter: string, Optional. Filter string to restrict the results. Currently supports filtering by `workload_id` or `auth_provider_name`. If no filter is provided, returns all access summaries for the requested project and location. Format: `workload_id=""` or `auth_provider_name=""` |
| orderBy: string, Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order. |
| pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum page size is 1000. |
| pageToken: string, Optional. A token identifying a page of results the server should return. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for `ListAccessSummaries`. |
| "accessSummaries": [ # The list of access summaries. |
| { # Represents an access summary. |
| "authProvider": "A String", # Output only. The auth provider that this access summary is associated with. |
| "authProviderType": "A String", # Output only. The auth provider type used to create this access summary. |
| "firstAccessTime": "A String", # Output only. The first time this user interacted with this workload, rounded to the previous hour. |
| "labels": { # Optional. Labels as key-value pairs. |
| "a_key": "A String", |
| }, |
| "lastAccessTime": "A String", # Output only. The most recent time this user interacted with this workload, rounded to the previous hour. |
| "name": "A String", # Output only. Identifier. The resource name of the access summary. |
| "purgeTime": "A String", # Output only. The time when this access summary is permanently deleted. |
| "scopes": [ # Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200. |
| "A String", |
| ], |
| "tokenUrl": "A String", # Output only. The URL of the authentication server that was accessed. |
| "userId": "A String", # Output only. The user ID provided by the workload application for this user. Not verified by Google. |
| "workloadId": "A String", # Output only. The identity bound to the workload that this user interacted with to produce this access summary. Typically an agentic SPIFFE ID. |
| }, |
| ], |
| "nextPageToken": "A String", # A token identifying a page of results the server should return. |
| "unreachable": [ # Unordered list. Locations that could not be reached. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
