Class: ProvisioningClient

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/clients/provisioning.rb

Instance Method Summary collapse

Constructor Details

#initialize(lockstepsdk) ⇒ ProvisioningClient

Initialize the ProvisioningClient class with a lockstepsdk instance.

Parameters:

  • lockstepsdk (LockstepApi) —

    The Lockstep API client object for this connection



22
23
24
 
# File 'lib/lockstep_sdk/clients/provisioning.rb', line 22

def initialize(lockstepsdk)
    @lockstepsdk = lockstepsdk
end

Instance Method Details

#finalize_user_account_provisioning ⇒ Object

Updates user, company and group metadata for a User of status 'Onboarding' and finalizes a user's onboarding process by changing the user status to 'Active'

Parameters:

  • body (ProvisioningFinalizeRequestModel) —

    Represents a User and their related metadata



38
39
40
41
 
# File 'lib/lockstep_sdk/clients/provisioning.rb', line 38

def ()
    path = "/api/v1/Provisioning/finalize"
    @lockstepsdk.request(:post, path, body, nil)
end

#provision_free_developer_account ⇒ Object 



43
44
45
46
 
# File 'lib/lockstep_sdk/clients/provisioning.rb', line 43

def ()
    path = "/api/v1/Provisioning/free-account"
    @lockstepsdk.request(:post, path, body, nil)
end

#provision_user_account ⇒ Object

Creates a new User or updates an Invited user based on metadata provided by the User during the onboarding process

Parameters:

  • body (ProvisioningModel) —

    Represents a User and their related metadata



30
31
32
33
 
# File 'lib/lockstep_sdk/clients/provisioning.rb', line 30

def ()
    path = "/api/v1/Provisioning"
    @lockstepsdk.request(:post, path, body, nil)
end