Class ModifyUserRequest

    • Method Detail

      • userId

        public final String userId()

        The ID of the user.

        Returns:
        The ID of the user.
      • accessString

        public final String accessString()

        Access permissions string used for this user.

        Returns:
        Access permissions string used for this user.
      • appendAccessString

        public final String appendAccessString()

        Adds additional user permissions to the access string.

        Returns:
        Adds additional user permissions to the access string.
      • hasPasswords

        public final boolean hasPasswords()
        For responses, this returns true if the service returned a value for the Passwords property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • passwords

        public final List<String> passwords()

        The passwords belonging to the user. You are allowed up to two.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPasswords() method.

        Returns:
        The passwords belonging to the user. You are allowed up to two.
      • noPasswordRequired

        public final Boolean noPasswordRequired()

        Indicates no password is required for the user.

        Returns:
        Indicates no password is required for the user.
      • authenticationMode

        public final AuthenticationMode authenticationMode()

        Specifies how to authenticate the user.

        Returns:
        Specifies how to authenticate the user.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object