2026-07-23
▼ ▲ agentidentity.projects.locations.list
HTTP Method : GET
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.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations
Parameters :
extraLocationTypes
Type : string
Description : Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
Repeated : Yes
Location : query
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).
Location : query
Type : string
pageSize
Location : query
Description : The maximum number of results to return. If not set, the service selects a default.
Format : int32
Type : integer
pageToken
Location : query
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
name
Type : string
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Required : Yes
Location : path
Path : v1alpha/{+name}/locations
▼ ▲ agentidentity.projects.locations.get
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}
Parameters :
name
Description : Resource name for the location.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Description : Gets information about a location.
▼ ▲ agentidentity.projects.locations.authProviders.enable
Path : v1alpha/{+name}:enable
Parameters :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Description : Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:enable
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : POST
Description : Enables a single AuthProvider.
▼ ▲ agentidentity.projects.locations.authProviders.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
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).
Location : query
Type : string
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
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.
Format : google-fieldmask
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}
Path : v1alpha/{+name}
HTTP Method : PATCH
Description : Updates the parameters of a single AuthProvider.
Parameter Order : name
▼ ▲ agentidentity.projects.locations.authProviders.undelete
HTTP Method : POST
Description : Undeletes a single AuthProvider.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:undelete
Parameters :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Description : Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Type : string
Path : v1alpha/{+name}:undelete
▼ ▲ agentidentity.projects.locations.authProviders.getIamPolicy
Parameter Order : resource
HTTP Method : GET
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters :
resource
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
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
Format : int32
Type : integer
Location : query
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).
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:getIamPolicy
Path : v1alpha/{+resource}:getIamPolicy
▼ ▲ agentidentity.projects.locations.authProviders.create
Parameter Order : parent
HTTP Method : POST
Description : Creates a new AuthProvider in a given project and location.
Path : v1alpha/{+parent}/authProviders
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The parent resource where the AuthProvider is created. Format: projects/{project}/locations/{location}
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
requestId
Type : string
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).
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders
▼ ▲ agentidentity.projects.locations.authProviders.queryWorkloads
Parameters :
pageSize
Type : integer
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
pageToken
Type : string
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.
name
Type : string
Description : Required. The name of the auth_provider to query. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Required : Yes
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:queryWorkloads
Path : v1alpha/{+name}:queryWorkloads
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Description : Queries what all workloads are using a given auth_provider.
▼ ▲ agentidentity.projects.locations.authProviders.disable
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:disable
Parameters :
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Description : Required. Name of the resource Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Type : string
Path : v1alpha/{+name}:disable
HTTP Method : POST
Description : Disables a single AuthProvider.
Parameter Order : name
▼ ▲ agentidentity.projects.locations.authProviders.testIamPermissions
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}: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
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Path : v1alpha/{+resource}:testIamPermissions
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : resource
HTTP Method : POST
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.
▼ ▲ agentidentity.projects.locations.authProviders.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders
Parameters :
pageSize
Location : query
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Format : int32
Type : integer
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.
Location : query
Type : string
filter
Type : string
Description : Optional. Filter results. This field is currently ignored.
Location : query
showDeleted
Type : boolean
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.
Location : query
orderBy
Location : query
Description : Optional. Currently ignored. Defaults to ordering by auth_provider_id in ascending order.
Type : string
parent
Type : string
Description : Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Path : v1alpha/{+parent}/authProviders
HTTP Method : GET
Description : Lists AuthProviders in a given project and location.
Parameter Order : parent
▼ ▲ agentidentity.projects.locations.authProviders.revokeAuthorization
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Description : Required. The resource name of the AuthProvider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Required : Yes
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:revokeAuthorization
Path : v1alpha/{+name}:revokeAuthorization
HTTP Method : POST
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.
Parameter Order : name
▼ ▲ agentidentity.projects.locations.authProviders.query
HTTP Method : GET
Description : Queries what all auth_providers are used by a given workload_id.
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders:query
Parameters :
parent
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}
Type : string
workloadId
Type : string
Location : query
Description : Required. The workload identifier to filter by.
pageSize
Format : int32
Type : integer
Location : query
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.
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
Path : v1alpha/{+parent}/authProviders:query
▼ ▲ agentidentity.projects.locations.authProviders.setIamPolicy
Parameter Order : resource
HTTP Method : POST
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Path : v1alpha/{+resource}:setIamPolicy
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:setIamPolicy
Parameters :
resource
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
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
▼ ▲ agentidentity.projects.locations.authProviders.get
Path : v1alpha/{+name}
Parameters :
name
Type : string
Description : Required. Name of the resource
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Required : Yes
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Description : Gets details of a single AuthProvider.
▼ ▲ agentidentity.projects.locations.authProviders.delete
Parameter Order : name
HTTP Method : DELETE
Description : Deletes a single AuthProvider.
Parameters :
name
Description : Required. Name of the resource
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
requestId
Type : string
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).
Location : query
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}
Path : v1alpha/{+name}
▼ ▲ agentidentity.projects.locations.authProviders.authorizations.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
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
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$
Description : Required. The name of the Authorization to delete. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}
HTTP Method : DELETE
Description : Deletes a single Authorization.
Parameter Order : name
▼ ▲ agentidentity.projects.locations.authProviders.authorizations.list
Parameter Order : parent
HTTP Method : GET
Description : Lists Authorizations in a given project and location.
Parameters :
parent
Type : string
Description : Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$
Location : path
Required : Yes
orderBy
Type : string
Description : Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order.
Location : query
pageSize
Format : int32
Type : integer
Location : query
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken
Type : string
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.
Location : query
filter
Type : string
Location : query
Description : Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=""`
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations
Path : v1alpha/{+parent}/authorizations
▼ ▲ agentidentity.projects.locations.authProviders.authorizations.get
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. Name of the resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Description : Gets details of a single Authorization.
▼ ▲ agentidentity.projects.locations.accessSummaries.list
HTTP Method : GET
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"`
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/accessSummaries
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/accessSummaries
Parameters :
parent
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}
Type : string
orderBy
Description : Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.
Location : query
Type : string
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A token identifying a page of results the server should return.
Location : query
Type : string
filter
Type : string
Location : query
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=""`
▼ ▲ agentidentity.projects.locations.accessSummaries.get
Path : v1alpha/{+name}
Parameters :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/accessSummaries/[^/]+$
Description : Required. Name of the resource
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/accessSummaries/{accessSummariesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : GET
Description : Gets details of a single AccessSummary.