API List User Rights

This API provides a list of all security rights.

Resource URL

http://valt.example.com/api/v3/rights

Resource Information

Method	GET
Response Type	JSON
Authentication Required	Yes

Parameters

No parameters can be passed to this call.

Response

Code	Reason
200	Request Successful
401	Unauthorized

JSON Response

data
		This API call returns an array of JSON objects.
	name	Security Right Category
	sub_rights	Array of security rights in the above category.

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/rights?access_token=e82632d19c523678fea3d1016c6df9e9

Successful Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"data":[
{
"name": "general",
"sub_rights":[
"general--home",
"general--alert",
"general--edit-profile",
"general--password-complexity",
"general--change-password",
"general--notifications"
]
},
{
"name": "upload",
"sub_rights":[
"upload--sharing",
"upload--retention",
"upload--author"
]
},
{
"name": "monitoring",
"sub_rights":[
"monitoring--search",
"monitoring--multi-select",
"monitoring--talkback",
"monitoring--ptz",
"monitoring--ptz--ptz-control",
"monitoring--ptz--can-ptz-all-authors",
"monitoring--ptz--edit-presets",
"monitoring--ptz--use-presets",
"monitoring--lock-rooms",
"monitoring--unlock-all-users",
"monitoring--views",
"review--edit-sharing",
"review--generate-link",
"monitoring--recording",
"monitoring--recording--start-recording",
"monitoring--recording--stop-all-authors",
"monitoring--recording--stop-confirmation",
"monitoring--recording--sharing",
"monitoring--recording--retention",
"monitoring--recording--reassign-author",
"monitoring--recording--prepare-recording",
"monitoring--recording--pause-recording",
"monitoring--recording--pause-all-authors",
"monitoring--recording--resume-all-authors",
"monitoring--view--recording",
"monitoring--recording--evaluation",
"monitoring--recording--evaluation--view-option-values",
"monitoring--recording--evaluation--view-field-values",
"monitoring--recording--evaluation--view-total-value",
"monitoring--recording--options",
"monitoring--recording--options-all-authors"
]
},
{
"name": "review",
"sub_rights":[
"review--markers",
"review--markers--see-all",
"review--markers--add-markers",
"review--markers--edit-markers",
"review--markers--delete-markers",
"review--tools",
"review--tools--redact",
"review--tools--clip",
"review--delete-recordings",
"review--download-recordings",
"review--download-recordings--audio-only",
"review--download-recordings--multiview",
"review--edit-information",
"review--edit-sharing",
"review--generate-link",
"review--edit-retention",
"review--reassign-author",
"review--markers--marker-overlay",
"review--evaluation",
"review--evaluation--view-option-values",
"review--evaluation--view-field-values",
"review--evaluation--view-total-value",
"review--evaluation--edit"
]
},
{
"name": "schedule",
"sub_rights":[
"schedule--add-schedule",
"schedule--exceptions",
"schedule--edit-schedules",
"schedule--delete-and-remove-schedules",
"schedule--sharing",
"schedule--rentention",
"schedule--control",
"schedule--edit-all-schedules",
"schedule--view-all-schedules",
"schedule--change-author"
]
},
{
"name": "reports",
"sub_rights":[
"reports--add-report",
"reports--edit-report",
"reports--delete-report"
]
},
{
"name": "admin",
"sub_rights":[
"admin--general",
"admin--templates",
"admin--rooms",
"admin--users-and-groups",
"admin--logs",
"admin--help",
"admin--wowza",
"admin--containers",
"admin--saml",
"admin--ldap",
"admin--multi-delete",
"admin--software-information",
"admin--media-servers",
"admin--customization",
"admin--ldap--user-import",
"admin--ldap--servers",
"admin--ldap--sync-schedules",
"admin--email-settings"
]
}
]
}

Failure Response

{"error":{"code":401,"message":"No API key provided"}}