Jump to

• Request
• Response

Update a User

put

/api/v2/users/{id}/

Make a PUT or PATCH request to this resource to update this user. The following fields may be modified:

• username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)
• first_name: (string, default="")
• last_name: (string, default="")
• email: (string, default="")
• is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)
• is_system_auditor: (boolean, default=False)
• password: Write-only field used to change the password. (string, default="")

For a PUT request, include all fields in the request.

Request

Supported Media Types

• application/json

Path Parameters

• id: string

Query Parameters

• search(optional): string
  A search term.

Body ()

Root Schema : schema

Type: object

Show Source

• email(optional): string
• first_name(optional): string
• is_superuser(optional): boolean
  Designates that this user has all permissions without explicitly assigning them.
• is_system_auditor(optional): boolean
• last_name(optional): string
• password(optional): string
  Write-only field used to change the password.
• username: string
  Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

{
    "properties":{
        "email":{
            "description":"",
            "type":"string"
        },
        "first_name":{
            "description":"",
            "type":"string"
        },
        "is_superuser":{
            "description":"Designates that this user has all permissions without explicitly assigning them.",
            "type":"boolean"
        },
        "is_system_auditor":{
            "description":"",
            "type":"boolean"
        },
        "last_name":{
            "description":"",
            "type":"string"
        },
        "password":{
            "description":"Write-only field used to change the password.",
            "type":"string"
        },
        "username":{
            "description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "type":"string"
        }
    },
    "required":[
        "username"
    ],
    "type":"object"
}

Back to Top

Response

200 Response

Back to Top