User API
Last updated
Last updated
To use the User API, it's necessary to generate an access token.
A 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
.
POST
https://<<platform-server>>/ds-api/users/{email}
Create a User
email*
String
user-token*
String
Generated Access Token
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
roles
String array
role
String
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
GET
https://<<platform-server>>/ds-api/users/{email}
Display User Attributes
email*
String
user-token*
String
Generated Access Token
Response
PUT
https://<<platform-server>>/ds-api/users/{email}
Update User Properties
email*
String
user-token*
String
Generated Access Token
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
roles
String array
role
String
comment
String
Response
DELETE
https://<<platform-server>>/ds-api/users/{email}
Delete User
email*
String
user-token*
String
Generated Access Token
Response
POST
https://<<platform-server>>/ds-api/users/{email}/role/{role name}
Add an existing role to a user
email*
String
role name
String
Existing role
user-token*
String
Generated Access Token
Response
DELETE
https://<<platform-server>>/ds-api/users/{email}/role/{role name}
Remove an existing role from a user
email*
String
role name
String
Existing role
user-token*
String
Generated Access Token
Response
GET
https://<<platform-server>>/ds-api/users
Display All Users
user-token*
String
Generated Access Token
Response
Access to Possible values: 0 or 1 Default: 1
Since version 2024.04 Roles used for
Deprecated since version 2024.04 use roles instead Role used for Default: No restriction
Access to Possible values: 0 or 1 Default: 1
Since version 2024.04 Roles used for
Deprecated since version 2024.04 use roles instead Role used for Default: No restriction