Class: ProvisioningClient

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/clients/provisioning_client.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



24
25
26
 
# File 'lib/lockstep_sdk/clients/provisioning_client.rb', line 24

def initialize(lockstepsdk)
    @lockstepsdk = lockstepsdk
end

Instance Method Details

#finalize_user_account_provisioning(body:) ⇒ 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



42
43
44
45
 
# File 'lib/lockstep_sdk/clients/provisioning_client.rb', line 42

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

#provision_free_developer_account(body:) ⇒ Object

Creates a new account for a developer, sending an email with information on how to access the API.

Parameters:

  • body (DeveloperAccountSubmitModel) 


50
51
52
53
 
# File 'lib/lockstep_sdk/clients/provisioning_client.rb', line 50

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

#provision_user_account(body:) ⇒ 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



33
34
35
36
 
# File 'lib/lockstep_sdk/clients/provisioning_client.rb', line 33

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