Create a User

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/migrating-to-zephyr-enterprise/via-rest-api/create-a-user.html

Create a new user in Zephyr Enterprise

POST http(s)://{ZEPHYR-SERVER}/flex/services/rest/latest/user

Request body

Create a user without a role:

{
  "firstName": "John",
  "lastName": "Smith",
  "email": "John.Smith@smartbear.com",
  "username": "John.Smith",
  "accountEnabled": true,
  "credentialsExpired": false,
  "isCustomizeUsername": null
}

Create a user with a role:

{
  "firstName": "John",
  "lastName": "Smith",
  "email": "John.Smith@smartbear.com",
  "username": "John.Smith",
  "accountEnabled": true,
  "credentialsExpired": false,
  "isCustomizeUsername": null,
  "roles": [
    { "id":5, "name":"dashboard" },
    { "id":106, "name":"Administration Role" }
  ]
}

Response body

{
  "id": 11,
  "username": "John.Smith",
  "firstName": "John",
  "lastName": "Smith",
  "email": "John.Smith@smartbear.com",
  "accountEnabled": true,
  "accountExpired": false,
  "credentialsExpired": false,
  "roles": [],
  "userType": 0,
  "chargeableFlag": true,
  "onlyLoggedInUser": false,
  "groupSet": [],
  "countAttempts": 0,
  "isInternal": true,
  "fullName": "John Smith"
}

Assign a role to the user (or update data of an existing user).

PUT http(s)://{ZEPHYR-SERVER}/flex/services/rest/v3/user/{user ID}

where {user ID} is the ID of the Zephyr Enterprise user.

Request body

{
  "firstName":"John",
  "lastName":"Smith",
  "type":"",
  "roles":[
          {"id":5,"name":"dashboard"},
          {"id":106,"name":"Administration Role "}
        ],
  "email":"John.Smith@abc.com",
  "username":"John.Smith",
  "accountEnabled":true,
  "credentialsExpired":true,
  "id":10,
  "isCustomizeUsername":null,
  "userType":0,
  "chargeableFlag":true,
  "groupSet":[]
}

Zephyr Enterprise 8.1.0

Create a User

Create a new user in Zephyr Enterprise

Assign a role to the user (or update data of an existing user).

See Also

Related content