Create a credential

A credential is what a system signs in with. It belongs to one group, names the organisations it may use - the group itself, its companies, or both - and carries a secret that is shown once.

Where it lives

Settings → Global Settings → Integrations → API Access, beside Accounting Sync, Operational Source and AI Access.

Who may use it

What the screen asks for

FieldRequiredWhat it does
Name Yes What the credential is called in the list. Free text, up to 100 characters.
Organisations it may use Yes, at least one The organisations the credential may read and write. The group is listed first, marked (group): tick it to read the consolidated figures - the statements, the consolidation datasets - and to ask for a consolidation. Tick a company to read or write that company's own figures. A read of an organisation that is not ticked answers 404. What may be written to the group is decided per kind: a chart of accounts, for one, is refused at a consolidation parent - see Accounts.
What it may write Yes, at least one One scope per resource and direction: accounts.write, trial_balance.write, invoices.write, bills.write, transactions.write, operation_data.write, consolidation.trigger, beside a read scope for each resource the connector reads back — see Endpoints.
Credential expires on No The credential’s own end date. Separate from the token lifetimes — see Tokens.
Allowed IP addresses No One address or range per line. Empty allows any address.

What is shown once

On saving, the screen shows the client ID and the client secret exactly once, with a copy button. Neither can be retrieved afterwards: only a hash of the secret is stored. If the secret is lost, create a new credential and revoke the old one.

Revoking

Revoking is one click and takes effect on the credential’s next request, not at its token’s expiry: every request re-reads the credential. The credential is never deleted — it stays in the list, marked revoked, so the audit trail can still say which credential posted what.

Creating and revoking are both written to the System Audit Trail.

What a credential can never do