API Keys

Overview

API keys authenticate and authorize users to access a range of Modzy APIs, depending on the roles assigned to them. Roles are explained in detail in our Authorization section.

Team keys are user’s own API keys and should not be shared. To facilitate shared credentials, service accounts, or other such paradigms, users may be create projects, for which they are responsible.

Projects have a project key that can complete full job lifecycles and may be shared by multiple project members.

The keys object

{
  "prefix": "...",
  "name": "...",
  "description": "...",
  "isDefault": false,
  "isHighPriority": false,
  "status": "...",
  "createdAt": "...",
  "lastActiveDateTime": "...",
  "submittedJobs": 0,
  "retrieved": true,
  "roles": [],
  "labels": [],
  "keyType": "...",
  "account": {},
  "user": {}
}

Parameter

Type

Description

prefix

string

The visible part of the API key ID. It’s unique and it may show up in pages, URIs, and requests. Used to identify the key, it’s unable to perform API requests by itself.

name

string

The API key’s name.

description

string

The API key’s usage description. Defaults to null.

isDefault

boolean

Defines if an API key is the user key. The value for user keys is true.

isHighPriority

boolean

The API key’s priority to run jobs within a job queue. Defaults to false.

status

string

The API key’s status. Values can be Active, Inactive, Pending, Rejected, or Deleted.

createdAt

string

The API key’s creation date in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.

lastActiveDateTime

string

Contains the last time the API key sent a request in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.

submittedJobs

number

The API key’s submitted jobs

retrieved

boolean

It is set to true when the user retrieves the API key.

roles

array

An array that contains all the role objects.

labels

array

An array that contains all the label objects.

keyType

string

Defines if an API key is a user key (user) or a project key (system).

account

object

An object that contains the account’s parameters.

user

object

An object that contains all the user’s parameters.