Skip to main content

LocalAsyncAuthenticationServiceV2

Trait LocalAsyncAuthenticationServiceV2 

Source
pub trait LocalAsyncAuthenticationServiceV2 {
Show 15 methods // Required methods fn get_my_profile( &self, auth_: BearerToken, ) -> impl Future<Output = Result<UserV2, Error>>; fn update_my_profile( &self, auth_: BearerToken, update_my_profile_request: UpdateMyProfileRequest, ) -> impl Future<Output = Result<UserV2, Error>>; fn get_my_settings( &self, auth_: BearerToken, ) -> impl Future<Output = Result<UserSettings, Error>>; fn update_my_settings( &self, auth_: BearerToken, user_settings: UserSettings, ) -> impl Future<Output = Result<UserSettings, Error>>; fn get_my_org_settings( &self, auth_: BearerToken, ) -> impl Future<Output = Result<OrgSettings, Error>>; fn update_my_org_settings( &self, auth_: BearerToken, org_settings: OrgSettings, ) -> impl Future<Output = Result<OrgSettings, Error>>; fn search_users_v2( &self, auth_: BearerToken, request: SearchUsersRequest, ) -> impl Future<Output = Result<SearchUsersResponseV2, Error>>; fn get_users( &self, auth_: BearerToken, user_rids: BTreeSet<UserRid>, ) -> impl Future<Output = Result<BTreeSet<UserV2>, Error>>; fn get_user( &self, auth_: BearerToken, user_rid: UserRid, ) -> impl Future<Output = Result<UserV2, Error>>; fn get_jwks(&self) -> impl Future<Output = Result<Jwks, Error>>; fn generate_media_mtx_token( &self, auth_: BearerToken, request: GenerateMediaMtxTokenRequest, ) -> impl Future<Output = Result<GenerateMediaMtxTokenResponse, Error>>; fn batch_preregister_users( &self, auth_: BearerToken, request: BatchPreregisterUsersRequest, ) -> impl Future<Output = Result<BatchPreregisterUsersResponse, Error>>; fn list_org_login_activity( &self, auth_: BearerToken, request: ListOrgLoginActivityRequest, ) -> impl Future<Output = Result<ListOrgLoginActivityResponse, Error>>; fn deactivate_user( &self, auth_: BearerToken, user_rid: UserRid, ) -> impl Future<Output = Result<(), Error>>; fn reactivate_user( &self, auth_: BearerToken, user_rid: UserRid, ) -> impl Future<Output = Result<(), 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, ) -> impl Future<Output = Result<UserV2, Error>>

Gets the profile of the authenticated user.

Source

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

Updates the profile of the authenticated user.

Source

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

Gets the settings of the authenticated user.

Source

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

Updates the settings of the authenticated user.

Source

fn get_my_org_settings( &self, auth_: BearerToken, ) -> impl Future<Output = 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, ) -> impl Future<Output = Result<OrgSettings, Error>>

Updates the settings of the org of the authenticated user.

Source

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

Searches for users by email and displayName.

Source

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

Get users by RID. Returns objects for any of the requested RIDs that are members or guests of the caller’s org.

Source

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

Gets a user by RID. Throws if the requested RID is not a member or guest of the caller’s org.

Source

fn get_jwks(&self) -> impl Future<Output = Result<Jwks, Error>>

Returns JWKS (JSON Web Key Set) for MediaMTX JWT verification. Only available if MediaMTX integration is enabled.

Source

fn generate_media_mtx_token( &self, auth_: BearerToken, request: GenerateMediaMtxTokenRequest, ) -> impl Future<Output = Result<GenerateMediaMtxTokenResponse, Error>>

Generates a JWT token for MediaMTX authentication with a 2-hour expiration. The token is signed with the MediaMTX private key and contains the specified permissions. Requires authentication with Nominal. This endpoint is intended for internal use only.

Source

fn batch_preregister_users( &self, auth_: BearerToken, request: BatchPreregisterUsersRequest, ) -> impl Future<Output = Result<BatchPreregisterUsersResponse, Error>>

Batch preregister users in the caller’s organization. Only creates new users for emails that don’t already exist — existing accounts are silently skipped and not returned in the response. The caller must be an admin of the organization.

Source

fn list_org_login_activity( &self, auth_: BearerToken, request: ListOrgLoginActivityRequest, ) -> impl Future<Output = Result<ListOrgLoginActivityResponse, Error>>

Lists members of one or more orgs together with their most recent login into each org, sorted and paginated. The caller must be an admin of every org requested — defaults to the caller’s own org if none are specified.

Source

fn deactivate_user( &self, auth_: BearerToken, user_rid: UserRid, ) -> impl Future<Output = Result<(), Error>>

Deactivates a user in the caller’s organization, preventing them from obtaining new Nominal session tokens in that org. Also revokes all of the user’s API keys in the caller’s organization. Caller must be an admin of their org. Target user must be a member or guest of the org.

Source

fn reactivate_user( &self, auth_: BearerToken, user_rid: UserRid, ) -> impl Future<Output = Result<(), Error>>

Reactivates a user in the caller’s organization. Caller must be an admin of their org. Target user must be a member or guest of the org.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§