cidaas-javascript-sdk 4.2.4 → 4.3.1

package/dist/token-service/TokenService.model.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupAllowed = exports.TokenTypeHint = exports.TokenIntrospectionRequest = exports.GrantType = void 0;
+/** Type of grant used in token request */
+var GrantType;
+(function (GrantType) {
+    GrantType["AuthorizationCode"] = "authorization_code";
+    GrantType["Implicit"] = "implicit";
+    GrantType["RefreshToken"] = "refresh_token";
+    GrantType["Password"] = "password";
+    GrantType["ClientCredentials"] = "client_credentials";
+    GrantType["Internal"] = "internal";
+    GrantType["DeviceCode"] = "urn:ietf:params:oauth:grant-type:device_code";
+})(GrantType = exports.GrantType || (exports.GrantType = {}));
+class TokenIntrospectionRequest {
+    constructor() {
+        /** If true, all roles have to be included. If false, only 1 role from the list is needed */
+        this.strictRoleValidation = false;
+        /** If true, all group have to be included. If false, only 1 group from the list is needed */
+        this.strictGroupValidation = false;
+        /** If true, all scopes have to be included. If false, only 1 scope from the list is needed */
+        this.strictScopeValidation = false;
+        /** If true, all defined roles and/or groups and/or scopes validation has to be succesful. If false, only 1 of them is needed */
+        this.strictValidation = false;
+    }
+}
+exports.TokenIntrospectionRequest = TokenIntrospectionRequest;
+/** Optional hint about the type of the submitted token. */
+var TokenTypeHint;
+(function (TokenTypeHint) {
+    TokenTypeHint["AccessToken"] = "access_token";
+    TokenTypeHint["RefreshToken"] = "refresh_token";
+    TokenTypeHint["IdToken"] = "id_token";
+    TokenTypeHint["Sid"] = "sid";
+    TokenTypeHint["Sso"] = "sso";
+})(TokenTypeHint = exports.TokenTypeHint || (exports.TokenTypeHint = {}));
+class GroupAllowed {
+    constructor() {
+        /** If true, all roles have to be included. If false, only 1 role from the list is needed */
+        this.strictRoleValidation = false;
+    }
+}
+exports.GroupAllowed = GroupAllowed;

package/dist/user-service/UserService.d.ts

@@ -0,0 +1,317 @@
+import { ChangePasswordRequest, DeduplicationLoginRequest, DeleteUserAccountRequest, GetDeduplicationDetailsRequest, GetInviteUserDetailsRequest, GetUserProfileRequest, HandleResetPasswordRequest, InitiateLinkAccountRequest, InitiateResetPasswordRequest, RegisterDeduplicationRequest, RegisterRequest, ResetPasswordRequest, UserCheckExistsRequest, CompleteLinkAccountRequest, getCommunicationStatusRequest } from "./UserService.model";
+import { HTTPRequestHeader } from "../common/Common.model";
+import { CidaasUser } from "../common/User.model";
+/**
+ * To get the user profile information by using cidaas internal api, call **getUserProfile()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/2zfvjx3vtq6g6-get-user-info for more details.
+ * @example
+ * ```js
+ * const options = {
+ *   access_token: 'your access token'
+ * }
+ * cidaas.getUserProfile(options)
+ * .then(function () {
+ *   // the response will give you user profile information.
+ * }).catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function getUserProfile(options: GetUserProfileRequest): Promise<any>;
+/**
+ * To register user, call **register()**. This method will create a new user.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/427632e587203-register-a-new-user for more details.
+ * Note: Only requestId in the headers is required.
+ * @example
+ * ```js
+ * const headers = {
+ *   requestId: 'your_received_requestId',
+ *   captcha: 'captcha',
+ *   acceptlanguage: 'acceptlanguage',
+ *   bot_captcha_response: 'bot_captcha_response'
+ * };
+ *
+ * cidaas.register({
+ *   email: 'xxx123@xxx.com',
+ *   given_name: 'xxxxx',
+ *   family_name: 'yyyyy',
+ *   password: '123456',
+ *   password_echo: '123456',
+ *   provider: 'your provider', // FACEBOOK, GOOGLE, SELF
+ *   acceptlanguage: 'your locale' // optional example: de-de, en-US
+ * }, headers).then(function (response) {
+ *   // the response will give you client registration details.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ *```
+  */
+export declare function register(options: RegisterRequest, headers: HTTPRequestHeader): Promise<any>;
+/**
+ * to get information about invitation details, call **getInviteUserDetails()**. This API allows to retrieve invitation details and prefill the registration form.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/0b5efa5a2db5d-prefill-the-user-invitation for more details.
+ * Minimum cidaas version to use latest api is v3.100
+ * @example
+ * ```js
+ * const options = {
+ *   invite_id: 'id of user invitation'
+ *   callLatestAPI: 'true' // call latest api if parameter is given. By default, the older api will be called
+ * }
+ * cidaas.getInviteUserDetails(options)
+ * .then(function () {
+ *   // the response will give you information about the invitation.
+ * }).catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function getInviteUserDetails(options: GetInviteUserDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * Once registration successful, verify the account based on the flow. To get the details, call **getCommunicationStatus()**.
+ * @example
+ * ```js
+ * cidaas.getCommunicationStatus({
+ *   sub: 'your sub', // which you will get on the registration response
+ * }).then(function (response) {
+ *   // the response will give you account details once its verified.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function getCommunicationStatus(options: getCommunicationStatusRequest, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * To initiate the password resetting, call **initiateResetPassword()**. This will send verification code to your email or mobile based on the resetMedium you mentioned.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/6b29bac6002f4-initiate-password-reset for more details.
+ * @example
+ * ```js
+ * cidaas.initiateResetPassword({
+ *   email: 'xxxxxx@xxx.com',
+ *   processingType: ProcessingType.CODE,
+ *   requestId: 'your requestId',
+ *   resetMedium: ResetMedium.EMAIL
+ * }).then(function (response) {
+ *   // the response will give you password reset details.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function initiateResetPassword(options: InitiateResetPasswordRequest, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * To handle the reset password by entering the verification code you received, call **handleResetPassword()**. This will check if your verification code was valid or not, and allows you to proceed to the next step.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/3t8ztokeb7cfz-handle-reset-password for more details.
+ * @example
+ * ```js
+ * const handleResponseAsJson = 'true if the response need to be handled the old way (as json). In the current handling, the response information will be given as query parameter in redirect url.';
+ * cidaas.handleResetPassword({
+ *   code: 'your code in email or sms or ivr',
+ *   resetRequestId: 'your resetRequestId' // which you will get on initiate reset password response
+ * }, handleResponseAsJson).then(function (response) {
+ *   // the response will give you valid verification code.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function handleResetPassword(options: HandleResetPasswordRequest, handleResponseAsJson?: boolean, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * To finish reseting the password, call **resetPassword()**. This will allow you to change your password.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/qa9ny0gkzlf6y-accept-reset-password for more details.
+ * @example
+ * ```js
+ * const handleResponseAsJson = 'true if the response need to be handled the old way (as json). In the current handling, user will be redirected to success page after successful reset password.';
+ * cidaas.resetPassword({
+ *   password: '123456',
+ *   confirmPassword: '123456',
+ *   exchangeId: 'your exchangeId', // which you will get on handle reset password response
+ *   resetRequestId: 'your resetRequestId' // which you will get on handle reset password response
+ * }).then(function (response) {
+ *   // the response will give you reset password details.
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function resetPassword(options: ResetPasswordRequest, handleResponseAsJson?: boolean, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * To get the list of existing users in deduplication, call **getDeduplicationDetails()**.
+ * @example
+ * ```js
+ * this.cidaas.getDeduplicationDetails({
+ *   track_id: 'your track id'
+ * }).then((response) => {
+ *   // the response will give you deduplication details of users.
+ * }).catch((err) => {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function getDeduplicationDetails(options: GetDeduplicationDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * To use the existing users in deduplication, you need to call **deduplicationLogin()**.
+ * @example
+ * ```js
+ * this.cidaas.deduplicationLogin({
+ *   sub: 'your sub',
+ *   requestId: 'request id from deduplication initialisation after register',
+ *   trackId: 'track id from deduplication initialisation after register'
+ * })
+ * ```
+ */
+export declare function deduplicationLogin(options: DeduplicationLoginRequest): void;
+/**
+ * To register new user in deduplication, call **registerDeduplication()**.
+ * @example
+ * ```js
+ * this.cidaas.registerDeduplication({
+ *   track_id: 'track id from deduplication initialisation after register',
+ * }).then((response) => {
+ *   // the response will give you new registered deduplication user.
+ * }).catch((err) => {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function registerDeduplication(options: RegisterDeduplicationRequest, headers?: HTTPRequestHeader): Promise<any>;
+/**
+ * To change the password, call **changePassword()**. This will allow you to change your password.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/8221883241464-change-password for more details.
+ * @example
+ * ```js
+ * cidaas.changePassword({
+ *   old_password: 'your old password',
+ *   new_password: 'your new password',
+ *   confirm_password: 'your new password',
+ *   sub: 'your sub',
+ * }, 'your access token')
+ * .then(function () {
+ *   // your success code
+ * }).catch(function (ex) {
+ *   // your failure code
+ * });
+ * ```
+ */
+export declare function changePassword(options: ChangePasswordRequest, access_token: string): Promise<any>;
+/**
+ * To update the user profile information, call **updateProfile()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/i3uqnxcpxr19r-update-user-profile for more details.
+ * @example
+ * ```js
+ * cidaas.updateProfile({
+ *   family_name: 'Doe',
+ *   given_name: 'John',
+ *   provider: 'self',
+ *   acceptlanguage: 'your locale' // optional example: de-de, en-US
+ * }, 'your access token', 'your sub').then(function () {
+ *   // the response will give you updated user profile info.
+ * }).catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function updateProfile(options: CidaasUser, access_token: string, sub: string): Promise<any>;
+/**
+ * To initiate account linking, call **initiateLinkAccount()**.
+ * @example
+ * ```js
+ * const options = {
+ *   master_sub: 'sub of the user who initiates the user link',
+ *   user_name_to_link: 'username of the user which should get linked',
+ *   user_name_type: 'type of user name to link. E.g. email'
+ * }
+ * const access_token = 'your access token'
+ * this.cidaas.initiateLinkAccount(options, access_token).then((response) => {
+ *   // your success code
+ * }).catch((err) => {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function initiateLinkAccount(options: InitiateLinkAccountRequest, access_token: string): Promise<any>;
+/**
+ * To complete account linking, call **completeLinkAccount()**.
+ * @example
+ * ```js
+ * const options = {
+ *   code: 'code which is sent to account to be linked',
+ *   link_request_id: 'comes from initiateLinkAccount'
+ * }
+ * const access_token = 'your access token'
+ * this.cidaas.completeLinkAccount(options, access_token).then((response) => {
+ *   // your success code
+ * }).catch((err) => {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function completeLinkAccount(options: CompleteLinkAccountRequest, access_token: string): Promise<any>;
+/**
+ * To get all the linked accounts, call **getLinkedUsers()**.
+ * @example
+ * ```js
+ * const acccess_token= 'your access token';
+ * const sub = 'your sub';
+ *
+ * cidaas.getLinkedUsers(access_token, sub)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function getLinkedUsers(access_token: string, sub: string): Promise<any>;
+/**
+ * To unlink an account for a user, call **unlinkAccount()**.
+ * @example
+ * ```js
+ * const acccess_token= "your access token";
+ * const identityId = "comes from getLinkedUsers";
+ *
+ * cidaas.unlinkAccount(access_token, identityId)
+ * .then(function (response) {
+ *   // type your code here
+ * })
+ * .catch(function (ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function unlinkAccount(access_token: string, identityId: string): Promise<any>;
+/**
+ * To delete the user account directly in the application, call **deleteUserAccount()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/x133xdifl1sx9-schedule-user-deletion for more details.
+ * @example
+ * ```js
+ * options = {
+ *   access_token: "your access token",
+ *   sub: "your sub"
+ * }
+ *
+ * cidaas.deleteUserAccount(options).then(function (response) {
+ *   // your success code
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function deleteUserAccount(options: DeleteUserAccountRequest): Promise<any>;
+/**
+ * To check if user exists, call **userCheckExists()**.
+ * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/4yh82qism78xf-find-user-by-identifier for more details.
+ * @example
+ * options = {
+ *   requestId: "your request id",
+ *   email: "your email"
+ * }
+ *
+ * cidaas.userCheckExists(options).then(function (response) {
+ *   // your success code
+ * }).catch(function(ex) {
+ *   // your failure code here
+ * });
+ * ```
+ */
+export declare function userCheckExists(options: UserCheckExistsRequest, headers?: HTTPRequestHeader): Promise<any>;