Class UserSearchRequest

Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the .search path extension. The inclusion of .search on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in .search). The body of the POST request MAY include any of the parameters.

Inheritance

object

UserSearchRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.IdentitydomainsService.Models

Assembly: OCI.DotNetSDK.Identitydomains.dll

Syntax

public class UserSearchRequest

Properties

AttributeSets

Declaration

[JsonProperty(PropertyName = "attributeSets", ItemConverterType = typeof(StringEnumConverter))]
public List<AttributeSets> AttributeSets { get; set; }

Property Value

Type	Description
List<AttributeSets>	A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If "attributes" query parameter is also available, union of the two is fetched. Valid values : all, always, never, request, default. Values are case-insensitive. OPTIONAL.

Type

Description

List<AttributeSets>

A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If "attributes" query parameter is also available, union of the two is fetched. Valid values : all, always, never, request, default. Values are case-insensitive. OPTIONAL.

Attributes

Declaration

[JsonProperty(PropertyName = "attributes")]
public List<string> Attributes { get; set; }

Property Value

Type	Description
List<string>	A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation (Section 3.10) form. See (additional retrieval query parameters). OPTIONAL.

Count

Declaration

[JsonProperty(PropertyName = "count")]
public int? Count { get; set; }

Property Value

Type	Description
int?	An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). OPTIONAL.

Filter

Declaration

[JsonProperty(PropertyName = "filter")]
public string Filter { get; set; }

Property Value

Type	Description
string	The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See Section 3.4.2.2. OPTIONAL.

Schemas

Declaration

[Required(ErrorMessage = "Schemas is required.")]
[JsonProperty(PropertyName = "schemas")]
public List<string> Schemas { get; set; }

Property Value

Type	Description
List<string>	The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.

Remarks

Required

SortBy

Declaration

[JsonProperty(PropertyName = "sortBy")]
public string SortBy { get; set; }

Property Value

Type	Description
string	A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation (Section 3.10) form. See Sorting section. OPTIONAL.

SortOrder

Declaration

[JsonProperty(PropertyName = "sortOrder")]
[JsonConverter(typeof(StringEnumConverter))]
public SortOrder? SortOrder { get; set; }

Property Value

Type	Description
SortOrder?	A string that indicates the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending". See (Sorting Section). OPTIONAL.

StartIndex

Declaration

[JsonProperty(PropertyName = "startIndex")]
public int? StartIndex { get; set; }

Property Value

Type	Description
int?	An integer that indicates the 1-based index of the first query result. See Pagination Section. OPTIONAL.