Update Login

Clearing attribute values

To unset or clear an attribute, set its value to NULL.

Parameters

• loginId
  int32
  required
  ID from the Create Login Endpoint. Can get from List Logins endpoint.

• id
  string
  required
  Login ID of the user

• email
  string
  required
  Required by the API, but not updated. You can send as an empty string.

• name
  string
  required
  Friendly name of the user. If not included, will reset to null

• defaultTimeZone
  string
  If allowed by the network, the preferred time zone of the user.

• accessLevel
  string
  Defaults to
  The user permission level. Must be one of admn, edit, or read. If AccessLevel is not set, the user will retain the current AccessLevel.

• 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.

Example Request

curl -X PUT -H "X-Adzerk-ApiKey:$ADZERK_API_KEY" -H "Content-Type:application/json" "https://api.kevel.co/v1/login/12345" --data-binary '{"Id":12345,"Email":"","Name":"George Harrison","DefaultTimeZone":"UTC","AccessLevel":"read","CanAccessStudio":"false"}'

Example Response

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

Updated 10 months ago