Use this API to assign, unassign, and revoke Cursive licences for users in your organisation.
All requests use application/json and require an Authorization: Bearer <api-key> header.
The API key identifies the organisation whose licences are being managed.
Assign a licence to a user by email address.
If the user already has a licence, the existing assignment is returned. If the user does not yet have a licence, one is assigned if a seat is available.
| email required | string <email> Email address to assign, unassign, or revoke |
| result required | string Value: "assigned" |
| licence-id required | integer <int64> |
| email required | string <email> |
{- "email": "user@company.com"
}{- "result": "assigned",
- "licence-id": 123,
- "email": "user@company.com"
}Remove the current licence assignment for a user.
Use this when a user no longer needs a seat. If the user does not currently have an assigned licence, the request still succeeds and reports that no assignment was present.
| email required | string <email> Email address to assign, unassign, or revoke |
| result required | string Value: "unassigned" |
| licence-id required | integer <int64> |
| email required | string <email> |
{- "email": "user@company.com"
}{- "result": "unassigned",
- "licence-id": 123,
- "email": "user@company.com"
}Revoke a user's access and prevent that email address from being assigned again.
Use this when a user should no longer be able to use a licence for your organisation. Any current assignment for that email address is removed.
| email required | string <email> Email address to assign, unassign, or revoke |
| result required | string Value: "revoked" |
| email required | string <email> |
| freed-licence required | integer or null <int64> Licence freed by revocation, or null if none was assigned |
{- "email": "user@company.com"
}{- "result": "revoked",
- "email": "user@company.com",
- "freed-licence": 123
}