Action

open class Action

Action can be used for FRRequestInterceptor to easily identify what type of outgoing event is being made from the SDK and for developers to customize the given Request object in FRRequestInterceptor`. See RequestInterceptor for more detail. Currently, ForgeRock SDK makes following Requests with corresponding Actions:

  • START_AUTHENTICATE - Initial Request made to the Authentication Tree: '/json/realms/{realm}/authenticate', tree name is provided in the payload
  • RESUME_AUTHENTICATE - Resume request made to the Authentication Tree: '/json/realms/{realm}/authenticate'
  • AUTHENTICATE - Any subsequent Requests made to the Authentication Tree: '/json/realms/{realm}/authenticate' tree name is provided in the payload
  • AUTHORIZE - Request for exchanging SSO Token to Authorization code: '/oauth2/realms/{realm}/authorize'
  • EXCHANGE_TOKEN - OAuth2 token exchange request with Authorization Code: '/oauth2/realms/{realm}/access_token'
  • REFRESH_TOKEN - OAuth2 token refresh request with given 'refresh_token': '/oauth2/realms/{realm}/access_token'
  • REVOKE_TOKEN - OAuth2 token revocation with given 'access_token' or 'refresh_token': '/oauth2/realms/{realm}/token/revoke'
  • LOGOUT - AM Session logout request to revoke SSO Token: '/json/realms/{realm}/sessions?_action=logout'
  • USER_INFO - Retrieving user info: `/oauth2/realms/{realm}/userinfo`
  • END_SESSION - End session API: `/oauth2/realms/{realm}/connect/endSession`
  • PUSH_REGISTER - AM Push registration for Authenticator SDK: `/json/push/sns/message?_action=register`
  • PUSH_AUTHENTICATE - AM Push authentication for Authenticator SDK: `/json/push/sns/message?_action=authenticate`

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
val AUTHENTICATE: String = "AUTHENTICATE"
Link copied to clipboard
val AUTHORIZE: String = "AUTHORIZE"
Link copied to clipboard
val END_SESSION: String = "END_SESSION"
Link copied to clipboard
val EXCHANGE_TOKEN: String = "EXCHANGE_TOKEN"
Link copied to clipboard
val LOGOUT: String = "LOGOUT"
Link copied to clipboard
private open var payload: JSONObject
Link copied to clipboard
val PUSH_AUTHENTICATE: String = "PUSH_AUTHENTICATE"
Link copied to clipboard
val PUSH_REGISTER: String = "PUSH_REGISTER"
Link copied to clipboard
val REFRESH_TOKEN: String = "REFRESH_TOKEN"
Link copied to clipboard
val RESUME_AUTHENTICATE: String = "RESUME_AUTHENTICATE"
Link copied to clipboard
val REVOKE_TOKEN: String = "REVOKE_TOKEN"
Link copied to clipboard
val START_AUTHENTICATE: String = "START_AUTHENTICATE"
Link copied to clipboard
private val type: String
Link copied to clipboard
val USER_INFO: String = "USER_INFO"