• Document Up to Date

Access Tokens Management

All applications need an Access Token in order to make requests for the Crafter Profile API. By default three tokens will be created:

Application Description
profile-admin
Used by the Profile Admin Console web application for all operations
on tenants and profiles.
engine
Used by Crafter Engine for authenticating and getting profiles.
social
Used by Crafter Social for getting profiles.

List All

To view all existing Access Tokens you can click the List Access Tokens link in the left sidebar.

Crafter Profile access tokens list

From this page you can view the general information about the tokens and delete them if needed.

Warning

When you delete an Access Token all applications that are configured to use it will be unable to access the API immediately.

View Details

From the List Access Tokens page you can click the ID of an existing record to display the details:

Crafter Profile access tokens view

Note

Access Tokens are immutable, if you need to change the permissions for an existing token you need to delete it and create a new one using the same value for the ID.

Create a New Access Token

To create a new Access Token you can click the New Access Token link in the left sidebar.

Crafter Profile access tokens new

Fields

Field Required Type Description
ID String
This field needs to be unique, applications need
to be configured to include it in the requests
Application String
Arbitrary name used to describe the application
that will use this token
Master   Boolean
If set to true the application using the token
will be allowed to perform operations on other
Access Tokens
Expires On Date
All request using a token after the Expired On
date will fail
Tenant Permissions   List
List of tenants with allowed permissions for
each one

Example Tenant Permissions

Crafter Profile access tokens permissions

An application using an Access Token with these permissions will be able to:

  • Query data from both tenants site1 and site2
  • Update only tenant site2
  • Query, create, update and delete profiles for both site1 and site2