# Modify user
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/be/v1/users:
patch:
summary: Modify user
deprecated: false
description: >-
This endpoint allows to modify a user in your ROCKIT Edge Organization.
You can modify the following fields:
- `firstname`
- `surname`
- `title`
You can also change the password of your own user, by providing the old
password and a new password.
- `oldPW`
- `newPW`
A user with full resource `user` permission, can reset the API keys of
machine users by just setting a new one with:
- `resetApiKey`
### Required Permissions
`users.update` or being the user itself.
See [Roles](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md)
for more details.
tags:
- ROCKIT Edge - Backend API/Account Management
parameters:
- name: Authorization
in: header
description: >-
Use the access token obtained from [`POST
/be/v1/login`](https://edge.api.cloud.rockitplay.com/user-login-org-11611254e0.md)
or [`POST
/be/v1/refresh`](https://edge.api.cloud.rockitplay.com/refresh-11630082e0.md)
as Bearer token.
Mutually excluded with `x-rockit-api-key`.
required: false
example: Bearer {{_edge_org_admin_access_token}}
schema:
type: string
- name: x-rockit-tenant
in: header
description: >
Unique and immutable tenancy identifier obtained from the ROCKIT
Edge administrator.
Requires `x-rockit-username`,
`x-rockit-orgname` and `x-rockit-api-key`.
required: false
example: '{{EDGE_TENANT_NAME}}'
schema:
type: string
- name: x-rockit-orgname
in: header
description: >
Unique and immutable organization identifier obtained from the
ROCKIT Edge administrator.
Requires `x-rockit-tenant`,
`x-rockit-username` and `x-rockit-api-key`.
required: false
example: '{{EDGE_ORG_NAME}}'
schema:
type: string
- name: x-rockit-username
in: header
description: >
Unique and immutable username which is associated with the apikey.
Requires `x-rockit-tenant`, `x-rockit-orgname` and
`x-rockit-api-key`.
required: false
example: adminPrincipal
schema:
type: string
- name: x-rockit-api-key
in: header
description: >-
Unique and immutable apikey which is associated with an machine
user.
Mutually excluded with `Authorization` header. Requires
`x-rockit-tenant`, `x-rockit-username` and `x-rockit-orgname`.
required: false
example: '{{_adminPrincipal_apiKey}}'
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: Required to identify the user whose data should be updated.
title:
type: string
description: Optional title for the user (e.g., "Mr", "Dr", etc.).
firstname:
type: string
description: First name of the user.
surname:
type: string
description: Last name of the user.
oldPW:
type: string
description: >-
Required if newPW is provided and the requester does not
have write permissions on users. Used to verify identity
before changing password.
newPW:
type: string
description: >-
New password to set. Requires oldPW unless requester has
write permissions on users. The new password needs to be in
this format:
/^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[#?!@$%^&*-]).{8,}$/\
resetApiKey:
type: boolean
description: >-
Reset the API key of a machine user. Responds with a new
generated API key. Requires user.update permission.
roles:
type: string
description: >-
Array of _Roles_ which the machine account should be
associated with.
required:
- username
x-apidog-orders:
- username
- title
- firstname
- surname
- oldPW
- newPW
- resetApiKey
- roles
x-apidog-ignore-properties: []
example:
username: exampleName
title: newtitle
firstname: newFirstname
surname: newSurname
email: newEmail
oldPW: oldPassword
newPW: newPassword
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties: {}
x-apidog-orders: []
x-apidog-ignore-properties: []
headers: {}
x-apidog-name: Success
'400':
description: ''
content:
application/json:
schema:
title: ''
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more
invalid or missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example,
"name invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected
pattern for the organization name)
x-apidog-orders:
- 01JQNGHEBK1SCF01CBDM38H7PG
required:
- status
- error
- message
- detail
x-apidog-refs:
01JQNGHEBK1SCF01CBDM38H7PG:
$ref: '#/components/schemas/Invalid%20Param'
x-apidog-ignore-properties:
- status
- error
- message
- detail
headers: {}
x-apidog-name: Invalid Param
'401':
description: ''
content:
application/json:
schema:
title: ''
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was
rejected because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose
the failure.
x-apidog-orders:
- 01JQNGGJY0928MYXCSMBFT3NSF
required:
- status
- error
- message
x-apidog-refs:
01JQNGGJY0928MYXCSMBFT3NSF:
$ref: '#/components/schemas/unauthorized'
x-apidog-ignore-properties:
- status
- error
- message
headers: {}
x-apidog-name: Unauthorized
security: []
x-apidog-folder: ROCKIT Edge - Backend API/Account Management
x-apidog-status: developing
x-run-in-apidog: https://app.apidog.com/web/project/732774/apis/api-15071473-run
components:
schemas:
unauthorized:
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was rejected
because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose the
failure.
required:
- status
- error
- message
x-apidog-orders:
- status
- error
- message
x-apidog-ignore-properties: []
x-apidog-folder: ''
Invalid Param:
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more invalid or
missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example, "name
invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected pattern for the
organization name)
required:
- status
- error
- message
- detail
x-apidog-orders:
- status
- error
- message
- detail
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
Bearer token:
type: bearer
scheme: bearer
description: >-
Enter your Access Token. You can obtain this by calling the /be/v1/login
endpoint. Use the Refresh token to get a new Access token when it
expires.
servers:
- url: https://Example-Server.com
description: Default
security: []
```