Class ProjectsResource.LocationsResource.CompleteExternalIdentitiesRequest

This method provides suggestions for users and groups managed in an external identity provider, based on the provided prefix. See CompleteExternalIdentitiesRequest.prefix_query for the fields matched during completion.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse>
DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse>
ProjectsResource.LocationsResource.CompleteExternalIdentitiesRequest
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class ProjectsResource.LocationsResource.CompleteExternalIdentitiesRequest : DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse>, IClientServiceRequest<GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse>, IClientServiceRequest

Constructors

CompleteExternalIdentitiesRequest(IClientService, string)

Constructs a new CompleteExternalIdentities request.

Declaration
public CompleteExternalIdentitiesRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

EntityTypeFilter

Optional. The type of entities to fetch. If not set, all entity types will be returned.

Declaration
[RequestParameter("entityTypeFilter", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.CompleteExternalIdentitiesRequest.EntityTypeFilterEnum? EntityTypeFilter { get; set; }
Property Value
Type Description
ProjectsResource.LocationsResource.CompleteExternalIdentitiesRequest.EntityTypeFilterEnum?

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MaxSuggestions

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.

Declaration
[RequestParameter("maxSuggestions", RequestParameterType.Query)]
public virtual int? MaxSuggestions { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Parent

Required. The parent location resource name, such as projects/*/locations/global.

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

PrefixQuery

Required. The prefix to search for. The matching is case-insensitive. * Users: * Supported: primary_email (SCIM emails[type=work] only), given_name, and family_name by leading prefix, and display_name per word. * Not supported: subject, external_id, and SCIM userName (not stored; only used to derive subject when google.subject maps user.userName). * Groups: * Supported: display_name per word.

Declaration
[RequestParameter("prefixQuery", RequestParameterType.Query)]
public virtual string PrefixQuery { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

UseScimIdentities

Optional. Whether to use scim identities for external identity completion. If false, we will call the Microsoft graph API to fetch the external identities.

Declaration
[RequestParameter("useScimIdentities", RequestParameterType.Query)]
public virtual bool? UseScimIdentities { get; set; }
Property Value
Type Description
bool?

Methods

InitParameters()

Initializes CompleteExternalIdentities parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements