Accounts

Accounts

Under the “Accounts” tab in the left-hand menu, you have the option of creating new accounts manually, as well as editing, deleting, and searching for accounts.

Screenshot 2024-09-17 at 15.36.10.png
  • An account is the top-level resource representing an end-user who can authenticate themselves. For authentication of the end-user, an account either has an email and password, or an identity attached. Candidates and recommendations are tied to an account.

  • Accounts can be created in two ways: in the frontend by the end-user or in the backend by a Candidacy user or admin. Usually, accounts will be created in the frontend by the end-user.

Screenshot 2024-09-17 at 15.40.35.png

When you click on the “Accounts” tab on the left-hand side menu, you are met with the accounts overview page.

In this page, you can find the following fields:

  • Search bar: The search bar at the top allows you to search for accounts by their email.

  • Id: This is a unique ID number that the system creates for every account. This information is static and cannot be changed or removed.

  • Identity: This shows the identity corresponding to the account, ie. the identity that the end-user used to create their account.

    • The blue arrow next to the identity name will redirect you to their Identity overview.

    • This field will only appear when identities are required for creating an account, registering as a candidate or recommending a candidate. Read more about this here.

  • Email: Shows the email address connected to the account (ie. the email address used by the end-user to create an account).

  • Access locked?: Shows whether the account is locked or unlocked (“true” for locked, “false” for unlocked).

  • SSO name: Shows a Single-Sign On id value associated to the identity. This will show up when an external sign-in method is used to create the account.

  • Created at: Shows the time and date of creation of the account.

  • Current sign in at: Shows the latest time and date of when the end-user signed into their account.

If you click on the blue and underlined fields, the data will be displayed in ascending (shown with an arrow pointing up) or descending (shown with an arrow pointing down) order according to that column. Note that you can only order the data by one field at a time.

To create an account manually in the backend, start by clicking on the Screenshot 2024-09-23 at 12.46.07.png button and selecting “New Account”.

Screenshot 2024-09-23 at 12.45.22.png

You will then be met with the following fields:

Screenshot 2024-09-23 at 12.46.30.png
  • Email: Write the email belonging to the end-user. Once the account is created, an email will be sent to the end-user inviting them to the Candidacy frontend.

  • Locale: This allows you to select the language in which the email sent to the end-user will be. Note that the locales available are dependent on the locales chosen for your candidacy site.

  • Identity: Choose an identity to link to the account. This identity needs to have already been created or imported into the system - read more on this here.

 

Edit account

You can edit an account at any point. To edit an account, select the specific account by clicking on its corresponding Screenshot 2024-09-23 at 13.00.24.png button in the “Accounts” overview page. Inside the specific account page, click Screenshot 2024-09-23 at 13.00.54.png.

 

Delete account

An account may be deleted at any time by clicking on Screenshot 2024-09-23 at 13.01.26.png button inside the specific account page. You can access any account through the corresponding Screenshot 2024-09-23 at 13.00.24.png button in the “Accounts” overview page.

 

An account gets locked in the case when end-users insert the wrong credentials while signing in too many times. When this happens, the end-user will no longer be able to access the account in the frontend. It is possible to lock and unlock an account at any point. By default, all accounts will be unlocked.

To lock/unlock an account:

  1. Go to the “Accounts” overview page.

  2. Click on the Screenshot 2024-09-23 at 13.00.24.png button of the specific account you wish to lock/unlock.

  3. Then select the Screenshot 2024-09-23 at 15.16.39.png button to lock the account or the Screenshot 2024-09-23 at 15.16.26.png button to unlock the account.

     

End-users can request to unlock accounts, to read more on this process go to the End-user flow: Unlock account guide.