Security

Get security role

get/sites/{site-identifier}/global/security/roles/{role-guid}

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/global/security/roles/{role-guid}
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: default)

Path parameters

site-identifierstring required

The GUID that identifies a site

role-guidstring required
Example:e3c76443-8126-05b6-9914-c88c1ce84725

The GUID that identifies a security role

Response

Success

RoleGUIDstring guid
RoleCodestring
RoleNamestring
RoleDescriptionstring
SystemDefinedboolean
RoleActiveboolean

Example response

{
  "RoleGUID": "c64a977c-5458-bb91-8a14-ae8f1c2e0976",
  "RoleCode": "ROLE-SITE-ADMIN",
  "RoleName": "Site Admin",
  "RoleDescription": "This role is suited to senior staff requiring full access (excluding billing information)",
  "SystemDefined": true,
  "RoleActive": true,
  "Policies": [
    {
      "PolicyCode": "ADD-CORPORATE-ACTIONS",
      "PolicyDescription": "Can add, edit and deactivate corporate actions in library",
      "Value": "Allow",
      "ConstraintValue": "Allow",
      "ConstraintValueList": "Allow,Deny",
      "DefaultConstraintValue": "Allow",
      "UseDefaultConstraintValue": true
    }
  ],
  "Permissions": [
    "delete",
    "modify",
    "deactivate",
    "reactivate"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.