Find Your Organization Label and access tokens
This short article will show you how to locate the organization label/access token for your active organization. This is necessary if you’re working with the API or if you need to find the unique name for your organization.
Your organization’s label is usually different from its display name, which is displayed in the top-left of the Ardoq app.
To navigate to Organization Label, go to Preferences>Organization Settings>Settings
To create a new token, Navigate to Preferences>“Your Account settings".
Go to "API Tokens"
To generate a new access token, please click create new and enter the token name. This gives you a new unique token you need to copy.
Best practice is to delete the access token after you are finished using it.
Granting access to systems via the REST API
In order to grant access to a system (e.g. an external service like PowerBI), we previously recommended creation of a "dummy" user account. However, you can now use a service account to manage API tokens without the need to create pseudo-users in your access management system. You can read more here:
How to Allow Users to Create an API Token
All admin, writer, and reader users can generate API tokens by default in Ardoq. If you wish to limit access to creating API tokens in your organization to a few selected users, disable the “Create API token” privilege for a user role or specific users.
How to Enable or Disable The “Create API Tokens” Privilege on a User Role
Navigate to Preferences > Access Control > Roles
Select the user role you want to configure
Select the “Create API Token” checkbox
Click “Save”
Like all privileges, if the “Create API token” privilege is enabled on a user role, it is not possible to revoke it individually from users with that role.
For example, if you enable the “Create API token” privilege on the Writer user role, all of your existing Writer users, and those you add in the future, will be able to create API tokens. Because the “Create API token” privilege is enabled on the Writer user role, you won’t be able to revoke the “Create API token” privilege on single users who have the Writer user role assigned.
How to Enable or Disable the “Create API Token” Privilege on an Individual Basis
If you only want individual users to have the Create API Token privilege, then we recommend removing the privilege from those roles and then assigning the privilege individually.
To enable the “Create API token” privilege individually:
Navigate to Preferences > Access Control > Invite and Manage Users
Search or filter for the user(s) you want to enable the “Create API token” privilege on
Click on the three-dot menu next to the name of a user and select "Assign privileges".
Select "Create API token" from the dropdown
Hit "Save"
