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