Class UserCreateParameters


  • public final class UserCreateParameters
    extends Object
    User create details.
    • Constructor Detail

      • UserCreateParameters

        public UserCreateParameters()
    • Method Detail

      • email

        public String email()
        Get the email property: Email address. Must not be empty and must be unique within the service instance.
        Returns:
        the email value.
      • withEmail

        public UserCreateParameters withEmail​(String email)
        Set the email property: Email address. Must not be empty and must be unique within the service instance.
        Parameters:
        email - the email value to set.
        Returns:
        the UserCreateParameters object itself.
      • firstName

        public String firstName()
        Get the firstName property: First name.
        Returns:
        the firstName value.
      • withFirstName

        public UserCreateParameters withFirstName​(String firstName)
        Set the firstName property: First name.
        Parameters:
        firstName - the firstName value to set.
        Returns:
        the UserCreateParameters object itself.
      • lastName

        public String lastName()
        Get the lastName property: Last name.
        Returns:
        the lastName value.
      • withLastName

        public UserCreateParameters withLastName​(String lastName)
        Set the lastName property: Last name.
        Parameters:
        lastName - the lastName value to set.
        Returns:
        the UserCreateParameters object itself.
      • password

        public String password()
        Get the password property: User Password. If no value is provided, a default password is generated.
        Returns:
        the password value.
      • withPassword

        public UserCreateParameters withPassword​(String password)
        Set the password property: User Password. If no value is provided, a default password is generated.
        Parameters:
        password - the password value to set.
        Returns:
        the UserCreateParameters object itself.
      • appType

        public AppType appType()
        Get the appType property: Determines the type of application which send the create user request. Default is legacy portal.
        Returns:
        the appType value.
      • withAppType

        public UserCreateParameters withAppType​(AppType appType)
        Set the appType property: Determines the type of application which send the create user request. Default is legacy portal.
        Parameters:
        appType - the appType value to set.
        Returns:
        the UserCreateParameters object itself.
      • confirmation

        public Confirmation confirmation()
        Get the confirmation property: Determines the type of confirmation e-mail that will be sent to the newly created user.
        Returns:
        the confirmation value.
      • withConfirmation

        public UserCreateParameters withConfirmation​(Confirmation confirmation)
        Set the confirmation property: Determines the type of confirmation e-mail that will be sent to the newly created user.
        Parameters:
        confirmation - the confirmation value to set.
        Returns:
        the UserCreateParameters object itself.
      • state

        public UserState state()
        Get the state property: Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
        Returns:
        the state value.
      • withState

        public UserCreateParameters withState​(UserState state)
        Set the state property: Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
        Parameters:
        state - the state value to set.
        Returns:
        the UserCreateParameters object itself.
      • note

        public String note()
        Get the note property: Optional note about a user set by the administrator.
        Returns:
        the note value.
      • withNote

        public UserCreateParameters withNote​(String note)
        Set the note property: Optional note about a user set by the administrator.
        Parameters:
        note - the note value to set.
        Returns:
        the UserCreateParameters object itself.
      • identities

        public List<UserIdentityContractInner> identities()
        Get the identities property: Collection of user identities.
        Returns:
        the identities value.
      • withIdentities

        public UserCreateParameters withIdentities​(List<UserIdentityContractInner> identities)
        Set the identities property: Collection of user identities.
        Parameters:
        identities - the identities value to set.
        Returns:
        the UserCreateParameters object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.