Instance Access Tokens

An access token lets the Insites CLI, or a script you write, reach an instance as you. What you change with it is recorded against your name. Each token expires after 90 days.

An access token is not the same as your personal CLI token, which you find on your My profile page. An access token belongs to one instance.

Where to Find It

The Access Token card is the last card on an instance's CLI Commands tab. To see it:

• You need the Developer role or above, because the CLI Commands tab is only shown from that role.
• The instance must run on the Insites private stack. Other instances do not show the card.

Getting Your Token

1. Navigate to Instances from the main menu.
2. Find the instance on the main page or inside a folder, and select it to open it.
3. Select the CLI Commands tab.
4. On the Access Token card, select Get my token. If you already have an active token, the button says Replace my token, and your new token replaces the old one.
5. Copy your token straight away. It is shown only once, and it is gone when you leave the tab. The card also shows when it expires.

Under the token, the card shows a command that adds this instance to the Insites CLI with your token. The Console fills in the address and your token. Copy it and replace the environment name with one of your own. It has this shape:

insites-cli env add <environment-name> --url <proxy-url> --token <your-token>

Note: The card says this command needs the Insites CLI’s --token option, which is not released yet.

What the Token Can Do

What a token can do depends on your role on the instance:

• With the Editor role, the token can read and change records.
• Anything that changes code, config or assets needs the Developer role. This covers deploys, syncs, page edits, constants, imports and asset uploads.

Viewing and Revoking Tokens

The card lists the tokens you can see. You see your own token. Admins see everyone's tokens on the instance. Each row shows:

• Who holds the token. Your own row says You.
• The first characters of the token, when it was issued and when it expires.
• Its status: Active, Expired or Revoked.

To revoke an active token:

1. Select Revoke on its row.
2. Select Revoke token in the dialog to confirm.

The token stops working straight away. Anything already done with it stays on record. You can revoke your own token, and Admins can revoke anyone's.

Note: If the card says Couldn’t load, select Try again.