How can we help you today?

Compass account and user management

Modified on: Wed, Jun 19, 2019 at 2:26 PM


This article describes a few typical account and user management tasks. For full documentation, please see the Compass API reference guide

 

To access the API, please go to compass.luminoso.com/api and login. Please note that Account and User management calls can only be executed by a site admin.

 

Create an Account

To create a new account use the POST /accounts/ endpoint and specify the name of the Account.

Once the Account is created, save the account id (“id”) to Notepad, especially if you are about to add users to the Account.


Create a User

To create a new user, use the POST /users/ endpoint and specify email, name, Default Account Id and whether the user is Admin.

Note: the email is the user id, and cannot be longer than 30 characters

The temporary password is returned by the call and should be saved so it can be shared with the user

If you forget to copy-and-paste the temporary password, you can reset it by using the POST /users/<email>/password/reset/ call.


 

Grant Permissions to a User

Before a user can use Compass, permissions must be granted.

To create a permission use use the POST /permissions/ endpoint and specify user’s email (id), account id and level (read, readwrite, manage)

Note: Permissions are granted to a user on a particular account, and if the users has access to multiple accounts, s/he can have different privileges.

Note: By default you should not give users admin access, as site admins have full access.


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.