Users Across Multiple Networks in an Organization

To give a user access to another network in your organization, create a login in that network using the same email address. Instead of creating a duplicate login, we will link the user's original login to the new network, and they'll have access to both.

When adding a user to additional networks, the Name field will be ignored in the request.

Error - Duplication

If a user with that email address already exists in the same network, a new login will not be created and the API will return: {"message":"There is already an account associated with this email."}

The "Password" field in the response is a legacy field that is no longer in use. The value is always returned as an empty string.

email
string
required
The email used to login and used for alerts and notifications. A valid email address must be entered.

name
string
Defaults to Null
Friendly name of user. Defaults to null.

defaultTimeZone
string
Defaults to null
If allowed by the network, the preferred time zone of the user. Must be a string in this list. If none supplied, the time zone for the user defaults to the network setting, or if no network setting, GMT.

accessLevel
string
Defaults to read
The user permission level. Must be one of admn, edit, or read. Defaults to read.

canAccessStudio
boolean
Defaults to false
Must be true or false. Controls whether or not this user can access Studio. Defaults to false. Setting CanAccessStudio to true requires that AccessLevel be set to admn or edit.

``200 200

object

id
integer
Defaults to 0

email
string

password
string

name
string

defaultTimeZone
string

accessLevel
string

canAccessStudio
string

ShellJavaScriptRuby

xxxxxxxxxx

curl -X POST -H "X-Adzerk-ApiKey:$ADZERK_API_KEY" -H "Content-Type:application/json" "https://api.kevel.co/v1/login" --data-binary '{"Email":"george.harrison@example.com","Name":"George Harrison","Password":"password", "DefaultTimeZone":"Antarctica/Vostok","AccessLevel":"read","CanAccessStudio":"false"}'

xxxxxxxxxx

{
  "id": 12345,
  "email": "george.harrison@example.com",
  "password": "",
  "name": "George Harrison",
  "defaultTimeZone": "Antarctica/Vostok",
  "accessLevel": "read",
  "canAccessStudio": "false"
}