nominal_api::authentication::api

Trait AuthenticationServiceV2

Source 
pub trait AuthenticationServiceV2 {
    // Required methods
    fn get_my_profile(&self, auth_: BearerToken) -> Result<UserV2, Error>;
    fn update_my_profile(
        &self,
        auth_: BearerToken,
        update_my_profile_request: UpdateMyProfileRequest,
    ) -> Result<UserV2, Error>;
    fn get_my_settings(&self, auth_: BearerToken) -> Result<UserSettings, Error>;
    fn update_my_settings(
        &self,
        auth_: BearerToken,
        user_settings: UserSettings,
    ) -> Result<UserSettings, Error>;
    fn get_my_org_settings(
        &self,
        auth_: BearerToken,
    ) -> Result<OrgSettings, Error>;
    fn update_my_org_settings(
        &self,
        auth_: BearerToken,
        org_settings: OrgSettings,
    ) -> Result<OrgSettings, Error>;
    fn search_users_v2(
        &self,
        auth_: BearerToken,
        request: SearchUsersRequest,
    ) -> Result<SearchUsersResponseV2, Error>;
    fn get_users(
        &self,
        auth_: BearerToken,
        user_rids: BTreeSet<UserRid>,
    ) -> Result<BTreeSet<UserV2>, Error>;
    fn get_user(
        &self,
        auth_: BearerToken,
        user_rid: UserRid,
    ) -> Result<UserV2, Error>;
}
Expand description

This service provides operations for managing user and org profiles/settings. Its name is a bit of a misnomer.

Required Methods§

Source

fn get_my_profile(&self, auth_: BearerToken) -> Result<UserV2, Error>

Gets the profile of the authenticated user.

Source

fn update_my_profile( &self, auth_: BearerToken, update_my_profile_request: UpdateMyProfileRequest, ) -> Result<UserV2, Error>

Updates the profile of the authenticated user.

Source

fn get_my_settings(&self, auth_: BearerToken) -> Result<UserSettings, Error>

Gets the settings of the authenticated user.

Source

fn update_my_settings( &self, auth_: BearerToken, user_settings: UserSettings, ) -> Result<UserSettings, Error>

Updates the settings of the authenticated user.

Source

fn get_my_org_settings(&self, auth_: BearerToken) -> Result<OrgSettings, Error>

Gets the settings of the org of the authenticated user.

Source

fn update_my_org_settings( &self, auth_: BearerToken, org_settings: OrgSettings, ) -> Result<OrgSettings, Error>

Updates the settings of the org of the authenticated user.

Source

fn search_users_v2( &self, auth_: BearerToken, request: SearchUsersRequest, ) -> Result<SearchUsersResponseV2, Error>

Searches for users by email and displayName.

Source

fn get_users( &self, auth_: BearerToken, user_rids: BTreeSet<UserRid>, ) -> Result<BTreeSet<UserV2>, Error>

Get users by RID.

Source

fn get_user( &self, auth_: BearerToken, user_rid: UserRid, ) -> Result<UserV2, Error>

Gets a user by RID.

Implementors§