Struct FindUsersParams

pub struct FindUsersParams {
    pub query: Option<String>,
    pub username: Option<String>,
    pub account_id: Option<String>,
    pub start_at: Option<i32>,
    pub max_results: Option<i32>,
    pub property: Option<String>,
}

struct for passing parameters to the method find_users

Fields

query: Option<String>

A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute’s value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId or property is specified.

username: Option<String>

account_id: Option<String>

A query string that is matched exactly against a user accountId. Required, unless query or property is specified.

start_at: Option<i32>

The index of the first item to return in a page of results (page offset).

max_results: Option<i32>

The maximum number of items to return per page.

property: Option<String>

A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested from {\"something\":{\"nested\":1,\"other\":2}} use thepropertykey.something.nested=1. Required, unless accountId or query is specified.

Trait Implementations

impl Clone for FindUsersParams

fn clone(&self) -> FindUsersParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FindUsersParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.