GAganjoor
AppUser

update existing user (if you are trying to update an admin user you yourself should be admin) (if user does not have user:modify permission trying to modify other users' information fails with a forbidden error) (Auth)

Changed on
put/api/users/{id}

Request

  • Base URL
    https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Path parameters

idstring uuid required

user id

Request body

idstring uuid nullable

Id

usernamestring nullable

User Name

emailstring email nullable

User Email

phoneNumberstring tel nullable

User Mobile Phone Number

firstNamestring nullable

First Name

surNamestring nullable

SurName

status0 | 1 required

User Status

rImageIdstring uuid nullable

user image

nickNamestring nullable

nick name

biostring nullable

biography

websitestring nullable

web site

emailConfirmedboolean

email verified

phoneNumberConfirmedboolean
createDatestring date-time

create date

lockedOutboolean
lockoutEndstring date-time nullable
lockoutMessagestring nullable
passwordstring nullable

desired password, if sent empty system generates one

isAdminboolean

is admin

Example request

{
  "username": "test",
  "email": "email@domain.com",
  "phoneNumber": "+989121234567",
  "firstName": "Hamid Reza",
  "surName": "Mohammadi",
  "password": "Test!123"
}

Response

OK

boolean required

Changes

  • 493e82d8a523Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)