In this lesson, you will learn how to grant and manage user access to Cyclr Accounts.
What are Users?
Users in Cyclr enable your end users to access Cyclr in a limited capacity. Alternatively, you can use them to provide your application access to a Cyclr Account on your customers’ behalf via the Cyclr User API.
Account users can have two different access levels to their Account in Cyclr: “Administrator” or “Access.” With administrator-level access, a user can manage the Account, update the Account settings and invite new users.
A user who is not an administrator can still access the Account, build and tweak integration cycles and store them in the Account. However, their access is limited, and they cannot invite new users or change any Account settings.
You can give a single user access to several Accounts or sub-accounts, with different access levels for each. It is important to note that giving a user access to a parent Account does not automatically give them access to sub-accounts, or vice versa, whether they are an administrator or not. You can, for example, give a user access to the main Account and one sub-account, and only give them administrative rights to the sub-account.
Console Users
It’s important not to confuse Account users with Console Users.
A Console User refers to the access that you have to a Partner Console. And since your Partner Console is where you manage all of your templates and Accounts, Console Users are only limited to the people in your team or organization who need access to your Partner Console. Do not give any of your customers access to the Partner Console.
You can find Console Users under “Settings” in your Console’s navigation menu. This is where you can invite or remove team members as Console Users and manage their access levels.
Console users can have different levels of access to your Partner Console. With “Full Access”, a Console User can access all areas of the Console and perform all operations.
However, you can choose to limit their access to specific areas of the Console and whether they can view or edit those areas. If you set up a Console User with no permissions, their access to your Console is limited to the dashboard view and reports.
Visit our documentation for full details of the available Console User Permissions.
How to Add a New User
You can add users either manually from your Partner Console, or as part of the Marketplace flow if you are deploying the Marketplace using User Marketplace Deployment method.
There are two main ways you can add users to your Accounts in the Partner Console. You can either create a new user’s profile from the User Management page on your Console or invite new users directly to a specific Account.
Adding User via User Management
One way to add a user is to go to “User Management” in your Cyclr Console.
- First, click on the “+ Create User” button that is available at the top right corner. In the popup that appears, set the user’s username (for example the user’s email address) and click on “Add User”.
- Fill in the user’s details in the popup that appears. Input their first and last name and email address, and set a password for them. The user will be able to change their password later from their profile’s User Settings.
- Next, add the accounts. At the bottom of the page, you’ll find a section labelled “Give User Access to Account.” Underneath is drop-down selection of all Accounts in your Console. From there, select the appropriate Account, and click on the plus button to add it to the user’s profile.
You need to select the Accounts one at a time. Therefore, if the user needs access to more than one Account, you can repeat the process to add additional Accounts to their profile.
Note that when you add Accounts to a user profile here, they will be automatically added without administrator access. You can change this later from the Account’s user settings.
Once you are finished with the user profile, don’t forget to save your changes.
Inviting a New User to an Account
The second way to add a new user through the Partner Console, is to invite them directly to an Account.
- First, navigate to Account Management to find the appropriate Account. Click on the Users button next to the Account. This will take you to the Account’s Users page.
- Next, select the “Invite User” button. Then, enter the user’s email address in the popup window that will be displayed, and click on “Invite”. Notice that you can configure their access level by selecting the “Add user as Administrator?” option before you hit the Invite button.
The new user will receive an invite to the email address that you provided. They can then set up their own user ID and password by following the instructions in the email.
If you want to add more accounts to the new user’s profile, you can do so from the User Management area on your console once the user has set up their Account.
Adding New Users via Marketplace
If you are using Cyclr Marketplaces and your customers have access to Cyclr, you can deploy your Marketplace using the User Marketplace Deployment method.
Using this deployment method allows you to follow which user installs a template or starts or stops a cycle.
To deploy a “User Marketplace”, you make a similar request to the Account Deployment method, but to the Cyclr API’s POST /v1.0/users/marketplace endpoint whilst also providing the Username of the “User” accessing the Marketplace. Cyclr will create a new user automatically if the username that is passed with the request does not exist.
The process is otherwise the same as for Account Marketplace Deployment, with three additional properties to use in the request body:
| Request Parameter | Type | Description |
|---|---|---|
| Username | string | Identifies the user. If the user doesn’t already exist, a new User will be created with these details. |
| Password | string | Password of the user. |
| AccountId | string | The Cyclr Account API ID of the Account to use. If it doesn’t already exist, a new Account will be created. |
User Marketplace Request
curl -X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"MarketplaceId": {MarketplaceId},
"AccountId": "{CYCLR_ACCOUNT_API_ID}",
"Username": "ExampleUser",
"Password": "P4$$w0rd",
"ConnectorAuthentications": [
{
"Name": "{ExampleConnector}",
"Version": "{VersionNumber}",
"AuthenticationId": "{AuthenticationId}",
"AuthValue": "{AuthenticationValue}",
"Properties": [
{
"Name": "{Url}",
"Value": "{http://customDomain.appName.com}"
}
]
}
]
}
' "https://{CyclrAPIDomain}/v1.0/users/marketplaceProviding Administrator Access
Once you have created a user, you can give them administrator access or revoke it easily from your Partner Console.
You can manage which users on an Account have administrator-level access by navigating to the Account Management section of your Console:
- First, access the User Management page by clicking the “Users” button next to the Account name. Here you will find a list of all users on that particular Account.
- In the list view, you can tick the “Administrator” box to provide a user with administrator access to that Account. Unticking the same box will revoke administrative access from the user.
Always remember to save your changes.
Authorize Account API Calls
If you don’t want your customers to access Cyclr themselves even in a limited setting, you can make calls within specific user accounts via the Cyclr API.
For each call, replace {CyclrAPIDomain} with your Cyclr API Domain. You can find your personal Cyclr API Domain in your Console under Settings > General.
You also need to include the following values in the header parameters:
| Parameter | Description |
|---|---|
| Authorization | Your Cyclr access token. Use the format: Bearer {access_token}. |
| X-Cyclr-Account | The {AccountID} of the account you want to install a connector into. |
Key Takeaways
- Users provide access to a limited instance of Cyclr that can be accessed by your customers or by your application on their behalf via the Cyclr API
- You can give users Administrator level access to their accounts to allow them to manage the account and invite new users
- Users and Console Users are not the same: Console Users access your Partner Console, whilst Users access Accounts.
- A single user can have access to multiple accounts.
- A single account can have one or more users.