Trigger Lambda di pre-registrazione

Poco prima della registrazione di un nuovo utente in Amazon Cognito, viene attivata la funzione di pre-registrazione AWS Lambda. Puoi utilizzare questa funzione nell'ambito del processo di registrazione per eseguire una convalida personalizzata e, in base ai risultati della convalida, accettare o rifiutare la richiesta di registrazione.

Flussi Lambda di pre-registrazione

Flusso di registrazione client

Flusso di registrazione server

La richiesta include i dati di convalida dal client. Questi dati provengono dai ValidationData valori passati al pool di utenti SignUp e ai metodi AdminCreateUser API.

Parametri del trigger Lambda di pre-registrazione

La richiesta passata da Amazon Cognito a questa funzione Lambda è una combinazione dei parametri seguenti e dei parametri comuni aggiunti da Amazon Cognito a tutte le richieste.

JSON

{
    "request": {
        "userAttributes": {
            "string": "string",
            . . .
        },
        "validationData": {
            "string": "string",
            . . .
         },
        "clientMetadata": {
            "string": "string",
            . . .
         }
    },

    "response": {
        "autoConfirmUser": "boolean",
        "autoVerifyPhone": "boolean",
        "autoVerifyEmail": "boolean"
    }
}

Parametri di richiesta di pre registrazione

userAttributes

Una o più coppie nome-valore che rappresentano gli attributi utente. I nomi di attributo sono le chiavi.

validationData

Una o più coppie chiave-valore con i dati degli attributi utente che la tua app ha passato ad Amazon Cognito nella richiesta di creazione di un nuovo utente. Invia queste informazioni alla tua funzione Lambda nel ValidationData parametro della tua richiesta AdminCreateUsero SignUpAPI.

Amazon Cognito non imposta ValidationData i tuoi dati come attributi dell'utente che crei. ValidationData sono informazioni temporanee sull'utente fornite ai fini del trigger Lambda prima della registrazione.

clientMetadata

Una o più coppie chiave-valore che è possibile fornire come input personalizzato alla funzione Lambda specificata per il trigger di pre-registrazione. Puoi passare questi dati alla tua funzione Lambda utilizzando il ClientMetadata parametro nelle seguenti azioni API: AdminCreateUser, AdminRespondToAuthChallengeForgotPassword, e. SignUp

Parametri di risposta di pre-registrazione

Nella risposta, puoi impostare autoConfirmUser su true se desideri auto confermare l'utente. Puoi impostare autoVerifyEmail su true per auto verificare l'e-mail dell'utente. Puoi impostare autoVerifyPhone su true per auto verificare il numero di telefono dell'utente.

Nota

I parametri di risposta autoVerifyPhone, autoVerifyEmail e autoConfirmUser vengono ignorati da Amazon Cognito quando la funzione Lambda di pre-registrazione viene attivata dall'API AdminCreateUser.

autoConfirmUser

Impostare su true per auto confermare l'utente o altrimenti su false.

autoVerifyEmail

Imposta su true per definire come verificato il messaggio e-mail di un utente che sta effettuando la registrazione o altrimenti su false. Se autoVerifyEmail è impostato su true, l'attributo della email deve avere un valore valido e non nullo. In caso contrario, si verificherà un errore e l'utente non sarà in grado di completare la registrazione.

Se l'attributo email è selezionato come alias, viene creato un alias per l'indirizzo e-mail dell'utente quando è impostato autoVerifyEmail. Se esiste già un alias con quell'indirizzo e-mail, l'alias verrà spostato al nuovo utente e l'indirizzo e-mail dell'utente precedente verrà contrassegnato come non verificato. Per ulteriori informazioni, consulta Personalizzazione degli attributi di accesso.

autoVerifyPhone

Imposta su true per impostare come verificato il numero di telefono di un utente che sta effettuando la registrazione o altrimenti su false. Se autoVerifyPhone è impostato su true, l'attributo della phone_number deve avere un valore valido e non nullo. In caso contrario, si verificherà un errore e l'utente non sarà in grado di completare la registrazione.

Se l'attributo del phone_number è selezionato come un alias, un alias verrà creato per il numero di telefono dell'utente quando autoVerifyPhone è impostato. Se esiste già un alias con quel numero di telefono, l'alias verrà spostato al nuovo utente e il numero di telefono dell'utente precedente verrà contrassegnato come non verificato. Per ulteriori informazioni, consulta Personalizzazione degli attributi di accesso.

Tutorial sulla registrazione

La funzione Lambda di pre-registrazione viene attivata prima della registrazione dell'utente. Guarda questi tutorial di iscrizione ad Amazon Cognito per JavaScript Android e iOS.

Piattaforma	Tutorial
JavaScript SDK per le identità	Registra gli utenti con JavaScript
SDK di identità per Android	Registrazione degli utenti con Android
SDK di identità per iOS	Registrazione degli utenti con iOS

Esempio di pre-registrazione: conferma automatica degli utenti di un dominio registrato

Puoi utilizzare il trigger Lambda di pre-registrazione per aggiungere una logica personalizzata che convalida i nuovi utenti che si registrano al tuo bacino d'utenza. Questo è un JavaScript programma di esempio che mostra come registrare un nuovo utente. Richiama un trigger Lambda di pre-registrazione nell'ambito del processo di autenticazione.

JavaScript

var attributeList = [];
var dataEmail = {
  Name: "email",
  Value: "...", // your email here
};
var dataPhoneNumber = {
  Name: "phone_number",
  Value: "...", // your phone number here with +country code and no delimiters in front
};

var dataEmailDomain = {
  Name: "custom:domain",
  Value: "example.com",
};
var attributeEmail = new AmazonCognitoIdentity.CognitoUserAttribute(dataEmail);
var attributePhoneNumber = new AmazonCognitoIdentity.CognitoUserAttribute(
  dataPhoneNumber
);
var attributeEmailDomain = new AmazonCognitoIdentity.CognitoUserAttribute(
  dataEmailDomain
);

attributeList.push(attributeEmail);
attributeList.push(attributePhoneNumber);
attributeList.push(attributeEmailDomain);

var cognitoUser;
userPool.signUp(
  "username",
  "password",
  attributeList,
  null,
  function (err, result) {
    if (err) {
      alert(err);
      return;
    }
    cognitoUser = result.user;
    console.log("user name is " + cognitoUser.getUsername());
  }
);

Questo è un trigger Lambda di esempio richiamato appena prima della registrazione con il trigger Lambda di pre-registrazione del bacino d'utenza. Utilizza un attributo personalizzato custom:domain per confermare automaticamente i nuovi utenti di un determinato dominio e-mail. Tutti i nuovi utenti che non fanno parte del dominio personalizzato verranno aggiunti al bacino d'utenza, ma non saranno confermati automaticamente.

Node.js

exports.handler = (event, context, callback) => {
  // Set the user pool autoConfirmUser flag after validating the email domain
  event.response.autoConfirmUser = false;

  // Split the email address so we can compare domains
  var address = event.request.userAttributes.email.split("@");

  // This example uses a custom attribute "custom:domain"
  if (event.request.userAttributes.hasOwnProperty("custom:domain")) {
    if (event.request.userAttributes["custom:domain"] === address[1]) {
      event.response.autoConfirmUser = true;
    }
  }

  // Return to Amazon Cognito
  callback(null, event);
};

Python

def lambda_handler(event, context):
    # It sets the user pool autoConfirmUser flag after validating the email domain
    event['response']['autoConfirmUser'] = False

    # Split the email address so we can compare domains
    address = event['request']['userAttributes']['email'].split('@')

    # This example uses a custom attribute 'custom:domain'
    if 'custom:domain' in event['request']['userAttributes']:
        if event['request']['userAttributes']['custom:domain'] == address[1]:
            event['response']['autoConfirmUser'] = True

    # Return to Amazon Cognito
    return event

Amazon Cognito trasferisce informazioni sugli eventi alla funzione Lambda. La funzione quindi restituisce a Amazon Cognito lo stesso oggetto evento con eventuali modifiche nella risposta. Nella console Lambda puoi configurare un evento di test con i dati pertinenti al trigger Lambda. Di seguito è riportato un evento di test per questo esempio di codice:

JSON

{
    "request": {
        "userAttributes": {
            "email": "[e-mail]",
            "custom:domain": "example.com"
        }
    },
    "response": {}
}

Esempio di pre-registrazione: conferma e verifica automatica di tutti gli utenti

Questo esempio conferma tutti gli utenti e imposta lo stato di avvenuta verifica per gli attributi email e phone_number dell'utente se presenti. Inoltre, se l'aliasing è abilitato, saranno creati gli alias per phone_number e email nei casi in cui è impostata la verifica automatica.

Nota

Se esiste già un alias con lo stesso numero di telefono, l'alias verrà spostato al nuovo utente e il phone_number dell'utente precedente verrà contrassegnato come non verificato. Lo stesso vale per gli indirizzi e-mail. Per evitare che ciò accada, puoi utilizzare l'ListUsers API dei pool di utenti per vedere se esiste un utente esistente che sta già utilizzando il numero di telefono o l'indirizzo e-mail del nuovo utente come alias.

Node.js

const handler = async (event) => {
  // Confirm the user
  event.response.autoConfirmUser = true;
  // Set the email as verified if it is in the request
  if (event.request.userAttributes.hasOwnProperty("email")) {
    event.response.autoVerifyEmail = true;
  }

  // Set the phone number as verified if it is in the request
  if (event.request.userAttributes.hasOwnProperty("phone_number")) {
    event.response.autoVerifyPhone = true;
  }

  return event;
};

export { handler };

Python

def lambda_handler(event, context):
    # Confirm the user
    event['response']['autoConfirmUser'] = True

    # Set the email as verified if it is in the request
    if 'email' in event['request']['userAttributes']:
        event['response']['autoVerifyEmail'] = True

    # Set the phone number as verified if it is in the request
    if 'phone_number' in event['request']['userAttributes']:
        event['response']['autoVerifyPhone'] = True

    # Return to Amazon Cognito
    return event

Amazon Cognito trasferisce informazioni sugli eventi alla funzione Lambda. La funzione quindi restituisce a Amazon Cognito lo stesso oggetto evento con eventuali modifiche nella risposta. Nella console Lambda puoi configurare un evento di test con i dati pertinenti al trigger Lambda. Di seguito è riportato un evento di test per questo esempio di codice:

JSON

{
  "request": {
    "userAttributes": {
      "email": "[e-mail]",
      "phone_number": "[phone]"
    }
  },
  "response": {}
}

Esempio di pre-registrazione: registrazione rifiutata se il nome utente ha meno di cinque caratteri

Questo esempio verifica la lunghezza del nome utente in una richiesta di registrazione. L'esempio restituisce un errore se l'utente immette un nome con meno di cinque caratteri.

Node.js

exports.handler = (event, context, callback) => {
    // Impose a condition that the minimum length of the username is 5 is imposed on all user pools.
    if (event.userName.length < 5) {
        var error = new Error("Cannot register users with username less than the minimum length of 5");
        // Return error to Amazon Cognito
        callback(error, event);
    }
    // Return to Amazon Cognito
    callback(null, event);
};

Python

def lambda_handler(event, context):
    if len(event['userName']) < 5:
        raise Exception("Cannot register users with username less than the minimum length of 5")
    # Return to Amazon Cognito
    return event

Amazon Cognito trasferisce informazioni sugli eventi alla funzione Lambda. La funzione quindi restituisce a Amazon Cognito lo stesso oggetto evento con eventuali modifiche nella risposta. Nella console Lambda puoi configurare un evento di test con i dati pertinenti al trigger Lambda. Di seguito è riportato un evento di test per questo esempio di codice:

JSON

{
  "userName": "rroe",
  "response": {}
}