Create license

Create a license for a user on an application instance

POST

/v1/users/{userId}/application-instances/{applicationInstanceId}/licenses

POST

/users/{userId}/application-instances/{applicationInstanceId}/licenses

curl -X POST "https://api.corma.io/v1/users/{userId}/application-instances/-9007199254740991/licenses" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "licenseTypeKeys": [
    "string"
  ],
  "licenseRoleKeys": [
    "string"
  ],
  "appAccountId": "string",
  "billingStatus": "live",
  "grantedAt": "2026-01-15T09:30:00Z",
  "grantedById": "string",
  "connectorId": "string"
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

userId
string
path
required
applicationInstanceId
integer
path
required
x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Body

application/json

licenseTypeKeys
string[] | null
licenseRoleKeys
string[] | null
appAccountId
string | null
billingStatus
enum<string> | null
One of:
live
revoked
grantedAt
any of | null
grantedById
string | null
connectorId
string | null
The connector this licence belongs to, as GET /connectors returned its identifier. Required when the application instance has several connectors; otherwise its single connector holds the licence.

Response

application/json201

id
number
required
applicationInstanceId
integer
required
user
UserEmbed | null
required
grantedById
string | null
required
grantedBy
UserEmbed | null
required
grantedAt
string<date-time> | null
required
billingStatus
enum<string> | null
required
One of:
live
revoked
activityStatus
enum<string> | null
required
One of:
active
inactive
appInternalId
string | null
required
sources
ActivitySource[]
required
connectorId
string | null
required
The connector this licence belongs to: the id of its connection, which every connector route accepts. Null when no connector holds it.
licenseTypesKeys
string[]
required
licenseRolesKeys
string[]
required
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": 0,
  "applicationInstanceId": -9007199254740991,
  "user": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "grantedById": "string",
  "grantedBy": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "grantedAt": "2026-01-15T09:30:00Z",
  "billingStatus": "live",
  "activityStatus": "active",
  "appInternalId": "string",
  "sources": [
    {
      "type": "integration_sync_unit",
      "kind": "google",
      "method": "api",
      "syncUnitId": "string",
      "label": "string",
      "author": "string",
      "isOriginating": true,
      "firstActivityAt": "2026-01-15T09:30:00Z",
      "lastActivityAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "licenseTypesKeys": [
    "string"
  ],
  "licenseRolesKeys": [
    "string"
  ],
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

POST

/users/{userId}/application-instances/{applicationInstanceId}/licenses

curl -X POST "https://api.corma.io/v1/users/{userId}/application-instances/-9007199254740991/licenses" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "licenseTypeKeys": [
    "string"
  ],
  "licenseRoleKeys": [
    "string"
  ],
  "appAccountId": "string",
  "billingStatus": "live",
  "grantedAt": "2026-01-15T09:30:00Z",
  "grantedById": "string",
  "connectorId": "string"
}'

{
  "id": 0,
  "applicationInstanceId": -9007199254740991,
  "user": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "grantedById": "string",
  "grantedBy": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "grantedAt": "2026-01-15T09:30:00Z",
  "billingStatus": "live",
  "activityStatus": "active",
  "appInternalId": "string",
  "sources": [
    {
      "type": "integration_sync_unit",
      "kind": "google",
      "method": "api",
      "syncUnitId": "string",
      "label": "string",
      "author": "string",
      "isOriginating": true,
      "firstActivityAt": "2026-01-15T09:30:00Z",
      "lastActivityAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "licenseTypesKeys": [
    "string"
  ],
  "licenseRolesKeys": [
    "string"
  ],
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

Create license - Corma Help Center | Productlane

API referenceLicenses

Create license

Create a license for a user on an application instance

POST

/v1/users/{userId}/application-instances/{applicationInstanceId}/licenses

POST

/users/{userId}/application-instances/{applicationInstanceId}/licenses

curl -X POST "https://api.corma.io/v1/users/{userId}/application-instances/-9007199254740991/licenses" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "licenseTypeKeys": [
    "string"
  ],
  "licenseRoleKeys": [
    "string"
  ],
  "appAccountId": "string",
  "billingStatus": "live",
  "grantedAt": "2026-01-15T09:30:00Z",
  "grantedById": "string",
  "connectorId": "string"
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

userId
string
path
required
applicationInstanceId
integer
path
required
x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Body

application/json

licenseTypeKeys
string[] | null
licenseRoleKeys
string[] | null
appAccountId
string | null
billingStatus
enum<string> | null
One of:
live
revoked
grantedAt
any of | null
grantedById
string | null
connectorId
string | null
The connector this licence belongs to, as GET /connectors returned its identifier. Required when the application instance has several connectors; otherwise its single connector holds the licence.

Response

application/json201

id
number
required
applicationInstanceId
integer
required
user
UserEmbed | null
required
grantedById
string | null
required
grantedBy
UserEmbed | null
required
grantedAt
string<date-time> | null
required
billingStatus
enum<string> | null
required
One of:
live
revoked
activityStatus
enum<string> | null
required
One of:
active
inactive
appInternalId
string | null
required
sources
ActivitySource[]
required
connectorId
string | null
required
The connector this licence belongs to: the id of its connection, which every connector route accepts. Null when no connector holds it.
licenseTypesKeys
string[]
required
licenseRolesKeys
string[]
required
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": 0,
  "applicationInstanceId": -9007199254740991,
  "user": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "grantedById": "string",
  "grantedBy": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "grantedAt": "2026-01-15T09:30:00Z",
  "billingStatus": "live",
  "activityStatus": "active",
  "appInternalId": "string",
  "sources": [
    {
      "type": "integration_sync_unit",
      "kind": "google",
      "method": "api",
      "syncUnitId": "string",
      "label": "string",
      "author": "string",
      "isOriginating": true,
      "firstActivityAt": "2026-01-15T09:30:00Z",
      "lastActivityAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "licenseTypesKeys": [
    "string"
  ],
  "licenseRolesKeys": [
    "string"
  ],
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

POST

/users/{userId}/application-instances/{applicationInstanceId}/licenses

curl -X POST "https://api.corma.io/v1/users/{userId}/application-instances/-9007199254740991/licenses" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "licenseTypeKeys": [
    "string"
  ],
  "licenseRoleKeys": [
    "string"
  ],
  "appAccountId": "string",
  "billingStatus": "live",
  "grantedAt": "2026-01-15T09:30:00Z",
  "grantedById": "string",
  "connectorId": "string"
}'

{
  "id": 0,
  "applicationInstanceId": -9007199254740991,
  "user": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "grantedById": "string",
  "grantedBy": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "grantedAt": "2026-01-15T09:30:00Z",
  "billingStatus": "live",
  "activityStatus": "active",
  "appInternalId": "string",
  "sources": [
    {
      "type": "integration_sync_unit",
      "kind": "google",
      "method": "api",
      "syncUnitId": "string",
      "label": "string",
      "author": "string",
      "isOriginating": true,
      "firstActivityAt": "2026-01-15T09:30:00Z",
      "lastActivityAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "licenseTypesKeys": [
    "string"
  ],
  "licenseRolesKeys": [
    "string"
  ],
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}