Skip to content

AcademIA Users

AcademIA Users manages the accounts of the AcademIA platform: you can search them, create new accounts with their role, and change the role, the organisation or the access of an existing account. It is the platform administrator’s tool.

It is useful for automatic onboarding and offboarding: creating the account of every new employee, learner or teacher, and suspending it when a person leaves the company.

When to use it

  • When a new person joins your Human Resources system, you want to create their AcademIA account with the corporate role.
  • When someone leaves the company, you want to suspend their access to AcademIA.
  • You need a list of the accounts with a given role, with their organisation, enrollments and certificates.
  • An admin assistant must be able to look up an account or create one when asked.

Configuration

You need an AcademIA credential with two details: AcademIA API address, the AcademIA API address (for example https://academia.nappai.es/api), and API key, an AcademIA API key (it starts with nappai_int_sk_live_). NappAI doesn’t ask for the email or password of any AcademIA account. See Credentials.

An AcademIA administrator creates the key with New key:

  • A Super admin, in Platform › API keys. In Acts as, choose the role the key works with (and its organisation or faculty, if the role needs one). For the voice evaluator and the course mentor, also tick Voice and mentor sessions.
  • A Corporate admin, in Advanced › API keys. That key acts as their company’s administrator and only sees their organisation.

AcademIA shows the key only once: copy it when you create it and paste it into API key. If someone revokes it in AcademIA, the flow stops getting in straight away and you need to create another one.

For this component, the credential’s key must act as a Super admin (SUPER_ADMIN), the platform administrator. To manage only the members of one company, a Corporate admin key is enough: use AcademIA Organization.

FieldWhat it does
Credential (required)The AcademIA credential. It fills in AcademIA API address and AcademIA API key for you.
ResourceAlways Users.
OperationList Users, Create User or Update User. See Resources and operations.

Resources and operations

Users (platform accounts)

OperationWhat it doesFields
List UsersReturns the accounts with their role, organisation, enrollments and certificates.Optional: Search (text in the name or email), Role (Any or a role) and Limit (default 500, at most 5,000).
Create UserCreates an account with a role, and with an organisation if the role is corporate.Email, Full name. Optional: Role, Organization ID and Password.
Update UserChanges the role, the organisation or the access of an account.User ID and at least one change in Role, Access or Organization ID.

The roles are FREE, STARTER, PRO, ELITE, CORPORATE_USER, CORPORATE_ADMIN, CONTENT_ADMIN, FACULTY_ADMIN and SUPER_ADMIN.

  • In Create User, Role is FREE by default. The CORPORATE_USER and CORPORATE_ADMIN roles need Organization ID.
  • Full name is the first name and surname, at least 2 characters.
  • Password is optional and must be at least 8 characters long. If you leave it empty, a random password is set and the person chooses theirs with AcademIA’s password recovery option. The account is created with the email already verified.
  • In Update User, Role set to Keep leaves the role as it is; Access can be Keep (no change), Suspend (blocks sign-in) or Reactivate (allows it again).
  • User ID is the account’s ID. List Users returns it in its id value.

Output

The Data output returns AcademIA’s answer as data: one item per account in List Users, and the account created or updated in the others.

The component supports Batch Mode and it can be connected to an Agent as a tool. See Tools.

Example

A company wants to remove AcademIA access for whoever leaves the staff.

  1. Your HR system notifies the flow through a Webhook Input with the email of the person leaving.
  2. Add AcademIA Users with the List Users operation and the email in Search.
  3. Connect Data to another AcademIA Users with the Update User operation: in User ID the id of the account found and in Access, Suspend.

Good practices

  • Search and Role filter among the accounts read. If you have many and can’t find one, raise Limit.
  • To sign up many people, leave Password empty: each one will choose their own.

Security and limitations

  • Don’t take the role from what a person types in a public form: decide the role yourself in the flow. Otherwise someone could give themselves SUPER_ADMIN or CONTENT_ADMIN.
  • Don’t type the same password for many people in the component.
  • A Super admin key can do anything in AcademIA: keep it only in the flows that need it.