2026-07-23
▼ ▲ agentidentity.projects.locations.list
Parameter Order : name
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations
Description : Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Parameters :
extraLocationTypes
Location : query
Description : Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
Repeated : Yes
Type : string
name
Description : The resource that owns the locations collection, if applicable.
Type : string
Required : Yes
Pattern : ^projects/[^/]+$
Location : path
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Type : string
Location : query
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Type : string
Location : query
pageSize
Format : int32
Description : The maximum number of results to return. If not set, the service selects a default.
Type : integer
Location : query
Path : v1beta/{+name}/locations
▼ ▲ agentidentity.projects.locations.get
Parameter Order : name
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}
Parameters :
name
Description : Resource name for the location.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Gets information about a location.
Path : v1beta/{+name}
▼ ▲ agentidentity.projects.locations.accessSummaries.list
HTTP Method : GET
Parameter Order : parent
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/accessSummaries
Description : 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 :
orderBy
Location : query
Description : Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.
Type : string
pageToken
Location : query
Description : Optional. A token identifying a page of results the server should return.
Type : string
filter
Description : 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=""`
Type : string
Location : query
parent
Required : Yes
Description : Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
Format : int32
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+parent}/accessSummaries
▼ ▲ agentidentity.projects.locations.accessSummaries.get
Parameter Order : name
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/accessSummaries/{accessSummariesId}
Description : Gets details of a single AccessSummary.
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/accessSummaries/[^/]+$
Required : Yes
Description : Required. Name of the resource
Type : string
Path : v1beta/{+name}
▼ ▲ agentidentity.projects.locations.authProviders.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+parent}/authProviders
Parameters :
parent
Required : Yes
Description : Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
pageSize
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
Location : query
showDeleted
Location : query
Description : Optional. Deleted auth_providers will be kept with a soft-delete for 30 days before being purged. If this field is set to true, deleted auth_providers will also be returned.
Type : boolean
pageToken
Description : Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned.
Type : string
Location : query
filter
Location : query
Description : Optional. Filter results. This field is currently ignored.
Type : string
orderBy
Location : query
Description : Optional. Currently ignored. Defaults to ordering by auth_provider_id in ascending order.
Type : string
Description : Lists AuthProviders in a given project and location.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders
HTTP Method : GET
Parameter Order : parent
▼ ▲ agentidentity.projects.locations.authProviders.enable
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Location : path
Required : Yes
Description : Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Type : string
Description : Enables a single AuthProvider.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+name}:enable
HTTP Method : POST
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:enable
▼ ▲ agentidentity.projects.locations.authProviders.setIamPolicy
HTTP Method : POST
Parameter Order : resource
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Location : path
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type : string
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+resource}:setIamPolicy
▼ ▲ agentidentity.projects.locations.authProviders.undelete
Parameter Order : name
HTTP Method : POST
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:undelete
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Location : path
Description : Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Type : string
Required : Yes
Description : Undeletes a single AuthProvider.
Path : v1beta/{+name}:undelete
▼ ▲ agentidentity.projects.locations.authProviders.get
HTTP Method : GET
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}
Parameters :
name
Required : Yes
Description : Required. Name of the resource
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Location : path
Description : Gets details of a single AuthProvider.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+name}
▼ ▲ agentidentity.projects.locations.authProviders.queryWorkloads
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:queryWorkloads
Parameter Order : name
HTTP Method : GET
Path : v1beta/{+name}:queryWorkloads
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Queries what all workloads are using a given auth_provider.
Parameters :
pageSize
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
Location : query
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Required : Yes
Description : Required. The name of the auth_provider to query. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Type : string
pageToken
Location : query
Description : Optional. A token, which can be sent as `page_token` to retrieve the next page. When paginating, all other parameters provided to QueryWorkloads must match the call that provided the page token. If this field is omitted, the first page is returned.
Type : string
▼ ▲ agentidentity.projects.locations.authProviders.create
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders
HTTP Method : POST
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+parent}/authProviders
Parameters :
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Location : query
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. The parent resource where the AuthProvider is created. Format: projects/{project}/locations/{location}
Type : string
authProviderId
Location : query
Description : Required. The ID to use for the AuthProvider, which will become the final segment of the AuthProvider's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number.
Type : string
Description : Creates a new AuthProvider in a given project and location.
▼ ▲ agentidentity.projects.locations.authProviders.delete
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}
Parameter Order : name
HTTP Method : DELETE
Path : v1beta/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single AuthProvider.
Parameters :
requestId
Location : query
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
name
Required : Yes
Description : Required. Name of the resource
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Location : path
▼ ▲ agentidentity.projects.locations.authProviders.query
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders:query
HTTP Method : GET
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+parent}/authProviders:query
Description : Queries what all auth_providers are used by a given workload_id.
Parameters :
workloadId
Description : Required. The workload identifier to filter by.
Type : string
Location : query
pageSize
Format : int32
Description : 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.
Type : integer
Location : query
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}
Type : string
pageToken
Location : query
Description : Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, the first page is returned. A page token, received from a previous QueryAuthProviders call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryAuthProviders must match the call that provided the page token.
Type : string
▼ ▲ agentidentity.projects.locations.authProviders.patch
HTTP Method : PATCH
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}
Parameters :
name
Description : Identifier. The full resource name of the auth_provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
updateMask
Location : query
Format : google-fieldmask
Description : Optional. Field mask is used to specify the fields to be overwritten in the AuthProvider resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
Type : string
requestId
Location : query
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Description : Updates the parameters of a single AuthProvider.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+name}
▼ ▲ agentidentity.projects.locations.authProviders.testIamPermissions
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+resource}:testIamPermissions
HTTP Method : POST
Parameter Order : resource
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:testIamPermissions
▼ ▲ agentidentity.projects.locations.authProviders.getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+resource}:getIamPolicy
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Location : path
Required : Yes
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type : string
options.requestedPolicyVersion
Location : query
Format : int32
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type : integer
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:getIamPolicy
HTTP Method : GET
Parameter Order : resource
▼ ▲ agentidentity.projects.locations.authProviders.disable
Path : v1beta/{+name}:disable
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Disables a single AuthProvider.
Parameters :
name
Description : Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Location : path
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:disable
Parameter Order : name
HTTP Method : POST
▼ ▲ agentidentity.projects.locations.authProviders.revokeAuthorization
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:revokeAuthorization
Parameter Order : name
HTTP Method : POST
Path : v1beta/{+name}:revokeAuthorization
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Revokes all authorizations for a specific user on an AuthProvider. This deletes all authorization records associated with the user and AuthProvider, effectively revoking access across all agents.
Parameters :
name
Required : Yes
Description : Required. The resource name of the AuthProvider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Location : path
▼ ▲ agentidentity.projects.locations.authProviders.authorizations.delete
HTTP Method : DELETE
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}
Description : Deletes a single Authorization.
Parameters :
requestId
Location : query
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
name
Description : Required. The name of the Authorization to delete. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta/{+name}
▼ ▲ agentidentity.projects.locations.authProviders.authorizations.list
Parameter Order : parent
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Location : path
Description : Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Type : string
Required : Yes
pageSize
Location : query
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
Format : int32
pageToken
Location : query
Description : Optional. A page token, received from a previous `ListAuthorizations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAuthorizations` must match the call that provided the page token.
Type : string
filter
Location : query
Description : Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=""`
Type : string
orderBy
Description : Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order.
Type : string
Location : query
Description : Lists Authorizations in a given project and location.
Path : v1beta/{+parent}/authorizations
▼ ▲ agentidentity.projects.locations.authProviders.authorizations.get
Parameter Order : name
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$
Location : path
Required : Yes
Description : Required. Name of the resource
Type : string
Description : Gets details of a single Authorization.
Path : v1beta/{+name}