Skip to content

Reset password by admin.

POST
/api/web/custom/password/admin_reset
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/custom/password/admin_reset \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "email": "hello@example.com" }'

Reset password by admin resets password for a user specified in request payload. This request is meant to be executed by the tenant’s admin.

Examples of this operation.

Media typeapplication/json
Reset password by admin request

Reset password by admin request contains email of user for which password will be reset.

object
email
Email

Email of user for which password will be reset. Required: YES.

string format: email
<= 1024 characters /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/
Examplegenerated
{
"email": "hello@example.com"
}

A successful response.

Media typeapplication/json
Empty

Empty is a message without actual content/body.

object
Examplegenerated
{}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example