Struct InviteLinkAdminClient 

pub struct InviteLinkAdminClient {
    pub(crate) key_store: KeyStore<KeySlotIds>,
    pub(crate) api_configurations: Arc<ApiConfigurations>,
}

Client for organization invite link administrative (organization-key) operations: creating, refreshing, updating, deleting, and inspecting invite links, and recovering the invite secret.

Fields

key_store: KeyStore<KeySlotIds>

api_configurations: Arc<ApiConfigurations>

Implementations

impl InviteLinkAdminClient

pub async fn get( &self, organization_id: OrganizationId, ) -> Result<Option<OrganizationInviteLinkView>, InviteLinkError>

Get an existing invite link.

pub async fn delete( &self, organization_id: OrganizationId, ) -> Result<(), InviteLinkError>

Delete an existing invite link.

pub async fn create( &self, organization_id: OrganizationId, allowed_domains: Vec<String>, supports_confirmation: bool, ) -> Result<OrganizationInviteLinkView, InviteLinkError>

Creates a new organization invite link.

pub async fn refresh( &self, organization_id: OrganizationId, supports_confirmation: bool, ) -> Result<OrganizationInviteLinkView, InviteLinkError>

Refreshes an existing invite link.

pub async fn update_allowed_domains( &self, organization_id: OrganizationId, allowed_domains: Vec<String>, ) -> Result<OrganizationInviteLinkView, InviteLinkError>

Updates the allowed domains for an existing organization invite link.

pub async fn update_confirmation( &self, organization_id: OrganizationId, supports_confirmation: bool, ) -> Result<OrganizationInviteLinkView, InviteLinkError>

Updates whether an existing invite link supports confirmation.

If supports_confirmation is true, users gain immediate access to the organization. If supports_confirmation is false, admins need to confirm all new users.

Does not break the URL of the existing invite link.

pub async fn set_invite_confirmation( &self, organization_id: OrganizationId, invite: Invite, supports_confirmation: bool, ) -> Result<OrganizationInviteLink, InviteLinkError>

👎Deprecated:

Use update_confirmation, which returns an OrganizationInviteLinkView, instead

Updates whether an existing invite link supports confirmation, re-sealing the given invite accordingly and persisting it to the server.

Enabling confirmation re-seals the organization key under the invite’s existing invite key; disabling it strips that envelope. Either way the invite key, code, and secret are left untouched, so links already handed out stay valid. Use InviteLinkAdminClient::refresh instead when the code and secret must be rotated.

Security

Only the re-sealed invite is posted to the server; the invite secret is never sent.

pub async fn create_invite_link( &self, organization_id: OrganizationId, allowed_domains: Vec<String>, supports_confirmation: bool, ) -> Result<OrganizationInviteLink, InviteLinkError>

👎Deprecated:

Use create, which returns an OrganizationInviteLinkView, instead

Creates a new organization invite and posts it to the server, returning the full OrganizationInviteLink persisted by the server.

Security

Only the sealed invite is posted to the server; the invite secret is never sent. Use InviteLinkAdminClient::get_invite_secret to recover the secret needed to reconstruct the invite link.

pub async fn refresh_invite_link( &self, organization_id: OrganizationId, supports_confirmation: bool, ) -> Result<OrganizationInviteLink, InviteLinkError>

👎Deprecated:

Use refresh, which returns an OrganizationInviteLinkView, instead

Refresh an existing invite link. This generates a new code and secret.

pub fn get_invite_secret( &self, organization_id: OrganizationId, invite: Invite, ) -> Result<InviteSecret, InviteLinkError>

👎Deprecated:

Use create or refresh, which returns an OrganizationInviteLinkView, instead

Using the organization key, recovers the [InviteSecret] from the invite carried in the given OrganizationInviteLink so an admin can reconstruct the invite link.

Trait Implementations

impl FromClient for InviteLinkAdminClient

fn from_client(client: &Client) -> InviteLinkAdminClient

Construct this type from a [Client] reference.

impl FromWasmAbi for InviteLinkAdminClient

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> InviteLinkAdminClient

Recover a Self from Self::Abi.

impl IntoWasmAbi for InviteLinkAdminClient

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for InviteLinkAdminClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<InviteLinkAdminClient>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <InviteLinkAdminClient as LongRefFromWasmAbi>::Abi, ) -> <InviteLinkAdminClient as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for InviteLinkAdminClient

fn is_none(abi: &<InviteLinkAdminClient as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for InviteLinkAdminClient

fn none() -> <InviteLinkAdminClient as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for InviteLinkAdminClient

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<InviteLinkAdminClient>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi( js: <InviteLinkAdminClient as RefFromWasmAbi>::Abi, ) -> <InviteLinkAdminClient as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for InviteLinkAdminClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<InviteLinkAdminClient>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <InviteLinkAdminClient as RefMutFromWasmAbi>::Abi, ) -> <InviteLinkAdminClient as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for InviteLinkAdminClient

fn try_from_js_value(value: JsValue) -> Result<InviteLinkAdminClient, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<InviteLinkAdminClient>

Performs the conversion.

impl VectorFromWasmAbi for InviteLinkAdminClient

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi( js: <InviteLinkAdminClient as VectorFromWasmAbi>::Abi, ) -> Box<[InviteLinkAdminClient]>

impl VectorIntoWasmAbi for InviteLinkAdminClient

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi( vector: Box<[InviteLinkAdminClient]>, ) -> <InviteLinkAdminClient as VectorIntoWasmAbi>::Abi