Versions Compared
| Version | Old Version 1 | New Version 2 |
|---|---|---|
| Changes made by | ||
| Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Introduction
This section describes BSS communication with AminoTV User Management API
Authentication and authorisation
All BSS endpoints support API key authorization. The header named 'Authorization' with content "Apikey PUT_YOUR_KEY_HERE" must be passed with request.
In addition to API key authorization some clients can have IP white listing feature enabled, which will allow access only from specific IP's.
Both API key and IP addresses allowed list are customer specific data and you should contact support person to obtain those.
Endpoints overview
Endpoint | HTTP method | Purpose |
|---|---|---|
| /api/user/management/v4/users | GET | Get an index of users |
| /api/user/management/v4/users | POST | Create a new user |
| /api/user/management/v4/users/{user_id} | GET | Get user by id |
| /api/user/management/v4/users/{user_id} | PATCH | Delete user by id |
| /api/user/management/v4/users/{user_id} | DELETE | Update user by id |
Entities
User Resource
Up-to-date resource schema could be found on API documentation page User Management API under schemas section.
Attributes
- name: full name of the user
- user_flags: predefined user flags for features (e.g.: LICENSE_PURCHASE_RESTRICTED)
- contact_details:
- email: email address
- telephone_number_E123: telephone in E.123 notation
- registration_information:
- registration_state: default is UNREGISTERED, meaning user is required to activate the account before login. Use REGISTERED if no activation is needed. Only REGISTERED state is allowed to login.
- registration_time: (read-only epoch timestamp of ) user registration time in epoch timestamp
- external_id: external customer id identifier for reference
Relationships
Each of user should have one default_user_profile.
Meta
- security
- user_password: although it is recommended using email to set/reset password, User Management v4#/User/CreateUser supports to create creating user account with provided a given password
Use cases
First use case
| Info |
|---|
Possible info text for the use case and how it is linked to other use cases |
Second use case
Third use case
Migration guide
Known issues and limitations
| Info |
|---|
Info level limitation example |
Use management API to fetch, create, update and delete Users
User Management API
Some notes:
- If the user account is created without password, it is required to set account password using an link from an set/reset user password email. See User information v2#/Password%20Reset/requestResetPassword endpoint.
Migration guide
| Old endpoint | New endpoint | ||
|---|---|---|---|
| Create user account | POST /api/management/user | POST /api/user/management/v4/users | |
| Delete user account | DELETE | ||
Postman collection
Table of Contents
| Table of Contents |
|---|
Child Pages
| Child pages (Children Display) |
|---|