Manage Email/Password Users - Swift SDK

Resend a User Confirmation Email

Resend a confirmation email. The confirmation tokens in each URL expire after 30 minutes. If a user does not follow the link and confirm within that period, they must request a new confirmation email.

let app = App(id: YOUR_APP_SERVICES_APP_ID)
let client = app.emailPasswordAuth
let email = "skroob@example.com"
// If Realm is set to send a confirmation email, we can
// send the confirmation email again here.
do {
    try await client.resendConfirmationEmail(email)
    // The confirmation email has been sent
    // to the user again.
    print("Confirmation email resent")
} catch {
    print("Failed to resend confirmation email: \(error.localizedDescription)")
}

Retry a User Confirmation Function

Retry a custom user confirmation function.

let app = App(id: YOUR_APP_SERVICES_APP_ID)
let client = app.emailPasswordAuth
let email = "skroob@example.com"
// If Realm is set to run a custom confirmation function,
// we can trigger that function to run again here.
do {
    try await client.retryCustomConfirmation(email)
    // The custom confirmation function has been
    // triggered to run again for the user.
    print("Custom confirmation retriggered")
} catch {
    print("Failed to retry custom confirmation: \(error.localizedDescription)")
}

Send a Password Reset Email

To send password reset emails to confirm the user's identity, you must configure your App to send a password reset email.

To begin the password reset process, call sendResetPasswordEmail with the user's email. App Services sends an email to the user that contains a unique URL. The user must visit this URL within 30 minutes to confirm the reset.

After the user has visited the URL from the password reset email, call resetPassword with the user's email, the new password, and the token and tokenId provided in the unique URL.

If the user does not visit the URL from the password reset email within 30 minutes, the token and tokenId expire. You must begin the password reset process again.

RLMApp *app = [RLMApp appWithId:YOUR_APP_ID];
RLMEmailPasswordAuth *client = [app emailPasswordAuth];
// If Realm app password reset mode is "Send a password reset email",
// we can do so here:
NSString *email = @"forgot.my.password@example.com";
[client sendResetPasswordEmail:email completion:^(NSError *error) {
   if (error != nil) {
       NSLog(@"Failed to send reset password email: %@", [error localizedDescription]);
       return;
   }
   // Email sent.
   NSLog(@"Successfully sent reset password email.");
}];
// Later...
NSString *newPassword = @"mynewpassword12345";
// Token and tokenId are query parameters in the confirmation
// link sent in the reset password email.
NSString *token = @"someToken";
NSString *tokenId = @"someTokenId";
[client resetPasswordTo:newPassword token:token tokenId:tokenId completion:^(NSError *error) {
    if (error != nil) {
        NSLog(@"Failed to reset password: %@", [error localizedDescription]);
        return;
    }
    // Password reset.
    NSLog(@"Successfully reset password.");
}];

let app = App(id: YOUR_APP_SERVICES_APP_ID)
let client = app.emailPasswordAuth
let email = "forgot.my.password@example.com"
// If Realm app password reset mode is "Send a password reset email",
// we can do so here:
do {
    try await client.sendResetPasswordEmail(email)
    print("Password reset email sent.")
} catch {
    print("Reset password email not sent: \(error.localizedDescription)")
}
// Later...
let newPassword = "mynewpassword12345"
// Token and tokenId are query parameters in the reset password
// link sent in the reset password email.
let token = "someToken"
let tokenId = "someTokenId"
do {
    try await client.resetPassword(to: newPassword, token: token, tokenId: tokenId)
    print("Password reset successful.")
} catch {
    print("Failed to reset password: \(error.localizedDescription)")
}

Run a Password Reset Function

When you configure your app to run a password reset function, you define the function that should run when you call callResetPasswordFunction() from the SDK. This function can take a username, a password, and any number of additional arguments. You can use these arguments to specify details like security question answers or other challenges that the user should pass to successfully complete a password reset.

You might prefer to use a custom password reset function when you want to define your own password reset flows. For example, you might send a custom password reset email from a specific domain. Or you might use a service other than email to confirm the user's identity.

On the App Services side, you define the custom password reset function that runs when you call this method. That function can return one of three possible statuses:

• fail

• pending

• success

A fail status is treated as an error by the SDK. The SDK callResetPasswordFunction() does not take return values, so it does not return a pending or success status to the client.

let app = App(id: YOUR_APP_SERVICES_APP_ID)
let client = app.emailPasswordAuth
let email = "forgot.my.password@example.com"
let newPassword = "mynewpassword12345"
// The password reset function takes any number of
// arguments.
let args: [AnyBSON] = []
// This SDK call maps to the custom password reset
// function that you define in the backend. In this example,
// we assume your function waits for additional identity
// confirmation. Calling this function only kicks
// off the password reset function. It does not reset the password.
do {
    try await client.callResetPasswordFunction(email: email, password: newPassword, args: args)
    print("Successfully called the password reset function")
} catch {
    print("Password reset failed: \(error.localizedDescription)")
}
// Later...
// Token and tokenId are parameters you can access
// in the App Services function context. You could send
// this to the user via email, SMS, or some other method.
let token = "someToken"
let tokenId = "someTokenId"
do {
    try await client.resetPassword(to: newPassword, token: token, tokenId: tokenId)
    print("Password reset successful.")
} catch {
    print("Failed to reset password: \(error.localizedDescription)")
}

let app = App(id: YOUR_APP_SERVICES_APP_ID)
let client = app.emailPasswordAuth
let email = "forgot.my.password@example.com"
let newPassword = "mynewpassword12345"
// The password reset function takes any number of
// arguments. You might ask the user to provide answers to
// security questions, for example, to verify the user
// should be able to complete the password reset.
let args: [AnyBSON] = []
// This SDK call maps to the custom password reset
// function that you define in the backend
do {
    try await client.callResetPasswordFunction(email: email, password: newPassword, args: args)
    print("Password reset successful!")
} catch {
    print("Password reset failed: \(error.localizedDescription)")
}