Group Users Resource
Description
This resource is for managing users within a group.
GET /groups/:ID/users
Returns the set of users created for this group. This is a paged query.
GET Parameters
| Name | Required | Type | Description | Default Value |
|---|---|---|---|---|
| :ID | Yes | URL Parameter | The numeric ID of the group resource you are querying for users. |
GET Response Values
| Name | Type | Description |
|---|---|---|
| login | JSON String | The username for the user. |
| roles | JSON Array | A JSON Array of roles assigned to the user. |
| group | JSON Object | The JSON representation of the group resource the user is assigned to. |
| user | JSON String | The user resource for this user. |
| change_password_resource | JSON String | The change password resource for this user. |
Example GET Request
GET /groups/407/users
Example GET Response
{
"rows": 1,
"data": [
{
"login": "the_new_guy",
"roles": [
{
"name": "Test Group 3 read write",
"description": "a role created by default",
"features": [
{
"name": "group",
"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_admin",
"privilege": "none"
},
{
"name": "device",
"privilege": "none"
},
{
"name": "rweb",
"privilege": "none"
}
],
"role_resource": "/roles/961",
"users": [
"the_new_guy"
],
"admin_group": {
"name": "Electic bugaloo",
"description": "Test group 4",
"mode": "NONE",
"customer_resource": "/customers/407",
"zones_resource": "/groups/407/zones",
"reports_resource": "/groups/407/report_statuses",
"scheduled_reports_resource": "/groups/407/scheduled_reports",
"customer_configurations_resource": "/groups/407/configurations",
"customer_devices_resource": "/groups/407/mapped_devices",
"customer_traffic_resource": "/groups/407/traffic",
"customer_logs_resource": "/groups/407/logs",
"group_resource": "/groups/407",
"group_configurations_resource": "/groups/407/configurations",
"group_traffic_resource": "/groups/407/traffic",
"group_logs_resource": "/groups/407/logs",
"members_resource": "/groups/407/members",
"roles_resource": "/groups/407/roles",
"users_resource": "/groups/407/users",
"templates_resource": "/groups/407/templates",
"subnets_resource": "/groups/407/subnets",
"mapped_devices_resource": "/groups/407/mapped_devices",
"pre_mapped_devices_resource": "/groups/407/pre_mapped_devices",
"sub_groups_resource": "/groups/407/groups",
"parent_resource": "/groups/279"
},
"group_resources": [
"/groups/407"
]
}
],
"group": {
"name": "Electic bugaloo",
"description": "Test group 4",
"mode": "NONE",
"customer_resource": "/customers/407",
"zones_resource": "/groups/407/zones",
"reports_resource": "/groups/407/report_statuses",
"scheduled_reports_resource": "/groups/407/scheduled_reports",
"customer_configurations_resource": "/groups/407/configurations",
"customer_devices_resource": "/groups/407/mapped_devices",
"customer_traffic_resource": "/groups/407/traffic",
"customer_logs_resource": "/groups/407/logs",
"group_resource": "/groups/407",
"group_configurations_resource": "/groups/407/configurations",
"group_traffic_resource": "/groups/407/traffic",
"group_logs_resource": "/groups/407/logs",
"members_resource": "/groups/407/members",
"roles_resource": "/groups/407/roles",
"users_resource": "/groups/407/users",
"templates_resource": "/groups/407/templates",
"subnets_resource": "/groups/407/subnets",
"mapped_devices_resource": "/groups/407/mapped_devices",
"pre_mapped_devices_resource": "/groups/407/pre_mapped_devices",
"sub_groups_resource": "/groups/407/groups",
"parent_resource": "/groups/279"
},
"user": "/users/161",
"change_password_resource": "/users/161/change_password"
}
],
"start": 0
}
POST /groups/:ID/users
Create a new user for the group with the assigned role resources.
POST Parameters
| Name | Required | Type | Description | Default Value |
|---|---|---|---|---|
| :ID | Yes | URL Parameter | The numeric ID of the group resource the user is being created for. | |
| login | Yes | JSON String | The desired login name for the new user. | |
| password | Yes | JSON String | The password for the new user. | |
| role_resources | Yes | JSON Array | An array of role resources that should be assigned to the user. You must use at least one role resource. The roles additionally should belong to the group used in the URL parameter. You can query what is available using group roles. |
POST Response Values
| Name | Type | Description |
|---|---|---|
| login | JSON String | The username for the user. |
| roles | JSON Array | A JSON Array of roles assigned to the user. |
| group | JSON Object | The JSON representation of the group resource the user is assigned to. |
| user | JSON String | The user resource for this user. |
| change_password_resource | JSON String | The change password resource for this user. |
Example POST Request
POST /groups/407/users
JSON Body:
{
"data" : {
"login" : "newer_user_guy",
"password" : "test123",
"role_resources" : ["/roles/1887"]
}
}
Example POST Response
HTTP/1.1 201 Created
{
"login": "newer_user_guy",
"roles": [
{
"name": "API Inserted Role",
"description": "Used API to create this role.",
"features": [
{
"name": "group",
"privilege": "ro"
},
{
"name": "mitigation_reporting",
"privilege": "ro"
},
{
"name": "mitigation_config",
"privilege": "ro"
},
{
"name": "limit_resource",
"privilege": "none"
},
{
"name": "group_routing",
"privilege": "none"
},
{
"name": "zone_routing",
"privilege": "none"
},
{
"name": "group_admin",
"privilege": "none"
},
{
"name": "device",
"privilege": "none"
},
{
"name": "rweb",
"privilege": "none"
}
],
"role_resource": "/roles/1887",
"users": [
"newer_user_guy"
],
"admin_group": {
"name": "Electic bugaloo",
"description": "Test group 4",
"mode": "NONE",
"customer_resource": "/customers/407",
"zones_resource": "/groups/407/zones",
"reports_resource": "/groups/407/report_statuses",
"scheduled_reports_resource": "/groups/407/scheduled_reports",
"customer_configurations_resource": "/groups/407/configurations",
"customer_devices_resource": "/groups/407/mapped_devices",
"customer_traffic_resource": "/groups/407/traffic",
"customer_logs_resource": "/groups/407/logs",
"group_resource": "/groups/407",
"group_configurations_resource": "/groups/407/configurations",
"group_traffic_resource": "/groups/407/traffic",
"group_logs_resource": "/groups/407/logs",
"members_resource": "/groups/407/members",
"roles_resource": "/groups/407/roles",
"users_resource": "/groups/407/users",
"templates_resource": "/groups/407/templates",
"subnets_resource": "/groups/407/subnets",
"mapped_devices_resource": "/groups/407/mapped_devices",
"pre_mapped_devices_resource": "/groups/407/pre_mapped_devices",
"sub_groups_resource": "/groups/407/groups",
"parent_resource": "/groups/279"
},
"group_resources": [
"/groups/407"
]
}
],
"group": {
"name": "Electic bugaloo",
"description": "Test group 4",
"mode": "NONE",
"customer_resource": "/customers/407",
"zones_resource": "/groups/407/zones",
"reports_resource": "/groups/407/report_statuses",
"scheduled_reports_resource": "/groups/407/scheduled_reports",
"customer_configurations_resource": "/groups/407/configurations",
"customer_devices_resource": "/groups/407/mapped_devices",
"customer_traffic_resource": "/groups/407/traffic",
"customer_logs_resource": "/groups/407/logs",
"group_resource": "/groups/407",
"group_configurations_resource": "/groups/407/configurations",
"group_traffic_resource": "/groups/407/traffic",
"group_logs_resource": "/groups/407/logs",
"members_resource": "/groups/407/members",
"roles_resource": "/groups/407/roles",
"users_resource": "/groups/407/users",
"templates_resource": "/groups/407/templates",
"subnets_resource": "/groups/407/subnets",
"mapped_devices_resource": "/groups/407/mapped_devices",
"pre_mapped_devices_resource": "/groups/407/pre_mapped_devices",
"sub_groups_resource": "/groups/407/groups",
"parent_resource": "/groups/279"
},
"user": "/users/162",
"change_password_resource": "/users/162/change_password"
}