verifyUserEmail

Summary

Email address verification process.

For use in a test or QE environment, this endpoint verifies the email address for the specified user. It simulates the logic of email verification by the user via a signature token, without actually sending the email to the user.

In a production system, a verification email is sent:

Automatically to the user via the CloudBees Software Delivery Automation server when an alternative email is created or modified.
Using a special verify action in the CloudBees CI licenses for unverified CloudBees CI users.

email

Stringrequired

The email address for verification.

signature

Stringoptional

Signature for verification email address.

Usage

Perl

$cmdr->verifyUserEmail(
  "test-email" # email
  # optionals
);▼

ectool

ectool verifyUserEmail \
  "test-email" `# email` \
  # optionals▼

Examples

ectool

Consider this user/email mapping for an alternative, unverified user email for test@example.com:

<userEmail>
      <userEmailId>108a7873-db0d-11eb-a114-080027053628</userEmailId>
      <createTime>2021-07-02T08:11:12.348Z</createTime>
      <email>test@example.com</email>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2021-07-02T08:11:12.348Z</modifyTime>
      <owner>admin</owner>
      <status>UNVERIFIED</status>
      <userName>admin</userName>
</userEmail>▼

Verification request for the particular email is sent to the CloudBees Software Delivery Automation server. The server simulates the user verification by returning a signature. This phase:
- Sends an email request to verify the user’s email with the specified address.
- Returns a signature for specified email address.
  
  This phase does not require that the user email address already exist in the CloudBees Software Delivery Automation system as a user email entity. Even if this user email already exists, this phase does not require that it be owned by the currently signed in CloudBees Software Delivery Automation user. For example, the CloudBees Software Delivery Automation admin user may request verification for user mail that belongs to another CloudBees Software Delivery Automation user.
  
  Request:
  ectool verifyUserEmail test@example.com
  ▼
  Response:
  <response requestId="1" nodeId="192.168.178.41"> <signature> Z0V6ODR1eHBTTGVXMGFCK3NXUEFOQ0h\ VNU9ZS21qLzBZVmgveksxOXlWST0= </signature> </response>
  ▼

Request the verified userEmail object using the signature returned by the CloudBees Software Delivery Automation server from the initial request. This phase:

Changes the status of the currently existing user email address belonging to the current user to VERIFIED.

Creates a new user email address for the current user immediately with the status VERIFIED.

Request:

ectool verifyUserEmail test@mail.com \
       --signature Z0V6ODR1eHBTTGVXMGFCK3NXUEFOQ0hVNU9ZS21qLzBZVmgveksxOXlWST0=▼

Response:

<response requestId="1" nodeId="192.168.178.41">
    <userEmail>
      <userEmailId>108a7873-db0d-11eb-a114-080027053628</userEmailId>
      <createTime>2021-07-02T08:11:12.348Z</createTime>
      <email>test@example.com</email>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2021-07-02T08:12:04.288Z</modifyTime>
      <owner>admin</owner>
      <status>VERIFIED</status>
      <userName>admin</userName>
    </userEmail>
  </response>▼

Note that this response confirms the email has been verified.