availableUserTypes
Retrieves the available user types and roles from VidyoPortal. This information is needed to invoke the restAuthentication API.
Content type: Application/json
Supported method: GET
Sample URL: http://yourfqdn/admin/service//availableUserTypes
GET
Sample request
http://example.com/admin/service/availableUserTypes
Sample response
{
"status":{
"code":"200",
"message":"OK"
},
"data":[
{
"roleID":1,
"roleName":"Admin",
"roleDescription":"Admin"
},
{
"roleID":2,
"roleName":"Operator",
"roleDescription":"Operator"
},
{
"roleID":3,
"roleName":"Normal",
"roleDescription":"Normal"
},
{
"roleID":4,
"roleName":"VidyoRoom",
"roleDescription":"VidyoRoom"
},
{
"roleID":7,
"roleName":"Executive",
"roleDescription":"Executive"
}
]
}
Request parameter
|
Name |
Type |
Description |
Required |
|---|---|---|---|
|
data |
List of Role Objects |
A list of user type and role objects |
Yes |
|
roleID |
Integer |
Role ID |
Yes |
|
roleName |
String |
Name of the role |
No |
|
roleDescription |
String |
Describes the role |
No |