Organisation

The enterprise record itself.

Fetching it

The entry point to the whole API. It takes no arguments: your token names the enterprise it acts for, and enterprise returns that one. Requires enterprise:core:read.

The field is non-null. A token is minted from a live enterprise and the platform re-checks that it still is on every request, so an absent record is a server fault rather than something to branch on.

Updating

Requires enterprise:core:write.

Tenant isolation

No operation on this API takes an enterprise ID. The tenant is a claim on your token, and every query and mutation is scoped to it before it reads or writes anything. There is no argument through which one credential could name another company's records.

The consequence for your code is that a credential acts for exactly one enterprise. If you administer several, you hold one client per enterprise and pick the token, not the argument.

Next

Reference

Generated reference — every type, field and argument, built from the live schema.

Built with