Security Service
Get access token - to be used as Bearer token header for all other API requests.
/oauth2
used when a user is trying to change her password. This will be the new password.
A user forgot her password. She needs to present her e-mail address in the userId and set this to true
A user forgot her password. She needs to present her e-mail address in the userId and set this to true
refresh_token
Get access token - to be used as Bearer token header for all other API requests.
/suboauth2
used when a user is trying to change her password. This will be the new password.
A user forgot her password. She needs to present her e-mail address in the userId and set this to true
A user forgot her password. She needs to present her e-mail address in the userId and set this to true
refresh_token
Revoke a token.
/oauth2/{token}
No body
Revoke a token.
/suboauth2/{token}
No body
Retrieve the system layout.
/systemEndpoints
Retrieve a list of existing users as well as some information about them.
/users
Selecting this option means the newest record will be returned. Use limit to select how many.
Return only the ids.
Return only the ids.
id1,id2,id3,id4,id5
Name matching
Name matching
No body
Retrieve a list of existing users as well as some information about them.
/subusers
Selecting this option means the newest record will be returned. Use limit to select how many.
Return only the ids.
Return only the ids.
id1,id2,id3,id4,id5
Name matching
Name matching
No body
Retrieve the information for a single user.
/user/{id}
No body
Create a single user.
/user/{id}
root
, admin
, subscriber
, csr
, system
, installer
, noc
, accounting
internal
, normal
, gmail
, facebook
, linkedin
, instagram
No body
Modify a single user.
/user/{id}
root
, admin
, subscriber
, csr
, system
, installer
, noc
, accounting
internal
, normal
, gmail
, facebook
, linkedin
, instagram
No body
Delete a single user.
/user/{id}
Retrieve the information for a single user.
/subuser/{id}
No body
Create a single user.
/subuser/{id}
root
, admin
, subscriber
, csr
, system
, installer
, noc
, accounting
internal
, normal
, gmail
, facebook
, linkedin
, instagram
No body
Modify a single user.
/subuser/{id}
root
, admin
, subscriber
, csr
, system
, installer
, noc
, accounting
internal
, normal
, gmail
, facebook
, linkedin
, instagram
No body
Delete a single user.
/subuser/{id}
Retrieve the avatar associated with a user ID.
/avatar/{id}
Create an avatar associated with a user ID.
/avatar/{id}
Remove an avatar associated with a user ID.
/avatar/{id}
Send test email with the system.
Send test email with the system.
/sms
Get the list of recorded preferences for a user
/userPreferences
No body
Set the list of recorded preferences for a user
/userPreferences
No body
Retrieve the cyrrent setting for MFA
/submfa
No body
Retrieve the cyrrent setting for MFA
/submfa
disabled
, sms
, email
No body
Retrieve the Authenticator QR Code
/totp
Send the first security code to validate your setup
/totp
1,2,3
This call allows a new subscriber to register themselves and their devices.
/signup
No body
modify the signup command in play
/signup
cancel
, success
, inprogress
, failed
, poll
, emailVerified
Retrieve the list of security profiles for a specific service type.
/securityProfiles
Pagination start (starts at 1. If not specified, 1 is assumed)
Maximum number of entries to return (if absent, no limit is assumed)
Filter the results
No body
Retrieve the basic system information. This information is used between services only.
/systemServices
No body
Allows any microservice to validate a token and get security policy for a specific user.
/validateToken
No body
Allows any microservice to validate a token and get security policy for a specific user.
/validateSubToken
No body
Retrieve different values from the running service.
/system
Get a value
info
Perform some system wide commands.
/system
Was this helpful?