Skip to main content

User

Specification

{
"userName": String,
"firstName": String,
"lastName": String,
"userStatus": String,
"serviceAccount": Boolean
}

Structure values

Field NameTypeDescriptionRequiredDefault
userNameStringUser name.Required
firstNameStringUser’s first name.None
lastNameStringUser’s last name.None
userStatusStringThe status of the user: Active or Disabled. Only Active users are able to sign into the platform.Active
serviceAccountBooleanFlag denoting this user is a service account. Service accounts will not have passwords and an Org Admin will need to generate a personal access token for the user.None

Example

{
"userName": "john@silect.is",
"firstName": "John",
"lastName": "Doe"
}