2026-02-10
▼ ▲ discoveryengine.projects.locations.collections.engines.setIamPolicy
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
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.
Location : path
Type : string
Required : Yes
HTTP Method : POST
Description : Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:setIamPolicy
Scopes :
Parameter Order : resource
Path : v1alpha/{+resource}:setIamPolicy
▼ ▲ discoveryengine.projects.locations.collections.engines.getIamPolicy
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:getIamPolicy
Scopes :
Parameter Order : resource
HTTP Method : GET
Description : Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
Path : v1alpha/{+resource}:getIamPolicy
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
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
Type : string
Required : Yes
options.requestedPolicyVersion
Type : integer
Format : int32
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).
▼ ▲ discoveryengine.projects.locations.completeExternalIdentities
Parameter Order : parent
Description : This method provides suggestions for users and groups managed in an external identity provider, based on the provided prefix.
Path : v1alpha/{+parent}:completeExternalIdentities
Scopes :
Parameters :
entityTypeFilter
Location : query
Type : string
Description : Optional. The type of entities to fetch. If not set, all entity types will be returned.
Enum :
Enum Descriptions :
maxSuggestions
Location : query
Type : integer
Description : Optional. The maximum number of user and group results to return. The service may return fewer than this value. If unspecified, at most 6 results will be returned. The limit is distributed as evenly as possible across users and groups. For example, if max_suggestions is 7, the service may return 4 users and 3 groups. If there are fewer suggestions of one type than half the limit, the other type may return more suggestions up to the max_suggestions limit.
Format : int32
parent
Description : Required. The parent location resource name, such as `projects/*/locations/global`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
prefixQuery
Type : string
Location : query
Description : Required. The prefix to search for. For users, this prefix is matched against the `primary_email`. For groups, this prefix is matched against the `display_name`. The matching is case-insensitive.
useScimIdentities
Type : boolean
Description : Optional. Whether to use scim identities for external identity completion. If false, we will call the Microsoft graph API to fetch the external identities.
Location : query
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}:completeExternalIdentities
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.suspendAgent
Scopes :
Parameters :
name
Type : string
Description : Required. The name of the Agent to suspend. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Location : path
suspensionReason
Type : string
Description : Required. The reason for suspending the Agent. This will be shown to the users of the Agent.
Location : query
Description : Suspends an Agent. It is still available for viewing but not for use. The `state` of the Agent becomes `SUSPENDED`. Can be called on an Agent in the state `ENABLED`, otherwise it returns an error.
Path : v1alpha/{+name}:suspendAgent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:suspendAgent
HTTP Method : POST
Parameter Order : name
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.setIamPolicy
Path : v1alpha/{+resource}:setIamPolicy
Scopes :
Parameters :
resource
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 : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
HTTP Method : POST
Parameter Order : resource
Description : Sets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. Policy can only contain `roles/discoveryengine.agentUser`, `roles/discoveryengine.agentViewer` and `roles/discoveryengine.agentEditor` roles.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:setIamPolicy
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.getIamPolicy
HTTP Method : GET
Scopes :
Path : v1alpha/{+resource}:getIamPolicy
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/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Required : Yes
Location : path
Type : string
options.requestedPolicyVersion
Location : query
Type : integer
Format : int32
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:getIamPolicy
Parameter Order : resource
Description : Gets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.disableAgent
HTTP Method : POST
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:disableAgent
Description : Disables an Agent. The `state` of the Agent becomes `DISABLED`. Can be called on an Agent in the state `ENABLED` or`SUSPENDED`, otherwise it returns an error.
Path : v1alpha/{+name}:disableAgent
Scopes :
Parameters :
name
Required : Yes
Description : Required. The name of the Agent to disable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
revisionId
Description : Optional. The Revision ID of the Agent to disable. If not specified, the latest revision will be disabled.
Location : query
Type : string
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.getAgentView
Path : v1alpha/{+name}:getAgentView
HTTP Method : GET
Parameter Order : name
Scopes :
Description : Returns a AgentView for a given Agent, which contains additional information about the Agent.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:getAgentView
Parameters :
languageCode
Description : Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentView in the response should be translated to this language.
Location : query
Type : string
maxSuggestedPrompts
Description : Optional. The maximum number of suggested prompts to return per agent.
Format : int32
Type : integer
Location : query
adminView
Description : Optional. Indicates whether to consider if the caller is an admin. If set, and the caller is an admin, the response will consider admin-only permissions. Otherwise, a caller with admin permissions will get a response as an unprivileged user.
Location : query
Type : boolean
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Required : Yes
Description : Required. The name of the Agent to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
Type : string
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.enableAgent
Parameter Order : name
Path : v1alpha/{+name}:enableAgent
Scopes :
Description : Enables an Agent. The `state` of the Agent becomes `ENABLED`. Can be called on an Agent in the state `DISABLED` or 'SUSPENDED', otherwise it returns an error.
Parameters :
revisionId
Description : Optional. The Revision ID of the Agent to enable. If not specified, the latest revision will be enabled.
Location : query
Type : string
name
Location : path
Required : Yes
Description : Required. The name of the Agent to enable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$
Type : string
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:enableAgent
▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.listAvailableAgentViews
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:listAvailableAgentViews
Path : v1alpha/{+parent}:listAvailableAgentViews
Description : Lists the data for displaying the Agents under an Assistant which are available to the caller.
Parameters :
adminView
Description : Optional. Indicates whether to consider if the caller is an admin. If set, and the caller is an admin, the response will consider admin-only permissions. Otherwise, a caller with admin permissions will get a response as an unprivileged user.
Type : boolean
Location : query
filter
Location : query
Description : Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Allowed fields are: * `display_name` * `state` Some examples of filters would be: * `display_name = 'agent_1'` * `display_name = 'agent_1' AND state = ENABLED` For a full description of the filter format, please see https://google.aip.dev/160.
Type : string
pageSize
Type : integer
Location : query
Format : int32
Description : Optional. Maximum number of AgentViews to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
languageCode
Type : string
Description : Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentViews in the response should be translated to this language.
Location : query
agentOrigin
Description : Optional. The origin of the Agent.
Enum :
Location : query
Type : string
Enum Descriptions :
parent
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$
Description : Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
Type : string
sortBy
Type : string
Description : Optional. The field to sort by. Can have the following values: - display-name: The display name of the agent. - description: The description of the agent. - create-time: The creation time of the agent. - state: The state of the agent.
Location : query
maxSuggestedPrompts
Format : int32
Location : query
Description : Optional. The maximum number of suggested prompts to return per agent.
Type : integer
pageToken
Type : string
Description : Optional. A page token ListAvailableAgentViewsResponse.next_page_token, received from a previous AgentService.ListAvailableAgentViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAvailableAgentViews must match the call that provided the page token.
Location : query
Parameter Order : parent
HTTP Method : POST
Scopes :