Struct gsuite_api::users::Users

pub struct Users {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Users

pub async fn directory_list(
    &self,
    customer: &str,
    domain: &str,
    event: Event,
    max_results: i64,
    order_by: DirectoryUsersListOrderBy,
    page_token: &str,
    projection: DirectoryUsersListProjection,
    query: &str,
    show_deleted: &str,
    sort_order: SortOrder,
    view_type: ViewType
) -> Result<Vec<User>>

This function performs a GET to the /admin/directory/v1/users endpoint.

Retrieves a paginated list of either deleted users or all users in a domain.

Parameters:

• custom_field_mask: &str – A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
• customer: &str – The unique ID for the customer’s Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. You can also use the my_customer alias to represent your account’s customerId. The customerId is also returned as part of the Users resource. Either the customer or the domain parameter must be provided.
• domain: &str – The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the customer query parameter instead. Either the customer or the domain parameter must be provided.
• event: crate::types::Event – Event on which subscription is intended (if subscribing).
• max_results: i64 – Maximum number of results to return.
• order_by: crate::types::DirectoryUsersListOrderBy – Property to use for sorting results.
• page_token: &str – Token to specify next page in the list.
• projection: crate::types::DirectoryUsersListProjection – What subset of fields to fetch for this user.
• query: &str – Query string for searching user fields. For more information on constructing user queries, see Search for Users.
• show_deleted: &str – If set to true, retrieves the list of deleted users. (Default: false).
• sort_order: crate::types::SortOrder – Whether to return results in ascending or descending order. Must be used with the orderBy parameter.
• view_type: crate::types::ViewType – Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see Retrieve a user as a non-administrator.

pub async fn directory_list_users(
    &self,
    customer: &str,
    domain: &str,
    event: Event,
    order_by: DirectoryUsersListOrderBy,
    projection: DirectoryUsersListProjection,
    query: &str,
    show_deleted: &str,
    sort_order: SortOrder,
    view_type: ViewType
) -> Result<Vec<User>>

This function performs a GET to the /admin/directory/v1/users endpoint.

As opposed to directory_list, this function returns all the pages of the request at once.

Retrieves a paginated list of either deleted users or all users in a domain.

pub async fn directory_insert(&self, body: &User) -> Result<User>

This function performs a POST to the /admin/directory/v1/users endpoint.

Creates a user.

pub async fn directory_watch(
    &self,
    customer: &str,
    domain: &str,
    event: Event,
    max_results: i64,
    order_by: DirectoryUsersListOrderBy,
    page_token: &str,
    projection: DirectoryUsersListProjection,
    query: &str,
    show_deleted: &str,
    sort_order: SortOrder,
    view_type: ViewType,
    body: &Channel
) -> Result<Channel>

This function performs a POST to the /admin/directory/v1/users/watch endpoint.

Watches for changes in users list.

Parameters:

• custom_field_mask: &str – Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
• customer: &str – Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
• domain: &str – Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.“.
• event: crate::types::Event – Event on which subscription is intended (if subscribing).
• max_results: i64 – Maximum number of results to return.
• order_by: crate::types::DirectoryUsersListOrderBy – Property to use for sorting results.
• page_token: &str – Token to specify next page in the list.
• projection: crate::types::DirectoryUsersListProjection – What subset of fields to fetch for this user.
• query: &str – Query string search. Should be of the form “”. Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users.
• show_deleted: &str – If set to true, retrieves the list of deleted users. (Default: false).
• sort_order: crate::types::SortOrder – Whether to return results in ascending or descending order. Must be used with the orderBy parameter.
• view_type: crate::types::ViewType – Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see Retrieve a user as a non-administrator.

pub async fn directory_get(
    &self,
    user_key: &str,
    projection: DirectoryUsersListProjection,
    view_type: ViewType
) -> Result<User>

This function performs a GET to the /admin/directory/v1/users/{userKey} endpoint.

Retrieves a user.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.
• custom_field_mask: &str – A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
• projection: crate::types::DirectoryUsersListProjection – What subset of fields to fetch for this user.
• view_type: crate::types::ViewType – Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see Retrieve a user as a non-administrator.

pub async fn directory_update(
    &self,
    user_key: &str,
    body: &User
) -> Result<User>

This function performs a PUT to the /admin/directory/v1/users/{userKey} endpoint.

Updates a user. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to null will be cleared.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.

pub async fn directory_delete(&self, user_key: &str) -> Result<()>

This function performs a DELETE to the /admin/directory/v1/users/{userKey} endpoint.

Deletes a user.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.

pub async fn directory_patch(&self, user_key: &str, body: &User) -> Result<User>

This function performs a PATCH to the /admin/directory/v1/users/{userKey} endpoint.

Updates a user using patch semantics. The update method should be used instead, since it also supports patch semantics and has better performance. This method is unable to clear fields that contain repeated objects (addresses, phones, etc). Use the update method instead.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.

pub async fn directory_aliases_list(
    &self,
    user_key: &str,
    event: DirectoryUsersAliasesListEvent
) -> Result<Aliases>

This function performs a GET to the /admin/directory/v1/users/{userKey}/aliases endpoint.

Lists all aliases for a user.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.
• event: crate::types::DirectoryUsersAliasesListEvent – Events to watch for.

pub async fn directory_aliases_insert(
    &self,
    user_key: &str,
    body: &Alias
) -> Result<Alias>

This function performs a POST to the /admin/directory/v1/users/{userKey}/aliases endpoint.

Adds an alias.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.

pub async fn directory_aliases_watch(
    &self,
    user_key: &str,
    event: DirectoryUsersAliasesListEvent,
    body: &Channel
) -> Result<Channel>

This function performs a POST to the /admin/directory/v1/users/{userKey}/aliases/watch endpoint.

Watches for changes in users list.

Parameters:

• user_key: &str – Email or immutable ID of the user.
• event: crate::types::DirectoryUsersAliasesListEvent – Events to watch for.

pub async fn directory_aliases_delete(
    &self,
    user_key: &str,
    alias: &str
) -> Result<()>

This function performs a DELETE to the /admin/directory/v1/users/{userKey}/aliases/{alias} endpoint.

Removes an alias.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.
• alias: &str – The alias to be removed.

pub async fn directory_make_admin(
    &self,
    user_key: &str,
    body: &UserMakeAdmin
) -> Result<()>

This function performs a POST to the /admin/directory/v1/users/{userKey}/makeAdmin endpoint.

Makes a user a super administrator.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.

pub async fn directory_photos_get(&self, user_key: &str) -> Result<UserPhoto>

This function performs a GET to the /admin/directory/v1/users/{userKey}/photos/thumbnail endpoint.

Retrieves the user’s photo.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.

pub async fn directory_photos_update(
    &self,
    user_key: &str,
    body: &UserPhoto
) -> Result<UserPhoto>

This function performs a PUT to the /admin/directory/v1/users/{userKey}/photos/thumbnail endpoint.

Adds a photo for the user.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.

pub async fn directory_photos_delete(&self, user_key: &str) -> Result<()>

This function performs a DELETE to the /admin/directory/v1/users/{userKey}/photos/thumbnail endpoint.

Removes the user’s photo.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.

pub async fn directory_photos_patch(
    &self,
    user_key: &str,
    body: &UserPhoto
) -> Result<UserPhoto>

This function performs a PATCH to the /admin/directory/v1/users/{userKey}/photos/thumbnail endpoint.

Adds a photo for the user. This method supports patch semantics.

Parameters:

• user_key: &str – Identifies the user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.

pub async fn directory_sign_out(&self, user_key: &str) -> Result<()>

This function performs a POST to the /admin/directory/v1/users/{userKey}/signOut endpoint.

Signs a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again.

Parameters:

• user_key: &str – Identifies the target user in the API request. The value can be the user’s primary email address, alias email address, or unique user ID.

pub async fn directory_undelete(
    &self,
    user_key: &str,
    body: &UserUndelete
) -> Result<()>

This function performs a POST to the /admin/directory/v1/users/{userKey}/undelete endpoint.

Undeletes a deleted user.

Parameters:

• user_key: &str – The immutable id of the user.