Get User Roles

Version 4.0.25.2 (latest)

Get information about roles of a given user

Request

GET /users/{user_id}/roles
Datatype
Description
Request
HTTP Request
path
HTTP Path
user_id
string
Id of user
query
HTTP Query
fields
string
Requested fields.
direct_association_only
boolean
Get only roles associated directly with the user: exclude those only associated through groups.

Response

200: Roles of user.400: Bad Request404: Not Found429: Too Many Requests
Datatype
Description
(array)
Role[]
can
object
Operations the current user is able to perform on this object
id
string
Unique Id
name
string
Name of Role
permission_set
(Read only) Permission set
can
object
Operations the current user is able to perform on this object
all_access
boolean
built_in
boolean
id
string
Unique Id
name
string
Name of PermissionSet
permissions
string[]
url
string
Link to get this item
permission_set_id
string
(Write-Only) Id of permission set
model_set
(Read only) Model set
can
object
Operations the current user is able to perform on this object
all_access
boolean
built_in
boolean
id
string
Unique Id
models
string[]
name
string
Name of ModelSet
url
string
Link to get this item
model_set_id
string
(Write-Only) Id of model set
url
string
Link to get this item
users_url
string
Link to get list of users with this role
Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link
Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link
Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

Examples