Licenses

Grant User License

Grants a license to a user from a specified subscription. If the user already has a license on the given subscription, the existing license is returned.

post/v1/users/{id}/licenses

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/users/{id}/licenses
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: licenses:admin)

Path parameters

idinteger required

User ID

Request body

subscriptionIdstring uuid required

The subscription ID to grant the license from

Example request

{
  "subscriptionId": "8e8cf611-d74c-4a2f-8b61-754b22328fbb"
}

Response

Created. Returns the granted license, or the existing license if the user already has one on this subscription.

userIdinteger required

User ID

subscriptionIdstring uuid required

Subscription ID

createdstring date-time required

Date and time when the license was granted

Example response

{
  "userId": 123,
  "subscriptionId": "8e8cf611-d74c-4a2f-8b61-754b22328fbb",
  "created": "2024-08-08T22:21:48.612Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.