Method: UserAccountsClient#invite_user

Defined in:
lib/lockstep_sdk/clients/user_accounts_client.rb

#invite_user(body:) ⇒ Object

Invite a user with the specified email to join your accounting group. The user will receive an email to set up their account.

A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox. A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account. All Users must validate their email to make use of Lockstep platform services. Users may have different privileges and access control rights within the Lockstep Platform.

Parameters:

  • body (InviteSubmitModel) —

    The user to invite



71
72
73
74
 
# File 'lib/lockstep_sdk/clients/user_accounts_client.rb', line 71

def invite_user(body:)
    path = "/api/v1/UserAccounts/invite"
    @connection.request(:post, path, body, nil)
end