forgerock-auth

4.4.0

forgerock-auth/org.forgerock.android.auth/FRSession/authenticate

authenticate

open fun authenticate(context: Context, advice: PolicyAdvice, listener: NodeListener<FRSession>)

Trigger the Authentication Tree flow process with the PolicyAdvice

Parameters

context

The Application Context

advice

Policy Advice for Step up authentication.

listener

Listener to listen for authenticate event. onSuccess on success login, FRSession is returned. onCallbackReceived step to the next node, Node is returned. throws when server returns { } throws { } When server return errors. throws { } When { } returned from Server is not supported by the SDK. throws { } When Authentication tree timeout throws { } when failed to parse server response as JSON String. throws { } When there is any network error. throws { } When failed to parse the URL for API request. throws { } or { } When failed to initialize the Callback class.

open fun authenticate(context: Context, serviceName: String, listener: NodeListener<FRSession>)

Trigger the Authentication Tree flow process with the provided tree name

Parameters

context

The Application Context

serviceName

Authentication Tree name

listener

Listener to listen for authenticate event. onSuccess on success login, FRSession is returned. onCallbackReceived step to the next node, Node is returned. throws when server returns { } throws { } When server return errors. throws { } When { } returned from Server is not supported by the SDK. throws { } When Authentication tree timeout throws { } when failed to parse server response as JSON String. throws { } When there is any network error. throws { } When failed to parse the URL for API request. throws { } or { } When failed to initialize the Callback class.

open fun authenticate(context: Context, resumeURI: Uri, listener: NodeListener<FRSession>)

Trigger the Authentication Tree flow process with the provided resume URI

Parameters

context

The Application Context

resumeURI

Resume URI

listener

Listener to listen for authenticate event. onSuccess on success login, FRSession is returned. onCallbackReceived step to the next node, Node is returned. throws when server returns { } throws { } When server return errors. throws { } When { } returned from Server is not supported by the SDK. throws { } When Suspended ID timeout throws { } When Authentication tree timeout throws { } when failed to parse server response as JSON String. throws { } When there is any network error. throws { } When failed to parse the URL for API request. throws { } or { } When failed to initialize the Callback class.