Authentication Resource
Description
Main resource used for authenticating an API user.
GET /authentication
Returns information about the currently authenticated user.
GET Response Values
| Name | Type | Description |
|---|---|---|
| login | JSON String | The username of the authenticated user. |
| roles | JSON Array | An array containing each role object the user has been assigned. |
| group | JSON Object | This is the top level group the user has access to. If an admin user, this will always be the Default Group. |
| user | JSON String | The user resource identifying this user. |
Example GET Request
GET /authentication
Example GET Response
{
"login": "nmanners",
"roles": [
{
"name": "admin",
"description": "",
"features": [
{
"name": "device",
"privilege": "rw"
},
{
"name": "rweb",
"privilege": "rw"
},
{
"name": "mitigation_reporting",
"privilege": "rw"
},
{
"name": "mitigation_config",
"privilege": "rw"
},
{
"name": "limit_resource",
"privilege": "rw"
},
{
"name": "group_routing",
"privilege": "rw"
},
{
"name": "zone_routing",
"privilege": "rw"
},
{
"name": "group",
"privilege": "rw"
},
{
"name": "group_admin",
"privilege": "rw"
}
],
"role_resource": "/roles/1",
"users": [
"admin",
"nmanners",
"upgrade"
],
"admin_group": {
"name": "Default",
"description": "",
"mode": "NONE",
"customer_resource": "/customers/0",
"zones_resource": "/groups/0/zones",
"reports_resource": "/groups/0/report_statuses",
"scheduled_reports_resource": "/groups/0/scheduled_reports",
"customer_configurations_resource": "/groups/0/configurations",
"customer_devices_resource": "/groups/0/mapped_devices",
"customer_traffic_resource": "/groups/0/traffic",
"customer_logs_resource": "/groups/0/logs",
"group_resource": "/groups/0",
"group_configurations_resource": "/groups/0/configurations",
"group_traffic_resource": "/groups/0/traffic",
"group_logs_resource": "/groups/0/logs",
"members_resource": "/groups/0/members",
"roles_resource": "/groups/0/roles",
"users_resource": "/groups/0/users",
"templates_resource": "/groups/0/templates",
"subnets_resource": "/groups/0/subnets",
"mapped_devices_resource": "/groups/0/mapped_devices",
"pre_mapped_devices_resource": "/groups/0/pre_mapped_devices",
"sub_groups_resource": "/groups/0/groups",
"parent_resource": ""
},
"group_resources": [
"/groups/0",
"/groups/626",
"/groups/675",
"/groups/616",
"/groups/677",
"/groups/696",
"/groups/401",
"/groups/706",
"/groups/404",
"/groups/10",
"/groups/13",
"/groups/15",
"/groups/112",
"/groups/114",
"/groups/93",
"/groups/621",
"/groups/570",
"/groups/575",
"/groups/408",
"/groups/631",
"/groups/637",
"/groups/642",
"/groups/647",
"/groups/580",
"/groups/652",
"/groups/657",
"/groups/74",
"/groups/96",
"/groups/77",
"/groups/98",
"/groups/99",
"/groups/309",
"/groups/109",
"/groups/76",
"/groups/113",
"/groups/116",
"/groups/117",
"/groups/261",
"/groups/698",
"/groups/279",
"/groups/314",
"/groups/364",
"/groups/291",
"/groups/368"
]
}
],
"group": {
"name": "Default",
"description": "",
"mode": "NONE",
"customer_resource": "/customers/0",
"zones_resource": "/groups/0/zones",
"reports_resource": "/groups/0/report_statuses",
"scheduled_reports_resource": "/groups/0/scheduled_reports",
"customer_configurations_resource": "/groups/0/configurations",
"customer_devices_resource": "/groups/0/mapped_devices",
"customer_traffic_resource": "/groups/0/traffic",
"customer_logs_resource": "/groups/0/logs",
"group_resource": "/groups/0",
"group_configurations_resource": "/groups/0/configurations",
"group_traffic_resource": "/groups/0/traffic",
"group_logs_resource": "/groups/0/logs",
"members_resource": "/groups/0/members",
"roles_resource": "/groups/0/roles",
"users_resource": "/groups/0/users",
"templates_resource": "/groups/0/templates",
"subnets_resource": "/groups/0/subnets",
"mapped_devices_resource": "/groups/0/mapped_devices",
"pre_mapped_devices_resource": "/groups/0/pre_mapped_devices",
"sub_groups_resource": "/groups/0/groups",
"parent_resource": ""
},
"user": "/users/16"
}
POST /authentication
Logs in as the specified user.
POST Parameters
| Name | Required | Type | Description | Default Value |
|---|---|---|---|---|
| login | Yes | JSON String | The username you are logging in with | |
| password | Yes | JSON String | The password for the user account |
POST Response Values
| Name | Type | Description |
|---|---|---|
| login | JSON String | The username of the authenticated user. |
| roles | JSON Array | An array containing each role object the user has been assigned. |
| group | JSON Object | This is the top level group the user has access to. If an admin user, this will always be the Default Group. |
| user | JSON String | The user resource identifying this user. |
Example POST Request
{
"data": {
"login": "nmanners",
"password": "myuserpassword"
}
}
Example POST Response
{
"login": "nmanners",
"roles": [
{
"name": "admin",
"description": "",
"features": [
{
"name": "device",
"privilege": "rw"
},
{
"name": "rweb",
"privilege": "rw"
},
{
"name": "mitigation_reporting",
"privilege": "rw"
},
{
"name": "mitigation_config",
"privilege": "rw"
},
{
"name": "limit_resource",
"privilege": "rw"
},
{
"name": "group_routing",
"privilege": "rw"
},
{
"name": "zone_routing",
"privilege": "rw"
},
{
"name": "group",
"privilege": "rw"
},
{
"name": "group_admin",
"privilege": "rw"
}
],
"role_resource": "/roles/1",
"users": [
"admin",
"nmanners",
"upgrade"
],
"admin_group": {
"name": "Default",
"description": "",
"mode": "NONE",
"customer_resource": "/customers/0",
"zones_resource": "/groups/0/zones",
"reports_resource": "/groups/0/report_statuses",
"scheduled_reports_resource": "/groups/0/scheduled_reports",
"customer_configurations_resource": "/groups/0/configurations",
"customer_devices_resource": "/groups/0/mapped_devices",
"customer_traffic_resource": "/groups/0/traffic",
"customer_logs_resource": "/groups/0/logs",
"group_resource": "/groups/0",
"group_configurations_resource": "/groups/0/configurations",
"group_traffic_resource": "/groups/0/traffic",
"group_logs_resource": "/groups/0/logs",
"members_resource": "/groups/0/members",
"roles_resource": "/groups/0/roles",
"users_resource": "/groups/0/users",
"templates_resource": "/groups/0/templates",
"subnets_resource": "/groups/0/subnets",
"mapped_devices_resource": "/groups/0/mapped_devices",
"pre_mapped_devices_resource": "/groups/0/pre_mapped_devices",
"sub_groups_resource": "/groups/0/groups",
"parent_resource": ""
},
"group_resources": [
"/groups/0",
"/groups/626",
"/groups/675",
"/groups/616",
"/groups/677",
"/groups/696",
"/groups/401",
"/groups/706",
"/groups/404",
"/groups/10",
"/groups/13",
"/groups/15",
"/groups/112",
"/groups/114",
"/groups/93",
"/groups/621",
"/groups/570",
"/groups/575",
"/groups/408",
"/groups/631",
"/groups/637",
"/groups/642",
"/groups/647",
"/groups/580",
"/groups/652",
"/groups/657",
"/groups/74",
"/groups/96",
"/groups/77",
"/groups/98",
"/groups/99",
"/groups/309",
"/groups/109",
"/groups/76",
"/groups/113",
"/groups/116",
"/groups/117",
"/groups/261",
"/groups/698",
"/groups/279",
"/groups/314",
"/groups/364",
"/groups/291",
"/groups/368"
]
}
],
"group": {
"name": "Default",
"description": "",
"mode": "NONE",
"customer_resource": "/customers/0",
"zones_resource": "/groups/0/zones",
"reports_resource": "/groups/0/report_statuses",
"scheduled_reports_resource": "/groups/0/scheduled_reports",
"customer_configurations_resource": "/groups/0/configurations",
"customer_devices_resource": "/groups/0/mapped_devices",
"customer_traffic_resource": "/groups/0/traffic",
"customer_logs_resource": "/groups/0/logs",
"group_resource": "/groups/0",
"group_configurations_resource": "/groups/0/configurations",
"group_traffic_resource": "/groups/0/traffic",
"group_logs_resource": "/groups/0/logs",
"members_resource": "/groups/0/members",
"roles_resource": "/groups/0/roles",
"users_resource": "/groups/0/users",
"templates_resource": "/groups/0/templates",
"subnets_resource": "/groups/0/subnets",
"mapped_devices_resource": "/groups/0/mapped_devices",
"pre_mapped_devices_resource": "/groups/0/pre_mapped_devices",
"sub_groups_resource": "/groups/0/groups",
"parent_resource": ""
},
"user": "/users/16"
}
DELETE /authentication
Logs out and destroys the existing session.
Example DELETE Request
DELETE /authentication
Example DELETE Response
HTTP/1.1 200 OK