Update user account

PATCH/users/{userName}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

userName*string

The unique identifier of the user

Match^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

Request Body

application/json

Represents a user account with profile information and tutorial status

userName?string

The user's username — an email address used for authentication. Matches the path-parameter form on /users/{userName}. (Previously $ref'd IdentifierPattern, which disallowed '@' and '.'; that was never enforced at runtime so production data is all emails.)

Formatemail

password?string

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

email?string

User's email address, used for authentication and notifications

Formatemail

firstName?string

User's first name. May be empty when the row was auto-created (e.g. Auth0 ensure-user path) before the user filled in their profile — UI flows that capture a name should PATCH this in.

Lengthlength <= 64

lastName?string

User's last name. May be empty when the row was auto-created (e.g. Auth0 ensure-user path) before the user filled in their profile — UI flows that capture a name should PATCH this in.

Lengthlength <= 64

businessRole?string

User's business role or job title

tutorialStatus?

Represents the tutorial completion status and user preferences for onboarding

Response Body

`application/json`

curl --request PATCH \  --url 'https://example.com/users/string' \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

{  "userName": "user@example.com",  "password": "string",  "email": "user@example.com",  "firstName": "string",  "lastName": "string",  "businessRole": "string",  "tutorialStatus": {    "environmentTutorial": {      "hasClickedCreateModel": false,      "doNotShowModelIntro": false,      "doNotShowSchemaExplorerTip": false,      "doNotShowTutorialInHomePanel": false,      "doNotShowConnectionOnboarding": false    }  }}

Update user account

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`