USAD-03 Verify User Principal

Use Case: Verify User Principal

The ability to retrieve a BadgeOS Principal means we have a record of the email address.

Actors

  • Any Actor when logging in
  • Guide when verifying a Player

Pre-Conditions

  • None

Steps

  1. Provide email address
  2. Receive BadgeOS Principal object

Alternative Paths

  • Not Found Exception thrown if the Email address is not found.

Post-Conditions

BadgeOsPrincipal contains the following:

/**
 * Identifies a given user in the BadgeOS system including email address, Name and user ID within WordPress.
 */
@Immutable
public class BadgeOsPrincipal implements Principal {
    private Integer badgeOsUserId;
    private String name;
    private InternetAddress emailAddress;

References

ref1

uc
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License