Skip to content

Send Password Email.

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

SendPasswordEmail enables resetting the password at the time of on-boarding new customer.

Examples of this operation.

Media typeapplication/json
Request to resend password email

SendPasswordEmailRequest is the request format for resetting the password at the time of on-boarding new customer.

object
cname
cname

Domain under which the tenant belongs to.

string
<= 1024 characters
email
email of the user

Email of the user requesting for Required: YES.

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

A successful response.

Media typeapplication/json
Send password email response

SendPasswordEmailResponse is an empty response after an email had been sent..

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