Agent Identity API . projects . locations . accessSummaries

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets details of a single AccessSummary.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

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"`

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets details of a single AccessSummary.

Args:
  name: string, Required. Name of the resource (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing AccessSummary object
  "authProvider": "A String", # Output only. The auth_provider that this access summary is associated with.
  "authProviderType": "A String", # Output only. The type of the connector that was used to create this access summary.
  "firstAccessTime": "A String", # Output only. The first time this user has 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 has interacted with this workload. Rounded to the previous hour.
  "name": "A String", # Output only. Identifier. Name of the AccessSummary
  "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 AccessSummary. Will typically be an agentic spiffe id
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
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"`

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.
  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:

    { # Message for response to listing AccessSummaries
  "accessSummaries": [ # The list of AccessSummary
    { # Message describing AccessSummary object
      "authProvider": "A String", # Output only. The auth_provider that this access summary is associated with.
      "authProviderType": "A String", # Output only. The type of the connector that was used to create this access summary.
      "firstAccessTime": "A String", # Output only. The first time this user has 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 has interacted with this workload. Rounded to the previous hour.
      "name": "A String", # Output only. Identifier. Name of the AccessSummary
      "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 AccessSummary. Will typically be 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",
  ],
}
list_next()
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.