Page tree

Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Get Role API retrieves a specified role. 

You can use the Get Roles API to find the role ID (id).


Sample request

GET https://api.armor.com/roles/4

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/roles/{id}GET

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
idThe ID for the desired roleIntegerRequired4

Sample return

StatusResponse
200
{
 "id": 4,
 "name": "Admin",
 "created": "2015-12-13T02:00:46.51",
 "modified": null,
 "members": [
      {
      "id": 2,
      "firstName": "John",
      "lastName": "Smith",
      "email": "john.smith@example.com",
      "added": "2015-12-13T02:01:30.923",
      "enabled": true
      }
 ],
 "permissions": [
      1,
      2,
      3
 ],
 "default": true
}
404




In this topic



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.