Create User API token

Currently, User API tokens are available only in the Cloud UpRaise.

Create User API token

Navigation

  • Navigate to your User profile page from left navigation >> click on API tokens tab.

  • API Tokens tab is visible only to the logged-in user on their profile on other users' profiles for whom the logged-in user has ‘Edit user/s’ permission.

api token.png
  • See examples below to understand when API token tab will be available for a logged in user-

    • When logged-in user A visits their profile screen, they can see the ‘API tokens’ tab.

    • When logged-in user A visits the profile screen of user B, they are not able to see the ‘API tokens’ tab since they do not have ‘Edit user/s' permission for user B.

    • When logged-in user A visits the profile screen of user C, they can see the ‘API tokens’ tab since they have ‘Edit user/s’ permission for user C.

Create

On API Tokens tab, click on + New token. On the pop-up, add a label and click on Create. Once the token is generated, Copy the token.

Make sure you copy your new API token. You won’t be able to see this token again.

More about user API tokens

  • These API tokens are to grant temporary, secure access to UpRaise REST APIs, based on your current permissions.

  • A maximum of 5 tokens are allowed per user.

  • If there are already 5 tokens against a user, + New token will be hidden.

  • Ability to create a new token is restricted to the logged-in users themselves.

  • If you have access to other user’s API token tab, in that case, you cannot create a toke for them but can only Revoke existing tokes

    • EG. User A can generate a token for themselves only. If they can view the ‘API tokens’ tab for another user B. For user B, A can only ‘Revoke’ an API token but cannot create a new one.

  • These tokens grant as many permissions as the actual users have through their UpRaise roles.

  • Click on Revoke to revoke existing tokens.