🧩User API
To use the User API, it's necessary to generate an access token.
🔗Access TokenA comprehensive toolkit, with practical usage examples, is accessible on GitHub.
This toolkit comes pre-installed as a default component within the on-premises platform, located at /datasentinel/soft/datasentinel_toolkit
.
User
Add
POST
https://<<platform-server>>/ds-api/users/{email}
Create a User
Path Parameters
Name | Type | Description |
---|---|---|
email* | String |
Headers
Name | Type | Description |
---|---|---|
user-token* | String | Generated Access Token |
Request Body
Name | Type | Description |
---|---|---|
password | String | User Password Required for Regular users |
privilege | String | Possible values: read, read write or admin Default: admin |
profile | String | Possible values: developer or data admin Default: data admin |
live_360 | String | Access to Live360 Feature Possible values: 0 or 1 Default: 1 |
roles | String array | Since version 2024.04 Roles used for Role Based Access Control |
|
| Deprecated since version 2024.04 use roles instead Role used for Role Based Access Control Default: No restriction |
comment | String | |
ldap | Boolean | Default: false |
Response
Two Flavors of User Access
Regular Users: The Standard Access. You need to specify a password
LDAP Users: For Seamless Network Integration You need to set the ldap value to true.
This POST request assigns privileges to a user authenticated through LDAP.
Refer to the Documention on setting up LDAP authentication
Display
GET
https://<<platform-server>>/ds-api/users/{email}
Display User Attributes
Path Parameters
Name | Type | Description |
---|---|---|
email* | String |
Headers
Name | Type | Description |
---|---|---|
user-token* | String | Generated Access Token |
Response
Update
PUT
https://<<platform-server>>/ds-api/users/{email}
Update User Properties
Path Parameters
Name | Type | Description |
---|---|---|
email* | String |
Headers
Name | Type | Description |
---|---|---|
user-token* | String | Generated Access Token |
Request Body
Name | Type | Description |
---|---|---|
password | String | User Password |
privilege | String | Possible values: read, read write or admin Default: admin |
profile | String | Possible values: developer or data admin Default: data admin |
live_360 | String | Access to Live360 Feature Possible values: 0 or 1 Default: 1 |
roles | String array | Since version 2024.04 Roles used for Role Based Access Control |
|
| Deprecated since version 2024.04 use roles instead Role used for Role Based Access Control Default: No restriction |
comment | String |
Response
Delete
DELETE
https://<<platform-server>>/ds-api/users/{email}
Delete User
Path Parameters
Name | Type | Description |
---|---|---|
email* | String |
Headers
Name | Type | Description |
---|---|---|
user-token* | String | Generated Access Token |
Response
Assign role
POST
https://<<platform-server>>/ds-api/users/{email}/role/{role name}
Add an existing role to a user
Path Parameters
Name | Type | Description |
---|---|---|
email* | String | |
role name | String | Existing role |
Headers
Name | Type | Description |
---|---|---|
user-token* | String | Generated Access Token |
Response
Remove role
DELETE
https://<<platform-server>>/ds-api/users/{email}/role/{role name}
Remove an existing role from a user
Path Parameters
Name | Type | Description |
---|---|---|
email* | String | |
role name | String | Existing role |
Headers
Name | Type | Description |
---|---|---|
user-token* | String | Generated Access Token |
Response
Users
Display
GET
https://<<platform-server>>/ds-api/users
Display All Users
Headers
Name | Type | Description |
---|---|---|
user-token* | String | Generated Access Token |
Response
Last updated