Retrieve the list of security roles in a center

This API helps you to fetch the list of security roles in a center.

You must specify appropriate details for the type parameter in the API request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Details

NameTypeDescription
security_rolesobjectObject that contains security ID and security role-related elements. For more information, refer to the security_roles Object table.
page_infoobjectObject that contains the pagination-related elements of the response. For more information, refer to the page_info Object table.
errorobjectObject that contains error message and error code details. For more information, refer to the error Object table.

security_roles Object

NameTypeDescription
idguidUnique 32-character identifier of the security role.
namestringName of the security role in the center. For example, Inventory Manager.

page_info Object

NameTypeDescription
totalintTotal records found in the response.
pageintNumber of pages to be viewed.
sizeintNumber of records displayed per page.

error Object

codemessage
502Type 0 will only be supported at present that is for only center.
Query Params
string
enum
required
Defaults to -3

Mandatory Indicates that the list of security roles is to be retrieved from: All - 0, Organization - 1, Zone - 2, and Center - 3. Default value - 3. Note: Currently, this API only supports the retrieval of center-level security roles.

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json