Document Client Metadata for Auth APIs

[miguelflores1993]

I want to send parameters or custom data apart from what the function asks me for.

Amplify.Auth.signIn

[Jordan-Nelson]

Hello @miguelflores1993 - Assuming you are using Cognitio, you can use CognitoSignUpOptions in place of SignUpOptions. CognitoSignUpOptions allows you to pass in Cognito User Attributes (email, phone, name, address, etc.) and any arbitrary client metadata that you would like to include. The client metadata will be available in lambda triggers (post auth trigger in this case).

await Amplify.Auth.signUp(
  username: username,
  password: password,
  options: CognitoSignUpOptions(
    // these values will be saved in Cognitio and associated with the user
    userAttributes: {
      CognitoUserAttributeKey.email: email,
      CognitoUserAttributeKey.name: 'name'
    },
    // available in post auth lambda triggers
    clientMetadata: {
      'foo': 'bar',
    },
  ),
);

[Jordan-Nelson]

The docs have an example with user attributes under Register a User. Client metadata isn't mentioned in the amplify-flutter docs. I am going to label this as a docs issue as well.

[dorontal]

@Jordan-Nelson I tried to use userAttributes: { .. } as in the above code snippet but found no definition for CognitoUserAttributeKey.email - but I did find that CognitoUserAttributes.email works instead -CognitoUserAttributes is the correct one to use in the above code snippet, right?

[Jordan-Nelson]

@dorontal - Yes that should be correct. The API was updated in (I think) v0.3.0. If you are using 0.2.10 or earlier I believe CognitoUserAttributes.email is correct.

@miguelflores1993 - Let me know if that answered your question, and I can update this issue to just track it as a documentation gap.

[Jordan-Nelson]

Marking as a documentation issue. We should add the client meta data option to https://github.com/aws-amplify/docs