Overview

• Users - Retrieving, creating, and deleting users
• Permissions - Retrieving, creating, and deleting roles, teams, and permissions
• Proxy - Retrieving, creating, and deleting proxy assignments

Users

---

The following provides for the retrieval, creation, edit, and deletion of users

Resource	Description
GET /members/members	Action Get list of all users in the billing group. Permissions: eeg_cloud, users, view
POST /members/members	Action Invite one or more users with role or team IDs to the billing group. Permissions: eeg_cloud, users, add Parameters (JSON) users (string[]) a list of one or more emails to invite to the billing group role_or_team_id (string) the role or team ID that will be assigned to all users
PUT /members/unlock	Action Unlock a locked user's account. Permission: eeg_cloud, users, edit Parameters (JSON) email_address (string) the user's email address to unlock
PUT /members/remove_mfa	Action Remove multi-factor authorization (MFA) from the user's account. Permission: eeg_cloud, users, edit Parameters (JSON) user_id (string) User ID to remove MFA from
PUT /members/:user_id	Action Update the role or team assignment of a user in the billing group. Permission: eeg_cloud, users, edit Parameters (Path) :user_id User ID of user to update Parameters (JSON) role_or_team_id (string) ID of role or team to assign to the user
DELETE /members/:user_id	Action Delete a user from the billing group. Permission: eeg_cloud, users, delete Parameters (Path) :user_id User ID of user to delete

Denotes an optional parameter.

Permissions

---

The following provides for the retrieval, creation, edit, and deletion of permissions

Parameters (Query)

Resource	Description
GET /roles/:user_id	Action Retrieve data of an individual role in the requesting user's billing group. Permission: eeg_cloud, users, view
GET /roles	Action Retrieve a list of all roles in the requesting user's billing group. Permission: eeg_cloud, users, view
POST /roles	Action Create a role in the requesting user's billing group. Permission: eeg_cloud, users, add Parameters (JSON) name (string) the name of the role permissions (list of objects) Each object in the list has three attributes which define what specific permission it is: scope (string) subscope (string) permission (string)
PUT /roles/:role_id	Action Update a role in the requesting user's billing group with new name and new permissions. Permission: eeg_cloud, users, edit Parameters (Path) :role_id ID of the role to update Parameters (JSON) name (string) the name of the role permissions (list of objects) Each object in the list has three attributes which define what specific permission it is: scope (string) subscope (string) permission (string)
DELETE /roles/:role_id	Action Delete a role in the requesting user's billing group. Permission: eeg_cloud, users, delete Parameters (Path) :role_id ID of the role to delete
GET /teams	Action Retrieve a list of all teams in the requesting user's billing group. Permission: eeg_cloud, users, view

expand_roles

If set to 0 or omitted, the response will omit roles data. If set to 1 the response will include role data for the role associated with each returned team, including the role name and the assigned permissions. The API will return a BAD REQUEST error for any value other than 1 or 0.

POST /teams

Action

Create a team in the requesting user's billing group. A user can belong to only one role or team at a time. If the user is currently assigned to a team the user will be removed from the current team and added to the new team.

Permission:

eeg_cloud, users, add

Parameters (JSON)

name (string)	the name of the role
role (string)	the role ID of the team's role
targets (string[])	list of target billing groups to assign to the group
users (string[])	list of email addresses for users to assign to the group

GET /teams/:team_id

Action

Retrieve data of an individual team in the requesting user's billing group.

Permission:

eeg_cloud, users, view

Parameters (Path)

:team_id

ID of the team to retrieve

PUT /teams/:team_id

Action

Update data of a team in the requesting user's billing group.

Permission:

eeg_cloud, users, edit

Parameters (Path)

:team_id

ID of the team to retrieve

Parameters (JSON)

name (string)	the name of the role
role (string)	the role ID of the team's role
targets (string[])	list of target billing groups to assign to the group
users (string[])	list of email addresses of users to assign to the group

DELETE /teams/:team_id

Action

Delete a team in the requesting user's billing group.

Permission:

eeg_cloud, users, delete

Parameters (Path)

:team_id

ID of the team to delete

GET /profile/profile_info

Action

Retrieve the data of the requesting user and the billing group profile data of the requesting user.

Permission:

none POST /profile/billing_group

Action

Update the profile data of the requesting user's billing group.

Permission:

eeg_cloud, billing, edit

Parameters (JSON)

organization (string)	the name of the organization
custom_timeout (number)	the number value of seconds for login timeout

Denotes an optional parameter.

Proxy

---

The following provides for the retrieval, creation, edit, and deletion of proxy assignments

Resource	Description
GET /proxy/source	Action Retrieve the requesting user's billing group's proxy configuration, including its target groups, and user target assignments. Permission: none
POST /proxy/target_assignment	Action Create a user proxy assignment for a user in the requesting user's billing group. Permission: eeg_cloud, users, add Parameters (JSON) permissions (list of objects) Each object in the list has three attributes which define what specific permission it is: permissions (string) role ID targets (string[]) list of target billing group IDs user_email_address (string) ID of user for assignment
PUT /proxy/target_assignment/:user_id	Action Update a proxy assignment in the requesting user's billing group. Permission: eeg_cloud, users, edit Parameters (Path) :user_id ID of user to update proxy assignment of Parameters (JSON) permissions (list of objects) Each object in the list has three attributes which define what specific permission it is: permissions (string) role ID. This is the only value that can change. target (string) target billing group ID. Must match the existing value. user_email_address (string) Email address for the user to be assigned. Must match the existing value.
DELETE /proxy/target_assignment/:user_id/target_delete/:target_delete	Action Delete a proxy assignment in the requesting user's billing group. Permission: eeg_cloud, users, delete Parameters (Path) :user_id ID of user that is assigned the proxy assignment to delete :target_delete ID of the proxy assignment to delete

Denotes an optional parameter.