[Docs] Introduction of New Conditional Auth Utility Function: getMaskedValue

[dhaura]

Is your suggestion related to a missing or misleading document? Please describe.

A new conditional authentication utility function is introduced with [1] which can be used to mask content in adaptive authentication script logs by developers. Since this is a newly introduced method, this issue is created to add the said method and its usage into WSO2 IS docs [2].

Describe the improvement

A new utility function (getMaskedValue) is introduced to mask sensitive content in adaptive authentication scripts.

A summary of the implemented method is as follows.

• Method Name: getMaskedValue
• Input Parameters: String value [Value to be masked] (ex: [email protected])
• Return Type: String [Masked value] (ex: j***************m)
• Functionality:
  • Always mask the given value and return it.

EX: For debugging purposes, if there is a need to add some logs including sensitive content (ex: PII) then it can be masked using the above method as follows.

var onLoginRequest = function(context) {
    executeStep(1, {
        onSuccess: function(context) {
                var email = context.currentKnownSubject.username;
                Log.info("Email of the logged user : " + getMaskedValue(email));
            }
        },
    });
};

---

[1] - wso2-extensions/identity-conditional-auth-functions#167
[2] - https://is.docs.wso2.com/en/latest/guides/authentication/conditional-auth/

[UdeshAthukorala]

Related Doc PR: wso2/docs-is#4664