Skip to main content
PATCH
/
users
/
{userName}
Error
A valid request URL is required to generate request examples
{
  "userName": "<string>",
  "email": "[email protected]",
  "firstName": "<string>",
  "lastName": "<string>",
  "businessRole": "<string>",
  "tutorialStatus": {
    "projectTutorial": {
      "hasClickedCreateModel": false,
      "doNotShowModelIntro": false,
      "doNotShowSchemaExplorerTip": false,
      "doNotShowTutorialInHomePanel": false
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
userName
string
required

The unique identifier of the user Valid email address pattern

Body

application/json

Represents a user account with profile information and tutorial status

​
userName
string

The unique username for the user account

​
password
string

User's password (only included in create/update requests, never in responses)

​
email
string<email>

User's email address, used for authentication and notifications

​
firstName
string

User's first name

​
lastName
string

User's last name

​
businessRole
string

User's business role or job title

​
tutorialStatus
object

Represents the tutorial completion status and user preferences for onboarding

Response

User updated successfully

Represents a user account with profile information and tutorial status

​
userName
string

The unique username for the user account

​
email
string<email>

User's email address, used for authentication and notifications

​
firstName
string

User's first name

​
lastName
string

User's last name

​
businessRole
string

User's business role or job title

​
tutorialStatus
object

Represents the tutorial completion status and user preferences for onboarding