🧩User API
To use the User API, it's necessary to generate an access token.
🔗Access TokenUser
Add
POST
https://<<platform-server>>/ds-api/users/{email}
Create a User
Path Parameters
email*
String
Headers
user-token*
String
Generated Access Token
Request Body
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
role
String
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
{
"status": "User with login <<user>> created successfully"
}
Two Flavors of User Access
Regular Users: The Standard Access. You need to specify a password
{
"password": "myPassword",
"privilege": "admin",
"profile": "data admin",
"live_360": 1,
"roles": ["role_1", "role_2"],
"comment": "My comment"
}
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.
{
"ldap": true,
"privilege": "admin",
"profile": "data admin",
"live_360": 1,
"roles": [],
"comment": "My comment"
}
Display
GET
https://<<platform-server>>/ds-api/users/{email}
Display User Attributes
Path Parameters
email*
String
Headers
user-token*
String
Generated Access Token
Response
{
"id": 54,
"login": "username",
"email": "[email protected]",
"profile": "data admin",
"privilege": "admin",
"roles": ["role_1", "role_2"],
"live_360": 1,
"comment": "My comment"
}
Update
PUT
https://<<platform-server>>/ds-api/users/{email}
Update User Properties
Path Parameters
email*
String
Headers
user-token*
String
Generated Access Token
Request Body
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
role
String
Deprecated since version 2024.04 use roles instead Role used for Role Based Access Control Default: No restriction
comment
String
Response
{
"status": "User updated successfully!"
}
Delete
DELETE
https://<<platform-server>>/ds-api/users/{email}
Delete User
Path Parameters
email*
String
Headers
user-token*
String
Generated Access Token
Response
{
"message": "User deleted"
}
Assign role
POST
https://<<platform-server>>/ds-api/users/{email}/role/{role name}
Add an existing role to a user
Path Parameters
email*
String
role name
String
Existing role
Headers
user-token*
String
Generated Access Token
Response
{
"status": "Role role_2 has been assigned to [email protected]"
}
Remove role
DELETE
https://<<platform-server>>/ds-api/users/{email}/role/{role name}
Remove an existing role from a user
Path Parameters
email*
String
role name
String
Existing role
Headers
user-token*
String
Generated Access Token
Response
{
"status": "Role role_2 has been removed from [email protected]"
}
Users
Display
GET
https://<<platform-server>>/ds-api/users
Display All Users
Headers
user-token*
String
Generated Access Token
Response
[
{
"id": 2,
"login": "datasentinel",
"email": "[email protected]",
"profile": "data admin",
"privilege": "admin",
"roles": [],
"live_360": 1,
"comment": ""
},
{
"id": 54,
"login": "username",
"email": "[email protected]",
"profile": "data admin",
"privilege": "read",
"roles": ["role_1", "role_2"],
"live_360": 0,
"comment": ""
}
]
Last updated