rsa_secur_id_authentication_api

RsaSecurIdAuthenticationApi - JavaScript client for rsa_secur_id_authentication_api This file defines the RSA SecurID Authentication API. This API supports a REST interface to perform multi-factor, multistep authentications. The caller must invoke the Initialize interface to start an authentication attempt and call the Verify method until the ResponseCode is either SUCCESS, ERROR, or FAIL. Each server response contains CredentialMethods, one of which must be provided in the subjectCredentials of the next Verify call. The server verifies the entered credentials and responds with CHALLENGE or IN_PROCESS if additional information (or confirmations) are required to complete the authentication. The IN_PROCESS status is returned for authentication steps that may not return immediately (often due to user interaction requirements). The caller should invoke the Verify call again using the same referenceID to 'poll' on the result of a previous IN_PROCESS authentication. Alternatively, Verify responds with SUCCESS if all required authentication credentials have been provided, FAIL if the verification of a credential failed, or ERROR for malformed requests. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.1
• Package version: 1.0.1
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://community.rsa.com/community/products/securid

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install rsa_secur_id_authentication_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/rsa_secur_id_authentication_api then install it via:

    npm install YOUR_USERNAME/rsa_secur_id_authentication_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var RsaSecurIdAuthenticationApi = require('rsa_secur_id_authentication_api');

var defaultClient = RsaSecurIdAuthenticationApi.ApiClient.instance;

// Configure API key authorization: client-key
var client-key = defaultClient.authentications['client-key'];
client-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//client-key.apiKeyPrefix['client-key'] = "Token"

var api = new RsaSecurIdAuthenticationApi.ClientApi()

var lang = "lang_example"; // {String} Locale of language to be used for prompt text. ISO 639-1 language code followed by an ISO 3166 country code separated by an underscore. For example, \"en_US\". See https://www.ietf.org/rfc/rfc3066.txt

var opts = { 
  'resourceId': "resourceId_example" // {String} A specific promptResourceId to be obtained by the client.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getResourceId(lang, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost/mfa/v1_1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- RsaSecurIdAuthenticationApi.ClientApi | getResourceId | GET /authn/resources | Provides I18N language resources. RsaSecurIdAuthenticationApi.I18nApi | getResourceId | GET /authn/resources | Provides I18N language resources. RsaSecurIdAuthenticationApi.UserApi | cancel | POST /authn/cancel | Cancels a previously initialized authentication. RsaSecurIdAuthenticationApi.UserApi | initialize | POST /authn/initialize | Initialize an authentication attempt. RsaSecurIdAuthenticationApi.UserApi | status | POST /authn/status | Checks status of initialized authentication. RsaSecurIdAuthenticationApi.UserApi | verify | POST /authn/verify | Verify authentication credentials.

Documentation for Models

• RsaSecurIdAuthenticationApi.AuthNResponse
• RsaSecurIdAuthenticationApi.AuthNResponseCredentialValidationResults
• RsaSecurIdAuthenticationApi.AuthNStatusResponse
• RsaSecurIdAuthenticationApi.AuthenticationMethod
• RsaSecurIdAuthenticationApi.AuthenticationMethodVersion
• RsaSecurIdAuthenticationApi.Cancel
• RsaSecurIdAuthenticationApi.ChallengeMethodSet
• RsaSecurIdAuthenticationApi.ChallengeMethods
• RsaSecurIdAuthenticationApi.CheckStatus
• RsaSecurIdAuthenticationApi.Credential
• RsaSecurIdAuthenticationApi.Initialize
• RsaSecurIdAuthenticationApi.MessageContext
• RsaSecurIdAuthenticationApi.MethodPrompt
• RsaSecurIdAuthenticationApi.NameValuePair
• RsaSecurIdAuthenticationApi.ResponseCode
• RsaSecurIdAuthenticationApi.Verify

Documentation for Authorization

client-key

• Type: API key
• API key parameter name: client-key
• Location: HTTP header