Create API Key
Create a new API key for your company. Choose its permissions; each must be one the calling key holds and its creator still holds, so a key can never mint a stronger key. Without permissions or accessLevel, the new key gets the view permissions. The key itself appears only in this response, so store it right away; MindCloud keeps only a hash.
Headers
Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.
Body
A name that tells you later what the key is for, up to 256 characters.
The permissions the new key holds, for example ["workflow:view","log:view"]. Defaults to the view permissions.
workflow:viewWorkflows: View workflows.workflow:createWorkflows: Create workflows.workflow:editWorkflows: Edit workflows.workflow:deleteWorkflows: Delete workflows.workflow:runWorkflows: Run and cancel workflows.log:viewRuns: View runs and logs.credential:viewConnections: View connections.credential:createConnections: Create connections and connect links.credential:editConnections: Edit, reconnect, and test connections.credential:deleteConnections: Delete connections.universal:readUniversal API: Run read actions and lookups.universal:createUniversal API: Run create actions.universal:updateUniversal API: Run update actions.universal:deleteUniversal API: Run delete actions.member:viewMembers and roles: View members and roles.member:createMembers and roles: Invite members.member:editMembers and roles: Change member roles.member:deleteMembers and roles: Remove members.member:owner_editMembers and roles: Invite, change, or remove Owners.role:manageMembers and roles: Create, edit, and delete roles.company:viewCompany: View company and environments.company:editCompany: Edit company profile.environment:editCompany: Create, edit, and delete environments.company:parent:manageCompany: Accept, decline, or leave a parent organization.subscription:viewCompany: View usage and spend limits.subscription:manageCompany: Set member spend limits.api_key:manageAPI keys: See and revoke all API keys.embedded:viewEmbedded: View end users and their connections.embedded:createEmbedded: Create end users and connect links.embedded:editEmbedded: Edit end users.embedded:deleteEmbedded: Delete end users.analytics:page:viewAnalytics: View Analytics pages, panels and data sources.analytics:page:createAnalytics: Create Analytics pages and manage data sources, publications, themes, folder shares and template installs.analytics:page:editAnalytics: Edit, publish, share and delete Analytics pages.child_company:accessChild organizations: Act in child organizations.child_company:manageChild organizations: Create, link, release, and close child organizations.
Instead of permissions: read_only, run_workflows, or full_access, which give that level's permissions. Send one of permissions and accessLevel, not both.
read_onlyrun_workflowsfull_access
true: "Use this key across all of your organizations". The new key can act, through X-Company-Id, in every organization its creator can open in the app. Only a calling key that has it may give it, so a key can never mint one that reaches further than itself.
"Use this key across all of your organizations". Only a key that has it may give it.
Response fields
idstringUnique id of the key.
namestringThe name the key was created with.
accessLevelstringA summary of the key permissions: full_access, run_workflows, read_only, or none. Derived from permissions; it is never set directly.
read_onlyrun_workflowsfull_accessnone
isAllOrganizationsboolean"Use this key across all of your organizations": the key can act, through X-Company-Id, in every organization its creator can open in the app, with no more than the creator may do there.
permissionsarray of stringThe permissions the key holds. A request may use one only while the key's creator also holds it.
keystringThe key itself, such as `mc-us1-…`. It appears only in this response; MindCloud keeps only a hash.
createdOndateWhen the key was created.