Skip to main content

Create password for user

The endpoint provides functionality for creating password of an already existing user.

The required values are the userExtId retrieved upon user creation, and the instanceId of the customer.

For authorization, a JWT is required.

HTTP request

POST https://${instanceId}.id.nevis.cloud/nevis/api/v1/users/${userExtId}/password

Parameters

ParameterInDescription
instanceId UUIDpathRequired The ID of the customer instance
userExtId UUIDpathRequired The ID of the given user

Request body

The password can be created by providing its value only.

Parameters

ParameterInDescription
password StringbodyRequired The password of the user
stateName EnumbodyOptional The state of the password
Default: active
Values: active,initial, tmp-locked, disabled, archived

Example

{
"password": "Y6wV-8M<=38nQk`b",
"stateName": "active"
}

HTTP response

On success

HTTP/1.1 201 is returned if the password is successfully created.

The response contains the following additional header, containing the userExtId of the user:

https://${instanceId}.id.nevis.cloud/nevis/api/v1/users/${extId}/password

On failure

HTTP/1.1 401 is returned if the authorization failed due to an invalid JWT.

HTTP/1.1 422 is returned if invalid request content was given.

HTTP/1.1 500 is returned if an unexpected error occurred.