OAA Runtime API

All REST Endpoints

ChallengeCounter

ChallengeCounter will be reset based on provided context and challengeType.

OAA API resets Challenge counter for the given challegeType for the user based on the contextId: Method: delete
Path: /challengecounter/v1

ConfigProperty

Configuration Properties Management API for OAA Service.

Creates or updates configuration properties that are provided in the input.: Method: put
Path: /config/property/v1
Deletes configuration property that is provided in the input.: Method: delete
Path: /config/property/v1
Gets configuration properties such that all returned properties contain the property name provided in the input.: Method: get
Path: /config/property/v1

KBA

API that allows verification of user identity based on private information of user.

Associate and update questions with answers specific to user.: Method: put
Path: /oaa-kba/runtime/kba/v1/questions
Get questions of the user.: Method: get
Path: /oaa-kba/runtime/kba/v1/questions
Update questions of the user.: Method: put
Path: /oaa-kba/runtime/kba/v1/getquestionssecurely

Preferences

OAA API for managing user challenge preferences. User Preferences data is used for challenge flows during user authentication.

Deprecated - Returns user's challenge preferences as available in the OAA.: Method: get
Path: /oaa/runtime/preferences/v1
Deprecated - User Preferences are deleted.: Method: delete
Path: /oaa/runtime/preferences/v1
Returns user's challenge preferences as available in the OAA: Method: put
Path: /oaa/runtime/preferences/v1/fetchuserpreferencessecurely
Synchronize the preferences of the user: Method: put
Path: /oaa/runtime/preferences/v1/sync
User Preferences are created/registered.: Method: post
Path: /oaa/runtime/preferences/v1
User Preferences are truncated.: Method: put
Path: /oaa/runtime/preferences/v1/truncateuserpreferencessecurely
User Preferences are updated.: Method: put
Path: /oaa/runtime/preferences/v1

SecretKey

API for creating TOTP secret key.

Create Registration URL: Method: post
Path: /oaa/runtime/totp/registrationurl/v1/
Create Secret Key: Method: post
Path: /oaa/runtime/totp/key/v1/

UAS runtime

UAS runtime api providing more simplified apis outside. Internally will call apis from UAS and Factor to limit the number of required calls. Find out more from the application.wadl which will be at http://:/uas/runtime/application.wadl

Initialize or validate user challenge: Method: put
Path: /authn/v1
Returns list of challenges available for the user.: Method: post
Path: /authn/v1