Adding a user

POST https://{{base_url}}/v6/users/new.json

Adding a user

Creates a new user.

Optional (querystring) Parameters

• format=json|xml optional, specifies the format of output requested. See Output Formats for more information
• aid={aid} optional, changes the account group context of the current request. If an invalid account group ID is specified as a parameter, the response will come back as an HTTP/400 error

Request

• content-type and accept headers must be set (both to application/json) when using this endpoint.
• Request body should contain the following fields:
  • name string optional the name of the user
  • email string required email address for the user
  • loginAccountGroup accountGroup object required login accountGroup for the user. If the user being added is already associated with another ThousandEyes organization, this value will be * ignored. The user (once added) can modify his default account group as needed.
  • loginAccountGroup.aid integer required for loginAccountGroup object system-generated unique ID of the account group
  • accountGroupRoles list of accountGroupRole objects see notes see below; either the accountGroupRoles object or the allAccountGroupRoles object must be specified.
  • accountGroupRoles.accountGroupName.aid integer required for accountGroupName object unique account ID for the accountGroupName
  • accountGroupRoles.roles.roleID integer required for roles object system-defined unique ID of the role
  • allAccountGroupRoles list of roles objects optional either the accountGroupRoles object or the allAccountGroupRoles object must be specified.
  • allAccountGroupRoles.roles.roleID integer required for roles object system-defined unique ID of the role

A few notes on the topic of user creation: * If the user is already a member of another ThousandEyes customer’s organization, the user will need to set their own login account group. * Any update which contains accountGroupRoles is a replace-based update, rather than a delta-based update.

Request Body

{"name"=>"Postman DevNet User", "email"=>"postman+devnet@cisco.com", "loginAccountGroup"=>{"aid"=>691}, "accountGroupRoles"=>[{"accountGroup"=>{"aid"=>315}, "roles"=>[{"roleId"=>57}]}, {"accountGroup"=>{"aid"=>691}, "roles"=>[{"roleId"=>60}]}], "allAccountGroupRoles"=>[{"roleId"=>1140}]}

HEADERS