Permissions and limits
Every permission a key can carry, what it allows, and which ones sign-in grants.
Generated, do not edit
This page is generated from the code by tools/gen_reference.py. Change the code, then run the generator again. Edits made here are overwritten.
A key carries a list of permissions. A key with an empty list can do nothing. There is no all-access permission.
| Permission | What it allows | Default for a new key | Read-only sign-in | Full sign-in |
|---|---|---|---|---|
book:search |
Search the book and resolve sectors. Masked rows only. | yes | yes | yes |
book:read |
Read one lead's full held record. | yes | yes | yes |
account:read |
Read the account's plan, allowance and saved lists. | yes | yes | yes |
linkedin:read |
Read this account's LinkedIn campaign, activity, extension status and history. | no | yes | yes |
linkedin:orchestrate |
Create or update this account's LinkedIn campaign queues for execution by the operator's Enricher. Does not grant direct LinkedIn sending. | no | no | yes |
campaigns:read |
List and open this account's campaigns. | no | yes | yes |
campaigns:write |
Create a draft, add people, pause or archive. Does not start a campaign. | no | no | yes |
lists:read |
Read saved lists and saved searches. | no | yes | yes |
lists:write |
Create a list, add leads, archive a list, save a search. | no | no | yes |
posts:read |
Read draft and scheduled posts. | no | yes | yes |
team:read |
See who is in this organisation. | no | yes | yes |
connections:read |
See whether LinkedIn posting, the mailbox and Google Calendar are connected. | no | yes | yes |
connections:write |
Prepare a calendar change. It does not run until the user approves it in Adapt. | no | no | yes |
crm:read |
Read this organisation's CRM. | no | yes | yes |
crm:write |
Prepare a CRM change. It does not run until the user approves it in Adapt. | no | no | yes |
outreach:read |
Read email campaigns, replies and the caller lists. | no | yes | yes |
outreach:write |
Prepare an outreach change. It does not send until the user approves it in Adapt. | no | no | yes |
reports:read |
Read this account's reports. | no | yes | yes |
team:write |
Prepare a member or invite change. It does not run until the user approves it in Adapt. | no | no | yes |
book:reveal |
Prepare a reveal. It spends a credit only after the user approves it in Adapt. | no | no | yes |
Read-only sign-in is the adapt:read scope and full sign-in is the adapt scope. See Keys, sign-in and permissions. Even the full sign-in only prepares changes for your approval.
Lifetimes
| Credential | Prefix | Lifetime |
|---|---|---|
| Key | adl_ |
365 days by default, 730 days at most |
| OAuth access token | ado_ |
1 hour |
| OAuth refresh token | adr_ |
30 days, single use, replaced each time |
| Authorisation code | none | 5 minutes |