API Keys

An API Key is used to access the Modern Treasury API. API Keys are managed through the web interface.

Attribute	Description
idstring	Unique identifier for the API Key.
name string	The API Key's name.
default boolean	`true` if provided by the system at organization creation time.
roles string array	Roles defined by `domain:access_level` where domain is one of `accounts`, `counterparties`, `developer`, `external_accounts`, `ledgers`, `compliance`. `access_level` is one of `read` or `manage`. `accounts:ACCESS_LEVEL` can be optionally appended by the account id if scoped to a specific account (`accounts:read:1233b7a...17559`).
ip_allowlist string array	List of allowed IP addresses for the API Key.
live_mode boolean	This field will be true if this object exists in the live environment or false if it exists in the test environment.
organization_id string	The organization the API Key belongs to.
decommissioned boolean	`true` if the API Key has been archived.
decommissioned_at datetime	If the API key has been archived, the datetime of that occurred.

{
  "created_at": "2020-09-08T20:40:43Z",
  "decommissioned": false,
  "decommissioned_at": null,
  "default": false,
  "id": "d1233b7a-1404-47d8-8ee9-fb084fd17559",
  "ip_allowlist": [],
  "live_mode": true,
  "name": "developer key",
  "object": "api_key",
  "roles": [
    "developer:read"
  ],
  "organization_id": "16554646-35c6-4678-855f-dffe5b2c0552",
  "updated_at": "2020-09-08T20:40:43Z"
}