/
[BSS] User flags
[BSS] User flags
- Thomas Langenskiold
Owned by Thomas Langenskiold
Introduction
Sometimes it's necessary to mark users for some special behavior. An example would be imposing purchasing restrictions on certain users. For this purpose, we provide user flags.
Overview of endpoints
| Endpoint | HTTP method | Purpose |
|---|---|---|
/api/users/v1/management/users/{user_id}/relationships/user_flags | PUT | Apply user flags to a user |
/api/users/v1/management/users/{user_id}/relationships/user_flags | DELETE | Remove user flags from a user |
Supported user flags
User flags are meant to be rare. The "normal" behavior should always be when no user flags are present.
| Flag | Purpose |
|---|---|
| LICENSE_PURCHASE_RESTRICTED | Restricts user from making purchases |
User flags in clients
Sometimes clients need to change behavior based on user flags. For this reason, user flags are returned from the login endpoints when access tokens are retrieved: https://confluence.aminocom.com/display/MAPI/User+Authentication#/Account%20Authentication/createAccessToken