Use-case

The User account provisioning API serves the following use-case:

• Administrators create roles, manage the permissions associated with them, and create and manage teams, from within the Alcméon user interface.
• When a new Agent is provisioned within a call center's IT system, these backoffice systems automatically create a user account within Alcméon, via the API, associated with one or more pre-specified roles and teams.
• When an Agent is de-provisioned within a call center's IT system, these backoffice systems automatically de-activate the corresponding account within Alcméon, via the API.
• When an Agent logs into Alcméon for the first time, they can setup their password via the I forgot my password link. Alternatively, it is possible to setup a SSO to delegate identification and authentication to a SAML IdP.

Step by step

1. Log into Alcméon as an administrator, create the role(s) that will be associated with the accounts you wish to manage. Keep track of the role name. Create the team(s) that will be associated with the accounts you wish to manage. Keep track of the team name.
2. GET /roles to retrieve the role_ids associated with the role names.
3. GET /teams to retrieve the team_ids associated with the team names.
4. To provision a new Agent, POST /accounts.
5. To deprovision an Agent, POST /accounts/{account_id}