GET/ permissions
This API is used to retrieve information related to system permissions that can be granted to users via user role assignment. Utilize the returned ID when defining the permissions necessary for new roles. For additional information, access the permissions data model.
Method
GET
Resource Information
| Requires authentication? | YES |
| Response formats | JSON |
Parameters
| Parameter | Required | Description |
|---|---|---|
| page | No | specifies the page number from where you want to begin accessing records |
Filtering
The fields in the table below can be used in the query string of a GET request, for example:
GET https://<server>/v1/employees?firstName=JohnCurrently, it is only possible to query for exact values (no wildcards or partial matches); however, the query criteria is case-insensitive.
| Parameter | Type | Description |
|---|---|---|
| category | string | Permission’s category |
| displayName | text | Permission’s name |
Example
Request Example
GET https://<server>/v1/permissions
Response Example
{
""searchResult"": [
{
""id"": 1,
""category"": ""Employee"",
""displayName"": ""Access all employee records""
},
{
""id"": 2,
""category"": ""I-9"",
""displayName"": ""Park Incomplete I-9s""
},
{
""id"": 3,
""category"": ""Remediation"",
""displayName"": ""Create/Edit Archival Paper I-9s""
},
{
""id"": 4,
""category"": ""Remediation"",
""displayName"": ""Exempt I-9 Issues""
},
{
""id"": 5,
""category"": ""Reporting"",
""displayName"": ""Access Basic Reports""
},
{
""id"": 6,
""category"": ""Reporting"",
""displayName"": ""Access Charts & Graphs""
},
{
""id"": 6,
""category"": ""Reporting"",
""displayName"": ""Access Interactive Reports""
},
{
""id"": 7,
""category"": ""Reporting"",
""displayName"": ""View dashboard mini charts""
},
{
""id"": 8,
""category"": ""Reporting"",
""displayName"": ""Create/Edit Basic Reports""
},
{
""id"": 9,
""category"": ""Reporting"",
""displayName"": ""Create/Edit Charts & Graphs""
},
{
""id"": 10,
""category"": ""Reporting"",
""displayName"": ""Create/Edit Interactive Reports""
},
{
""id"": 11,
""category"": ""Support"",
""displayName"": ""Is an in-system I-9 support expert""
},
{
""id"": 12,
""category"": ""Support"",
""displayName"": ""Administer system""
},
{
""id"": 13,
""category"": ""Employee"",
""displayName"": ""Create employees""
},
{
""id"": 14,
""category"": ""Employee"",
""displayName"": ""Work with employees outside managed groups""
},
{
""id"": 15,
""category"": ""E-Verify"",
""displayName"": ""Manage E-Verify Cases""
},
{
""id"": 16,
""category"": ""I-9"",
""displayName"": ""Approve I-9s""
},
{
""id"": 17,
""category"": ""I-9"",
""displayName"": ""Create/Edit Electronic I-9s""
},
{
""id"": 18,
""category"": ""I-9"",
""displayName"": ""Create/Edit New Hire Paper I-9s""
},
{
""id"": 19,
""category"": ""Remediation"",
""displayName"": ""Amend I-9s""
},
{
""id"": 20,
""category"": ""Remediation"",
""displayName"": ""Approve Amendments""
}
],
""links"": [
{
""href"": ""/v1/permissions/"",
""rel"": ""self""
},
{
""href"": ""/v1/permissions/?page=1"",
""rel"": ""first""
},
{
""href"": ""/v1/permissions/?page=0"",
""rel"": ""last""
},
{
""href"": ""/v1/permissions/?page=2"",
""rel"": ""next""
},
{
""href"": ""/v1/permissions/?page=0"",
""rel"": ""previous""
}
]
}