Basics & Procedures
In case you want to disable users in your BioStar 2, you can update your users to be inactive by using BioStar 2 API.
For instance, some of the users are to be allowed or not allowed to enter your building for certain period of time. What can you do? You can make your users to be active or inactive. Users with inactive status will face ‘DISABLED USER’ on their tries to authenticate themselves at the doors(devices).
API Call & Parameters
- Make a user to be active
[PUT]: /api/users/{user_id}
[Parameters]
Name | Type | *M/O | Explanation | Value |
User.disabled | String | M | Disabled or not | True/False |
* M – Mandatory, O – Optional
[Request Body]
{ "User": { "disabled": "false" } } |
[Response Body]
{ "Response": { "code": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Success" } } |
- You can see that the user is now ‘active’ in the screenshot below.
- Make a user to be inactive(disabled)
[PUT]: /api/users/{user_id}
[Parameters]
Name | Type | *M/O | Explanation | Value |
User.disabled | String | M | Disabled or not | True/False |
* M – Mandatory, O – Optional
[Request Body]
{ "User": { "disabled": "true" } } |
[Response Body]
{ "Response": { "code": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Success" } } |
- You can see that the user is now ‘inactive’ in the screenshot below.
- When a disabled user tries to authenticate, below alarm will be shown on your BioStar 2.
