userManagement

Update user by ID

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

User + Update

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge></div> </Info>

Provided fields

  • username (String optional) - has to be user's email
  • name (String optional)
  • status (Object optional)
  • organisation (Object optional) - must be the current organisation or not to be provided

Notes

  • Password is not provided. Separate calls provide password management.
  • The organisation is not modifiable. A user can be updated, if belonging to the same organisation as the requesting user, or to an organisation which is a direct child of the requesting user's organisation.
  • Status can be changed between ACTIVE (id: 1) and SUSPENDED (id: 2), and from ACTIVATION_PENDING (id: 0) to SUSPENDED.
<Info> Modifying the username invalidates account and triggers the activation procedure. </Info>
patch/api/v1/user/{user_id}

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/user/{user_id}
  • Auth: HTTP bearer

Path parameters

user_idnumber double required

User ID

Request body

usernamestring required
namestring required
statusApiV1UserUserIdPatchRequestBodyContentApplicationJsonSchemaStatus required

Response

The server has successfully fulfilled the request and that there is no additional content to send in the response payload body

object required

Changes

No recorded changes to this operation across all 1 revision of this API.