{ "rootUrl": "https://agentidentity.googleapis.com/", "ownerDomain": "google.com", "discoveryVersion": "v1", "description": "", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "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.", "path": "v1beta/{+name}/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": { "type": "string", "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" }, "name": { "pattern": "^projects/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The resource that owns the locations collection, if applicable." }, "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "agentidentity.projects.locations.list", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations", "httpMethod": "GET", "response": { "$ref": "ListLocationsResponse" } }, "get": { "description": "Gets information about a location.", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Resource name for the location.", "location": "path" } }, "response": { "$ref": "Location" }, "id": "agentidentity.projects.locations.get", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET" } }, "resources": { "accessSummaries": { "methods": { "list": { "parameters": { "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string", "location": "query" }, "orderBy": { "type": "string", "description": "Optional. This field is currently ignored. Defaults to ordering by (auth_provider_id, user_id) in ascending order.", "location": "query" }, "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" }, "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. The maximum page size is 1000.", "location": "query" }, "parent": { "description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "description": "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\"`", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListAccessSummariesResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/accessSummaries", "id": "agentidentity.projects.locations.accessSummaries.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/accessSummaries" }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/accessSummaries/[^/]+$", "required": true, "location": "path", "description": "Required. The resource name of the access summary.", "type": "string" } }, "description": "Gets details of a single access summary.", "id": "agentidentity.projects.locations.accessSummaries.get", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/accessSummaries/{accessSummariesId}", "path": "v1beta/{+name}", "response": { "$ref": "AccessSummary" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "authProviders": { "methods": { "query": { "description": "Queries which auth providers are used by a given workload ID.", "parameters": { "workloadId": { "type": "string", "description": "Required. The workload identifier to filter by.", "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": { "type": "string", "description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path" }, "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" } }, "response": { "$ref": "QueryAuthProvidersResponse" }, "path": "v1beta/{+parent}/authProviders:query", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders:query", "parameterOrder": [ "parent" ], "id": "agentidentity.projects.locations.authProviders.query", "httpMethod": "GET" }, "enable": { "path": "v1beta/{+name}:enable", "description": "Enables a single auth provider.", "httpMethod": "POST", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "description": "Required. The resource name of the auth provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", "type": "string" } }, "id": "agentidentity.projects.locations.authProviders.enable", "parameterOrder": [ "name" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:enable", "request": { "$ref": "EnableAuthProviderRequest" }, "response": { "$ref": "AuthProvider" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { "id": "agentidentity.projects.locations.authProviders.getIamPolicy", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "httpMethod": "GET", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "resource": { "required": true, "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", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$" }, "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)." } }, "parameterOrder": [ "resource" ], "path": "v1beta/{+resource}:getIamPolicy" }, "disable": { "httpMethod": "POST", "parameterOrder": [ "name" ], "description": "Disables a single auth provider.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:disable", "response": { "$ref": "AuthProvider" }, "request": { "$ref": "DisableAuthProviderRequest" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the auth provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}" } }, "id": "agentidentity.projects.locations.authProviders.disable", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}:disable" }, "revokeAuthorization": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "RevokeAuthorizationRequest" }, "id": "agentidentity.projects.locations.authProviders.revokeAuthorization", "httpMethod": "POST", "path": "v1beta/{+name}:revokeAuthorization", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:revokeAuthorization", "description": "Revokes all authorizations for a specific user on an auth provider. This deletes all authorization records associated with the user and auth provider, effectively revoking access across all agents.", "parameters": { "name": { "description": "Required. The resource name of the auth provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$" } }, "response": { "$ref": "RevokeAuthorizationResponse" }, "parameterOrder": [ "name" ] }, "list": { "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}", "required": true }, "orderBy": { "location": "query", "description": "Optional. Currently ignored. Defaults to ordering by auth_provider_id in ascending order.", "type": "string" }, "filter": { "description": "Optional. Filter results. This field is currently ignored.", "type": "string", "location": "query" }, "showDeleted": { "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", "location": "query" }, "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." }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "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." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Lists auth providers in a given project and location.", "id": "agentidentity.projects.locations.authProviders.list", "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders", "path": "v1beta/{+parent}/authProviders", "response": { "$ref": "ListAuthProvidersResponse" } }, "create": { "path": "v1beta/{+parent}/authProviders", "httpMethod": "POST", "description": "Creates a new auth provider in a given project and location.", "request": { "$ref": "AuthProvider" }, "id": "agentidentity.projects.locations.authProviders.create", "response": { "$ref": "AuthProvider" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent resource where the auth provider is created. Format: projects/{project}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "authProviderId": { "location": "query", "type": "string", "description": "Required. The ID to use for the auth provider, which will become the final segment of the auth provider'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": { "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)." } } }, "delete": { "id": "agentidentity.projects.locations.authProviders.delete", "description": "Deletes a single auth provider.", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "parameters": { "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 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)." }, "name": { "type": "string", "required": true, "description": "Required. The resource name of the auth provider.", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", "path": "v1beta/{+name}" }, "resolveAuthorization": { "request": { "$ref": "ResolveAuthorizationRequest" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1beta/{+name}:resolveAuthorization", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:resolveAuthorization", "response": { "$ref": "ResolveAuthorizationResponse" }, "description": "Resolves an authorization for a user on an auth provider, creating one if it does not exist or returning an existing one.", "parameters": { "name": { "required": true, "description": "Required. The name of the auth provider to resolve authorization for. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "type": "string", "location": "path" } }, "id": "agentidentity.projects.locations.authProviders.resolveAuthorization" }, "undelete": { "path": "v1beta/{+name}:undelete", "parameters": { "name": { "required": true, "description": "Required. The resource name of the auth provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$" } }, "request": { "$ref": "UndeleteAuthProviderRequest" }, "description": "Undeletes a single auth provider.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "AuthProvider" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:undelete", "id": "agentidentity.projects.locations.authProviders.undelete", "httpMethod": "POST" }, "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", "parameterOrder": [ "name" ], "response": { "$ref": "AuthProvider" }, "description": "Gets details of a single auth provider.", "httpMethod": "GET", "path": "v1beta/{+name}", "id": "agentidentity.projects.locations.authProviders.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "required": true, "description": "Required. The resource name of the auth provider.", "type": "string", "location": "path" } } }, "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "AuthProvider" }, "path": "v1beta/{+name}", "description": "Updates the parameters of a single auth provider.", "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "description": "Optional. Field mask is used to specify the fields to be overwritten in the auth provider 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", "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)." }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "type": "string", "description": "Identifier. The full resource name of the auth provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", "location": "path" } }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "AuthProvider" }, "httpMethod": "PATCH", "id": "agentidentity.projects.locations.authProviders.patch" }, "queryWorkloads": { "httpMethod": "GET", "id": "agentidentity.projects.locations.authProviders.queryWorkloads", "path": "v1beta/{+name}:queryWorkloads", "parameterOrder": [ "name" ], "description": "Queries which workloads are using a given auth provider.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:queryWorkloads", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "QueryWorkloadsResponse" }, "parameters": { "pageToken": { "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.", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "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." }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the auth provider to query. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}" } } }, "setIamPolicy": { "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.", "required": true, "type": "string" } }, "path": "v1beta/{+resource}: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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "SetIamPolicyRequest" }, "httpMethod": "POST", "id": "agentidentity.projects.locations.authProviders.setIamPolicy", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:setIamPolicy", "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" } }, "testIamPermissions": { "id": "agentidentity.projects.locations.authProviders.testIamPermissions", "parameterOrder": [ "resource" ], "path": "v1beta/{+resource}:testIamPermissions", "httpMethod": "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "TestIamPermissionsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:testIamPermissions", "parameters": { "resource": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "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": true } }, "request": { "$ref": "TestIamPermissionsRequest" } } }, "resources": { "authorizations": { "methods": { "testIamPermissions": { "httpMethod": "POST", "response": { "$ref": "TestIamPermissionsResponse" }, "id": "agentidentity.projects.locations.authProviders.authorizations.testIamPermissions", "path": "v1beta/{+resource}:testIamPermissions", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "parameters": { "resource": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", "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": true } }, "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "getIamPolicy": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}:getIamPolicy", "id": "agentidentity.projects.locations.authProviders.authorizations.getIamPolicy", "httpMethod": "GET", "response": { "$ref": "Policy" }, "path": "v1beta/{+resource}:getIamPolicy", "parameterOrder": [ "resource" ], "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": { "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", "format": "int32", "type": "integer" }, "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.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameterOrder": [ "name" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta/{+name}", "description": "Deletes a single authorization.", "parameters": { "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 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)." }, "name": { "description": "Required. The resource name of the authorization to delete. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", "location": "path" } }, "id": "agentidentity.projects.locations.authProviders.authorizations.delete", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}", "response": { "$ref": "Empty" } }, "setIamPolicy": { "request": { "$ref": "SetIamPolicyRequest" }, "httpMethod": "POST", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}:setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Policy" }, "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": "v1beta/{+resource}:setIamPolicy", "id": "agentidentity.projects.locations.authProviders.authorizations.setIamPolicy", "parameterOrder": [ "resource" ], "parameters": { "resource": { "type": "string", "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.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$" } } }, "get": { "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource name of the authorization.", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", "required": true } }, "description": "Gets details of a single authorization.", "response": { "$ref": "Authorization" }, "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}", "parameterOrder": [ "name" ], "id": "agentidentity.projects.locations.authProviders.authorizations.get", "httpMethod": "GET" }, "list": { "path": "v1beta/{+parent}/authorizations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "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", "location": "query" }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "required": true, "description": "Required. The parent resource where the search is performed. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "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." }, "filter": { "type": "string", "description": "Optional. Filter string to restrict the results. Currently supports filtering by `client_user_id` only. Format: `client_user_id=\"\"`", "location": "query" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. This field is currently ignored. Defaults to ordering by authorization_id in ascending order." } }, "response": { "$ref": "ListAuthorizationsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations", "httpMethod": "GET", "id": "agentidentity.projects.locations.authProviders.authorizations.list", "description": "Lists authorizations in a given project and location.", "parameterOrder": [ "parent" ] } } } } } } } } } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "ownerName": "Google", "version": "v1beta", "basePath": "", "version_module": true, "schemas": { "QueryWorkloadsResponse": { "id": "QueryWorkloadsResponse", "description": "Response message for `QueryWorkloads`.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results." }, "workloadIds": { "items": { "type": "string" }, "type": "array", "description": "The unique list of identifiers for the agents that used this auth provider, starting with `principal://`." } } }, "Policy": { "properties": { "etag": { "format": "byte", "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "type": "string" }, "bindings": { "type": "array", "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "items": { "$ref": "Binding" } }, "version": { "format": "int32", "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. 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" }, "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", "type": "array", "items": { "$ref": "AuditConfig" } } }, "type": "object", "id": "Policy", "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/)." }, "AuditConfig": { "id": "AuditConfig", "type": "object", "properties": { "service": { "type": "string", "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services." }, "auditLogConfigs": { "items": { "$ref": "AuditLogConfig" }, "type": "array", "description": "The configuration for logging of each type of permission." } }, "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging." }, "CrossAppAccessAuthProvider": { "properties": { "additionalParameters": { "description": "Optional. Additional parameters to be passed to the token endpoint.", "type": "object", "additionalProperties": { "type": "string" } }, "clientAssertionJwtAuth": { "$ref": "ClientAssertionJwtAuth", "description": "Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT." }, "customIssuer": { "$ref": "CustomIssuer", "description": "Configuration when using a custom or third-party authorization server as the issuer." }, "googleAccount": { "$ref": "GoogleAccount", "description": "Configuration when using Google Accounts as the issuer." }, "clientSecretAuth": { "$ref": "ClientSecretAuth", "description": "Option 1: Authenticate using a standard `client_id` and `client_secret`." }, "workforceIdentityFederation": { "description": "Configuration when using Workforce Identity Federation as the issuer.", "$ref": "WorkforceIdentityFederation" }, "idTokenInput": { "$ref": "IdTokenProcessingConfig", "description": "Configuration for when the input is an ID token." }, "idJagInput": { "$ref": "DirectIdJagInput", "description": "Configuration for when the input is already an ID-JAG." } }, "id": "CrossAppAccessAuthProvider", "type": "object", "description": "Configuration parameters for the Cross-App Access auth provider." }, "IdTokenProcessingConfig": { "type": "object", "description": "Defines how to process an input ID token to obtain an ID-JAG.", "id": "IdTokenProcessingConfig", "properties": { "idJagAdditionalClaims": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "Optional. Optional additional claims to include when fetching an ID-JAG." }, "idJagAuthProvider": { "description": "The resource name of the ID-JAG auth provider. Format: \"projects/{project}/locations/{location}/authProviders/{auth_provider}\"", "type": "string" }, "agentIdentityPool": { "description": "Indicates the managed Agent Identity pool should be used to fetch the ID-JAG.", "$ref": "AgentIdentityPool" } } }, "Expr": { "properties": { "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "location": { "type": "string", "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file." }, "expression": { "type": "string", "description": "Textual representation of an expression in Common Expression Language syntax." } }, "id": "Expr", "type": "object", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information." }, "ResolveAuthorizationRequest": { "description": "Request message for `ResolveAuthorization`.", "id": "ResolveAuthorizationRequest", "type": "object", "properties": { "clientUserId": { "description": "Required. The user ID of the client for whom the authorization is resolved.", "type": "string" } } }, "AuthProviderTypeParams": { "description": "Required. Parameters specific to the auth provider type.", "properties": { "twoLeggedOauth": { "$ref": "TwoLeggedOAuth", "description": "Parameters for 2-legged OAuth (2LO) authentication." }, "threeLeggedOauth": { "$ref": "ThreeLeggedOAuth", "description": "Parameters for 3-legged OAuth (3LO) authentication." }, "connectorReferenceAuthProvider": { "description": "Parameters for Connector Reference authentication.", "$ref": "ConnectorReferenceAuthProvider" }, "xaaAuthProvider": { "description": "Parameters for Cross-App Access authentication.", "$ref": "CrossAppAccessAuthProvider" }, "apiKey": { "description": "Parameters for API key authentication.", "$ref": "ApiKeyParams" }, "geAuthProvider": { "description": "Parameters for Gemini Enterprise authentication.", "$ref": "GeminiEnterpriseAuthProviderParams" } }, "id": "AuthProviderTypeParams", "type": "object" }, "GoogleAccount": { "id": "GoogleAccount", "description": "Configuration for Google Account usage as the issuer.", "type": "object", "properties": {} }, "AuthProvider": { "type": "object", "id": "AuthProvider", "description": "Represents an auth provider.", "properties": { "state": { "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "ENABLED", "DISABLED" ], "description": "Output only. The state of the auth provider.", "enumDescriptions": [ "Unspecified state.", "Enabled and can be used.", "Disabled and cannot be used." ] }, "deleted": { "readOnly": true, "description": "Output only. Set to `true` if the auth provider is deleted.", "type": "boolean" }, "expireTime": { "description": "Output only. The time when the auth provider will expire.", "readOnly": true, "format": "google-datetime", "type": "string" }, "authProviderTypeParams": { "$ref": "AuthProviderTypeParams", "description": "Required. Parameters specific to the auth provider type." }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. Labels as key-value pairs.", "type": "object" }, "allowedScopes": { "items": { "type": "string" }, "description": "Optional. List of scopes that are allowed to be requested for this auth provider. If this list is non-empty, only scopes within this list may be requested. If this list is empty, all scopes may be requested. Scopes appearing in `blocked_scopes` are disallowed even if they appear in `allowed_scopes`. The number of allowed scopes is limited to 200.", "type": "array" }, "updateTime": { "description": "Output only. The update timestamp.", "type": "string", "format": "google-datetime", "readOnly": true }, "name": { "type": "string", "description": "Identifier. The full resource name of the auth provider. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The creation timestamp.", "format": "google-datetime" }, "description": { "description": "Optional. Description of the resource. Must be less than 256 characters.", "type": "string" }, "workloadIds": { "items": { "type": "string" }, "description": "Optional. Input only. Identifiers for the agents that will use this auth provider, starting with `principal://`. For example: `principal://agents.global.org-${ORG_ID}.system.id.goog/resources/aiplatform/projects/{PROJECT_ID}/locations/{LOCATIONS}/reasoningEngines/{ID}`", "type": "array" }, "blockedScopes": { "description": "Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200.", "items": { "type": "string" }, "type": "array" } } }, "SetIamPolicyRequest": { "properties": { "updateMask": { "format": "google-fieldmask", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", "type": "string" }, "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "Policy" } }, "type": "object", "id": "SetIamPolicyRequest", "description": "Request message for `SetIamPolicy` method." }, "AuditLogConfig": { "type": "object", "properties": { "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" }, "type": "array" }, "logType": { "type": "string", "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ], "description": "The log type that this config enables.", "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ] } }, "id": "AuditLogConfig", "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging." }, "DirectIdJagInput": { "description": "Marker message indicating the input is already an ID-JAG, so no fetching is required.", "type": "object", "properties": {}, "id": "DirectIdJagInput" }, "RevokeAuthorizationRequest": { "type": "object", "properties": { "userId": { "description": "Required. The identity of the user to revoke authorization for.", "type": "string" } }, "id": "RevokeAuthorizationRequest", "description": "Request message for `RevokeAuthorization`." }, "ThreeLeggedOAuth": { "description": "Configuration for 3-legged OAuth (3LO) authentication.", "properties": { "redirectUrl": { "readOnly": true, "type": "string", "description": "Output only. The redirect URL this auth provider uses for the OAuth exchange. This is deterministic based on the name of the auth provider." }, "clientId": { "type": "string", "description": "Optional. The client ID of the OAuth client." }, "clientSecret": { "description": "Optional. Input only. The client secret of the OAuth client.", "type": "string" }, "enablePkce": { "type": "boolean", "description": "Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks." }, "authorizationUrl": { "description": "Optional. The authorization endpoint to send users to for consenting to delegate to the agent. For example, \"https://auth.atlassian.com/authorize\".", "type": "string" }, "tokenUrl": { "type": "string", "description": "Optional. The token endpoint for requesting tokens on behalf of an end user. For example, \"https://auth.atlassian.com/oauth/token\"." }, "defaultContinueUri": { "type": "string", "description": "Optional. The default continue URI for the 3LO flow, used when no continue URI is provided in the RetrieveCredentials request." } }, "id": "ThreeLeggedOAuth", "type": "object" }, "ClientAssertionJwtAuth": { "id": "ClientAssertionJwtAuth", "description": "Configuration for client ID and client assertion JWT authentication.", "properties": { "clientId": { "description": "Required. The client identifier.", "type": "string" } }, "type": "object" }, "DisableAuthProviderRequest": { "id": "DisableAuthProviderRequest", "properties": { "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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." } }, "type": "object", "description": "Request message for `DisableAuthProvider`." }, "Empty": { "properties": {}, "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "id": "Empty" }, "ListLocationsResponse": { "properties": { "locations": { "items": { "$ref": "Location" }, "type": "array", "description": "A list of locations that matches the specified filter in the request." }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "type": "object", "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse" }, "WorkforceIdentityFederation": { "properties": {}, "description": "Configuration for Workforce Identity Federation usage as the issuer.", "id": "WorkforceIdentityFederation", "type": "object" }, "ClientSecretAuth": { "description": "Configuration for client ID and client secret authentication.", "properties": { "clientSecret": { "type": "string", "description": "Required. Input only. The client secret." }, "clientId": { "description": "Required. The client identifier.", "type": "string" } }, "type": "object", "id": "ClientSecretAuth" }, "ListAuthorizationsResponse": { "id": "ListAuthorizationsResponse", "properties": { "authorizations": { "description": "The list of authorizations.", "type": "array", "items": { "$ref": "Authorization" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "description": "Response message for `ListAuthorizations`.", "type": "object" }, "Authorization": { "properties": { "updateTime": { "description": "Output only. The update timestamp.", "format": "google-datetime", "type": "string", "readOnly": true }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The creation timestamp." }, "clientUserId": { "type": "string", "readOnly": true, "description": "Output only. The client user ID provided by the client application for their end user. Not verified by Google." }, "state": { "readOnly": true, "description": "Output only. The state of the authorization.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "SUSPENDED" ], "enumDescriptions": [ "Unspecified state.", "Active.", "Suspended." ] }, "name": { "type": "string", "description": "Identifier. The resource name of the authorization." }, "scopes": { "description": "Output only. The scopes actually granted by the end user during the consent flow.", "type": "array", "readOnly": true, "items": { "type": "string" } } }, "description": "Represents an authorization.", "type": "object", "id": "Authorization" }, "RevokeAuthorizationResponse": { "id": "RevokeAuthorizationResponse", "description": "Response message for `RevokeAuthorization`.", "type": "object", "properties": {} }, "AccessSummary": { "properties": { "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. Labels as key-value pairs." }, "userId": { "readOnly": true, "description": "Output only. The user ID provided by the workload application for this user. Not verified by Google.", "type": "string" }, "name": { "type": "string", "description": "Output only. Identifier. The resource name of the access summary.", "readOnly": true }, "purgeTime": { "readOnly": true, "description": "Output only. The time when this access summary is permanently deleted.", "type": "string", "format": "google-datetime" }, "authProvider": { "type": "string", "readOnly": true, "description": "Output only. The auth provider that this access summary is associated with." }, "workloadId": { "description": "Output only. The identity bound to the workload that this user interacted with to produce this access summary. Typically an agentic SPIFFE ID.", "type": "string", "readOnly": true }, "lastAccessTime": { "format": "google-datetime", "type": "string", "description": "Output only. The most recent time this user interacted with this workload, rounded to the previous hour.", "readOnly": true }, "tokenUrl": { "readOnly": true, "description": "Output only. The URL of the authentication server that was accessed.", "type": "string" }, "scopes": { "readOnly": true, "description": "Output only. All scopes that have been used by this user with this workload. The number of scopes is limited to 200.", "type": "array", "items": { "type": "string" } }, "authProviderType": { "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified auth provider type.", "3-legged OAuth (3LO) auth provider type.", "2-legged OAuth (2LO) auth provider type.", "API key auth provider type.", "Gemini Enterprise auth provider type.", "Cross-App Access auth provider type.", "Connector Reference auth provider type." ], "enum": [ "AUTH_PROVIDER_TYPE_UNSPECIFIED", "AUTH_PROVIDER_TYPE_THREE_LEGGED_OAUTH", "AUTH_PROVIDER_TYPE_TWO_LEGGED_OAUTH", "AUTH_PROVIDER_TYPE_API_KEY", "AUTH_PROVIDER_TYPE_GEMINI_ENTERPRISE", "AUTH_PROVIDER_TYPE_CROSS_APP_ACCESS", "AUTH_PROVIDER_TYPE_CONNECTOR_REFERENCE" ], "description": "Output only. The auth provider type used to create this access summary." }, "firstAccessTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The first time this user interacted with this workload, rounded to the previous hour.", "type": "string" } }, "type": "object", "description": "Represents an access summary.", "id": "AccessSummary" }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "type": "object", "id": "Binding", "properties": { "role": { "type": "string", "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles)." }, "condition": { "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "$ref": "Expr" }, "members": { "items": { "type": "string" }, "type": "array", "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`." } } }, "AgentIdentityPool": { "type": "object", "description": "Marker message to indicate the managed Agent Identity Pool is used.", "properties": {}, "id": "AgentIdentityPool" }, "GeminiEnterpriseAuthProviderParams": { "description": "Configuration for Gemini Enterprise authentication.", "type": "object", "id": "GeminiEnterpriseAuthProviderParams", "properties": {} }, "EnableAuthProviderRequest": { "type": "object", "description": "Request message for `EnableAuthProvider`.", "id": "EnableAuthProviderRequest", "properties": { "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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" } } }, "CustomIssuer": { "properties": { "tokenUrl": { "type": "string", "description": "Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens." }, "issuer": { "description": "Optional. The issuer identifier of the target Authorization Server.", "type": "string" } }, "id": "CustomIssuer", "description": "Configuration for a custom or third-party authorization server issuer.", "type": "object" }, "ListAuthProvidersResponse": { "id": "ListAuthProvidersResponse", "type": "object", "properties": { "authProviders": { "items": { "$ref": "AuthProvider" }, "description": "The list of auth providers.", "type": "array" }, "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Unordered list. Locations that could not be reached." } }, "description": "Response message for `ListAuthProviders`." }, "ListAccessSummariesResponse": { "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "accessSummaries": { "type": "array", "items": { "$ref": "AccessSummary" }, "description": "The list of access summaries." }, "unreachable": { "type": "array", "description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" } } }, "description": "Response message for `ListAccessSummaries`.", "type": "object", "id": "ListAccessSummariesResponse" }, "ApiKeyParams": { "properties": { "apiKey": { "description": "Optional. Input only. The API key for this auth provider.", "type": "string" } }, "type": "object", "description": "Configuration for API key authentication.", "id": "ApiKeyParams" }, "TestIamPermissionsResponse": { "description": "Response message for `TestIamPermissions` method.", "id": "TestIamPermissionsResponse", "properties": { "permissions": { "items": { "type": "string" }, "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array" } }, "type": "object" }, "TestIamPermissionsRequest": { "properties": { "permissions": { "items": { "type": "string" }, "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "type": "array" } }, "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", "type": "object" }, "ResolveAuthorizationResponse": { "type": "object", "properties": { "authorization": { "description": "The resource name of the resolved authorization. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}", "type": "string" } }, "id": "ResolveAuthorizationResponse", "description": "Response message for `ResolveAuthorization`." }, "UndeleteAuthProviderRequest": { "properties": { "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. 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": "Request message for `UndeleteAuthProvider`.", "id": "UndeleteAuthProviderRequest", "type": "object" }, "QueryAuthProvidersResponse": { "description": "Response message for `QueryAuthProviders`.", "properties": { "authProviderNames": { "items": { "type": "string" }, "type": "array", "description": "The unique list of auth provider resource names used by the workload." }, "nextPageToken": { "description": "A token identifying a page of results the server should return. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object", "id": "QueryAuthProvidersResponse" }, "ConnectorReferenceAuthProvider": { "properties": { "authorizationDetails": { "description": "Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "connector": { "description": "Required. The name of the referenced connector.", "type": "string" } }, "description": "Configuration parameters for the Connector Reference auth provider.", "id": "ConnectorReferenceAuthProvider", "type": "object" }, "Location": { "properties": { "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" }, "type": "object" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" } }, "type": "object", "description": "A resource that represents a Google Cloud location.", "id": "Location" }, "TwoLeggedOAuth": { "description": "Configuration for 2-legged OAuth (2LO) authentication.", "properties": { "clientId": { "description": "Optional. The client ID of the OAuth client.", "type": "string" }, "tokenUrl": { "description": "Optional. The token endpoint of the OAuth client.", "type": "string" }, "clientSecret": { "type": "string", "description": "Optional. Input only. The client secret of the OAuth client." } }, "id": "TwoLeggedOAuth", "type": "object" } }, "name": "agentidentity", "documentationLink": "https://cloud.google.com/iam/docs/", "id": "agentidentity:v1beta", "mtlsRootUrl": "https://agentidentity.mtls.googleapis.com/", "servicePath": "", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "kind": "discovery#restDescription", "parameters": { "key": { "type": "string", "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "alt": { "description": "Data format for response.", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "location": "query", "type": "string" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "description": "V1 error format.", "enum": [ "1", "2" ], "type": "string" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query", "type": "boolean" }, "quotaUser": { "location": "query", "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" } }, "fullyEncodeReservedExpansion": true, "revision": "20261008", "protocol": "rest", "canonicalName": "Agent Identity", "batchPath": "batch", "title": "Agent Identity API", "baseUrl": "https://agentidentity.googleapis.com/" }