Umbrella User Config API: create users and roles

Users and Roles

The Umbrella User Config API enables you to manage users and their roles in Umbrella.

The Umbrella User Config API includes two resources:

  • Users /users
  • Roles /roles

Create a User

Create a user in the organization.

POST /organizations/{organizationId}/users

Request Body Fields

Name Type Description
firstname string The user's first name.
Required
lastname string The user's last name.
Required
email string The user's email address.
Required
password string The user's password.
Required
roleId integer A role ID.
Required
timezone string The user's timezone.
Required

Request

curl -i GET "https://management.api.umbrella.com/v1/organizations/{organizationId}/users" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json' \
-d '{
    "firstname": "newCustomer",
    "lastname": 25,
    "email": "UserEmail",
    "password": "UserPassword",
    "roleId": "UserRoleId",
    "timezone": "Timezone for the User"
}'

Response

Sample response (200, OK):

{
    "id": 1,
    "email": "",
    "role": "",
    "roleId": "",
    "timezone": "",
    "status": "",
    "twoFactorEnable": true
}

List Roles

GET /organizations/{organizationId}/roles

Find the roles in the organization.

Request

curl -i GET "https://management.api.umbrella.com/v1/organizations/{organizationId}/roles" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json'

Response

Click to view the sample response (200, OK) 

[
    {
        "organizationId": 1,
        "label": "Full Admin",
        "roleId": 1
    },
    {
        "organizationId": 2,
        "label": "Read Only",
        "roleId": 2
    },
    {
        "organizationId": 3,
        "label": "Block Page Bypass",
        "roleId": 3
    },
    {
        "organizationId": 4,
        "label": "Reporting Only",
        "roleId": 4
    },
    {
        "organizationId": 5,
        "label": "Investigate Only",
        "roleId": 5
    },
    {
        "organizationId": 6,
        "label": "Security Administrator",
        "roleId": 6
    }
]