Merge pull request #198 from pavinduLakshan/update_readme_id_token

Add note for users to find method to get additional user params
asgardeo · Aug 4, 2023 · 7c2f109 · 7c2f109
2 parents 41e1cc5 + f5f9284
commit 7c2f109
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/API.md b/API.md
@@ -403,6 +403,9 @@ You can add `disableAutoSignIn` as a config in the [Asgardeo SDK configuration](
 ### getBasicUserInfo
 This method returns a promise that resolves with the information about the authenticated user obtained from the id token as an object. To learn more what information this object contains, refer to the [`BasicUserInfo`](#basicuserinfo) section.
 
+> **Note**
+> Use [`getDecodedIDToken`](#getdecodedidtoken) method to get the additional user attributes that are not returned from the `getBasicUserInfo` method.
+
 ```TypeScript
 getBasicUserInfo(): Promise<BasicUserInfo>;
 ```