Update a user

PUT /users/{email}

Overview

This API updates the user record associated with the specified email address.

Prerequisites

  • Org admin (Environment admin) permissions

Request

 PUT https://{controlplane_path}/api/1/rest/public/users/{email}

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.

Example: control-plane-name.snaplogic.com

Where control-plane-name is the control plane you are using. For example,
  • elastic
  • uat
  • emea
email Required. The email address of the user.

Query Parameters

None.

Request Header

Specify Basic for authorization and application/json for content type.

 Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body

 {
  "first_name" : "...",
  "last_name" : "...",
  "allow_password_login" : true,
  "revoke_old_password" : true,
  "utility" : true,
  "ui_access" : true,
  "created_by" : "...",
  "certificate" : "...",
  "file_handle" : "..."
}
Key Type Description
first_name string The first name of the user.
last_name string The last name of the user.
allow_password_login Boolean If true, the user is allowed to log in with a password.
revoke_old_password Boolean If true, the user's password is invalidated.
utility Boolean If true, the account is tagged as a service account, not a user account, for use with automated processes.
ui_access Boolean If true, the user is granted access to the SnapLogic UI.
created_by string The user who originally created the account, if it is a service account.

Learn more: Creating a User

certificate string
file_handle string