Get Updated Roles
- Print
- DarkLight
- PDF
Get Updated Roles
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/roles.sync
Gets all the roles in the workspace which are updated after a given date.
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Added |
Header parameters
X-User-Id
stringRequired
The authenticated user ID.
ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired
The authenticated user token.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
Query parameters
updatedSince
stringRequired
Date as ISO string.
Example2017-11-25T15:08:17.248Z
Responses
200
OK
Success Example
{
"roles": {
"update": [
{
"_id": "admin",
"description": "Admin",
"mandatory2fa": false,
"protected": true,
"scope": "Users"
}
],
"remove": [
{
"_id": "user",
"description": "User",
"mandatory2fa": false,
"protected": true,
"scope": "Users"
}
]
},
"success": true
}object
roles
object
update
Array of object
object
_id
string
description
string
mandatory2fa
boolean
protected
boolean
scope
string
remove
Array of object
object
_id
string
description
string
mandatory2fa
boolean
protected
boolean
scope
string
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "Match error: Missing key 'updatedSince'"
}object
success
boolean
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?