---
title: "Update a user"
method: PUT
path: "/api/v1/auth/users/{userEmail}"
tags: ["User Authorization"]
---

# Update a user

`PUT /api/v1/auth/users/{userEmail}`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/auth/users/{userEmail}`
- Auth: none declared

Update a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

## Path parameters

- `userEmail` string, required

## Request body

- AuthUser: Entity representing user in authentication system.
  - `authenticationId` string: Field which is stored as the authenticationId in metadata. Must be absent on POST. On PUT it must be absent, or equal to the value calculated by the backend (e.g. as returned from a previous GET).
  - `displayName` string, required: User description, which will be visible in application.
  - `email` string, email, required: Email - used as lookup (must be unique). For PUT method, it must be same as in URL
  - `password` string: User password. Write-only - accepted on POST and PUT, never returned in a response.

## Response `200`

OK

- AuthUser: Entity representing user in authentication system.
  - `authenticationId` string: Field which is stored as the authenticationId in metadata. Must be absent on POST. On PUT it must be absent, or equal to the value calculated by the backend (e.g. as returned from a previous GET).
  - `displayName` string, required: User description, which will be visible in application.
  - `email` string, email, required: Email - used as lookup (must be unique). For PUT method, it must be same as in URL
  - `password` string: User password. Write-only - accepted on POST and PUT, never returned in a response.

## Other responses

- `400`: The email in the payload does not match the one in the path, or the authenticationId does not match the one the backend calculates.
- `404`: No such user, or the caller has no FULL_CONTROL permission on the organization.

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)
