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
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.
registration_time: read-only epoch timestamp of user registration time
external_id: external customer id 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 user account with provided password
Use cases
First use case
Step name
Step description
API endpoint
Possible info text for the use case and how it is linked to other use cases