Create User

A new API user linked to an existing API application will be required to acquire an access token using the Authorization Code Flow.

If you only intend to use the Client Credentials Flow, you do NOT need to create an API user.

📘

Prerequisites

To successfully create a new API user within a Perspio tenant, you will need a user account with the administrator role. Contact [email protected] for any user account queries.

How to create a new API user

1. Click on an existing API application within Admin / API page

2. Click User Details, then 'Add API User' within Admin / API / App

3. New User Wizard (Details): Provide an email address for credential delivery.

4. New User Wizard (Access Level): Configure the desired permissions for the new user. You can select from the default Full Access and Read Only profiles, or configure a Custom profile as needed.

5. New User Wizard (Security Groups): Select the security groups you want to restrict the user access to. If no security groups are selected, the user will be able to access all system objects in the tenant.

6. New User Wizard (Confirmation) + Welcome Email (User Credentials): Record the username and password from the welcome email that was delivered to the address provided in the first step of the wizard.

So, please make note of the User Name (@perspio.io). The password for this login will be sent to the email id you provided at the beginning of this step. It will usually take around 5 minutes to receive the password to the email that you provided.

📘

Key Properties

• api username ([email protected])
• api password (**************************)

❗️

Important

These credentials can grant access to resources within your Perspio tenant. They must be kept secret and never used in publicly accessible code - this includes code repositories, distributed native application code and client-side code.

Once you have created your new user, you will need to record the key properties listed above to consume the PerspioTalk apis.