Users

Update User

Changed on

Update an individual user.

patch/v3/users/{userId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/users/{userId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

full_namestring

The user's full name.

preferred_namestring

The user's desired name.

Example request

{
  "full_name": "James C. Woods",
  "preferred_name": "Jimmy"
}

Response

A get action response of a single user.

idstring uuid

The User ID.

emailstring email

The email registered to the user.

full_namestring

The User's full name.

preferred_namestring

The User's preferred name.

activeboolean

Returns True if a user has verified their email address.

inferred_regionstring

The Konnect region closest to the user's IP address. This property might only be set for users on signup through Konnect’s build-in native authentication.

created_atstring date-time

The time stamp for the date the account was registered.

updated_atstring date-time

A Unix timestamp representation of the most recent change to the User account.

Example response

{
  "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "email": "user@email.com",
  "full_name": "Test User",
  "preferred_name": "test",
  "active": true,
  "inferred_region": "us",
  "created_at": "2022-02-07T17:46:57.52Z",
  "updated_at": "2022-10-08T17:00:00.52Z"
}

Changes

  • 7aab863a6daaRevision changes
    • warning

      removed the optional property from the response with the status

  • 68d43091b84dRevision changes
    • warning

      added the new 401.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status