Resend a new API user's temporary password

POST /api_users/password

You can resend a newly invited user's password via this POST request

Body Required

Provided valid credentials, this route resends an email with temporary password for newly invited API user

  • email string(email) Required

    The email address of the API user

  • service string Required

    The Canopy UI userpool to which the API user belongs

    Values are BP or OS. Default value is OS.

Responses

  • 200 object

    API user successfully registered

    • status string Required

      Status of resend temp password email request.

      Value is success.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    User not found.

  • 429

    Too many requests.

  • Unexpected Error.

POST /api_users/password
curl \
 -X POST https://<your_environment_name>-uat-api.canopyservicing.com/api_users/password \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"email":"harriet@acmecorporation.com","service":"BP"}'
Request example
{
  "email": "harriet@acmecorporation.com",
  "service": "BP"
}
Response example (200)
{
  "status": "success"
}