Retrieve role data

The roles request retrieves AFA roles data.

The input will be the active session ID.

Resource Name: /afa/api/v1/users/Roles

Request Method: GET

Parameters:

Element

Type

Description

sessionMandatory

String

Session ID returned in login request.

domainOptional

String

Domain ID for a multi-domain environment

Relevant only when domains are enabled.

Default: 0

Response:

Code

Description

200

OK and returns data in JSON format.

401

Unauthorized domain

403

Non-admin user

Request example

curl -k 'https://127.0.0.1/afa/api/v1/users/Roles?session=1d61d46c3093b0f31bb76054dfc3271b

Response example{

{ "RolesName":”<user name>”, "RoleDescription ":”<roles description>”, "LadpDN":”<LDAP group corresponding to the current role>”, "LandingPage":”<landing page name>”, "FireflowAdmin":”<is administrator : yes or no>”, "EnableAnalysisFromFile":”<permitted to run analysis from file : yes or no>”, "EnableGlobalCustomization":”<permitted for global configuration : yes or no>”, "AuthorizedDevices":[ {   "ID":”<device name>”, “DisplayName”:”<display name>”,  "Profile":”<authorization profile : standard, read only, etc>”, "Notification":”<notification : yes, no>” } ], “Domain”:”<domain ID>” }