Creates an activation invitation (license activation workflow) for the entitlement.

POST

/api/v1/provision/operational/entitlements/{entitlementId}/activation-codes

curl --request POST \
  --url https://example.com/api/v1/provision/operational/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/activation-codes \
  --header 'Content-Type: application/json' \
  --data '{ "requiredAuthenticationLevel": "Default", "preAuthorizedDevices": [ "example" ], "fingerprint": "example", "maxDeviceActivations": 1, "useEntitlementMaxActivations": true, "activationCode": "example", "email": "example", "isTrialActivation": true, "requiresUserConsent": true, "sendUserNotification": true, "organizationGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "requiredUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "expirationTimeStamp": "2026-04-15T12:00:00Z" }'

Parameters

Path Parameters

entitlementId

required

string format: uuid

Target entitlement.

Request Body^required

Workflow payload.

Admin request to create a license activation workflow for an entitlement: the contract (authentication level, code, device/user restrictions, limits) under which end users may activate. Null properties fall back to entitlement or platform defaults.

object

requiredAuthenticationLevel

Authentication level a user must meet before a license activation is permitted. Used on activation policies and activation workflows.

Allowed values: Default Anonymous IdentityVerification IdentityProvider

preAuthorizedDevices

Array<string> | null

fingerprint

null | string

maxDeviceActivations

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

useEntitlementMaxActivations

null | boolean

activationCode

null | string

email

null | string

isTrialActivation

null | boolean

requiresUserConsent

null | boolean

sendUserNotification

null | boolean

organizationGroupId

null | string format: uuid

requiredUserId

null | string format: uuid

expirationTimeStamp

null | string format: date-time

Admin request to create a license activation workflow for an entitlement: the contract (authentication level, code, device/user restrictions, limits) under which end users may activate. Null properties fall back to entitlement or platform defaults.

object

requiredAuthenticationLevel

Authentication level a user must meet before a license activation is permitted. Used on activation policies and activation workflows.

Allowed values: Default Anonymous IdentityVerification IdentityProvider

preAuthorizedDevices

Array<string> | null

fingerprint

null | string

maxDeviceActivations

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

useEntitlementMaxActivations

null | boolean

activationCode

null | string

email

null | string

isTrialActivation

null | boolean

requiresUserConsent

null | boolean

sendUserNotification

null | boolean

organizationGroupId

null | string format: uuid

requiredUserId

null | string format: uuid

expirationTimeStamp

null | string format: date-time

Admin request to create a license activation workflow for an entitlement: the contract (authentication level, code, device/user restrictions, limits) under which end users may activate. Null properties fall back to entitlement or platform defaults.

object

requiredAuthenticationLevel

Authentication level a user must meet before a license activation is permitted. Used on activation policies and activation workflows.

Allowed values: Default Anonymous IdentityVerification IdentityProvider

preAuthorizedDevices

Array<string> | null

fingerprint

null | string

maxDeviceActivations

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

useEntitlementMaxActivations

null | boolean

activationCode

null | string

email

null | string

isTrialActivation

null | boolean

requiresUserConsent

null | boolean

sendUserNotification

null | boolean

organizationGroupId

null | string format: uuid

requiredUserId

null | string format: uuid

expirationTimeStamp

null | string format: date-time

Responses

200

OK

Admin read model of a license activation workflow, including the issued activation code, registered device fingerprints, use counters, and expiration.

object

id

string format: uuid

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxVerificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

activationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxActivationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

Authentication level a user must meet before a license activation is permitted. Used on activation policies and activation workflows.

Allowed values: Default Anonymous IdentityVerification IdentityProvider

Admin read model of a license activation workflow, including the issued activation code, registered device fingerprints, use counters, and expiration.

object

id

string format: uuid

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxVerificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

activationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxActivationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

Authentication level a user must meet before a license activation is permitted. Used on activation policies and activation workflows.

Allowed values: Default Anonymous IdentityVerification IdentityProvider

Example

{
  "requiredAuthenticationLevel": "Default"
}

Admin read model of a license activation workflow, including the issued activation code, registered device fingerprints, use counters, and expiration.

object

id

string format: uuid

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxVerificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

activationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxActivationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

Authentication level a user must meet before a license activation is permitted. Used on activation policies and activation workflows.

Allowed values: Default Anonymous IdentityVerification IdentityProvider

Example

{
  "requiredAuthenticationLevel": "Default"
}

400

Bad Request

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}