@onelogin/sdk v3.0.0-alpha.1

one_login_api

OneLoginApi - JavaScript client for one_login_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 3.0.0-alpha.1
• Package version: 3.0.0-alpha.1
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

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 one_login_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your one_login_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

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

    npm install GIT_USER_ID/GIT_REPO_ID --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 OneLoginApi = require('one_login_api');


var api = new OneLoginApi.DefaultApi()
var authorization = "authorization_example"; // {String} 
var userId = 56; // {Number} Set to the id of the user.
var activateFactorRequest = new OneLoginApi.ActivateFactorRequest(); // {ActivateFactorRequest} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.activateFactor(authorization, userId, activateFactorRequest, callback);

Documentation for API Endpoints

All URIs are relative to https://onelogininc.onelogin.com

Documentation for Models

• OneLoginApi.Action
• OneLoginApi.ActivateFactorRequest
• OneLoginApi.AddAccessTokenClaimRequest
• OneLoginApi.AddClientAppRequest
• OneLoginApi.AddRoleUsers200ResponseInner
• OneLoginApi.AddScopeRequest
• OneLoginApi.AuthMethod
• OneLoginApi.AuthServerConfiguration
• OneLoginApi.ClientApp
• OneLoginApi.Condition
• OneLoginApi.Connector
• OneLoginApi.CreateAuthorizationServerRequest
• OneLoginApi.CreateEnvironmentVariableRequest
• OneLoginApi.CreateRoles201ResponseInner
• OneLoginApi.Device
• OneLoginApi.EnrollFactorRequest
• OneLoginApi.Envvar
• OneLoginApi.ErrorStatus
• OneLoginApi.ErrorStatusErrorsInner
• OneLoginApi.FactorInner
• OneLoginApi.FactorInnerFactorData
• OneLoginApi.GenerateMfaToken200Response
• OneLoginApi.GenerateMfaToken422Response
• OneLoginApi.GenerateMfaToken422ResponseDetails
• OneLoginApi.GenerateMfaTokenRequest
• OneLoginApi.GenerateSamlAssertionRequest
• OneLoginApi.GenerateToken200Response
• OneLoginApi.GenerateToken400Response
• OneLoginApi.GenerateTokenRequest
• OneLoginApi.GetAuthorizationServer200Response
• OneLoginApi.GetAvailableFactors200ResponseInner
• OneLoginApi.GetClientApps200ResponseInner
• OneLoginApi.GetClientApps200ResponseInnerScopesInner
• OneLoginApi.GetRateLimit200Response
• OneLoginApi.GetRateLimit200ResponseData
• OneLoginApi.GetRiskScore200Response
• OneLoginApi.GetRiskScore400Response
• OneLoginApi.GetRiskScoreRequest
• OneLoginApi.GetScoreInsights200Response
• OneLoginApi.GetScoreInsights200ResponseScores
• OneLoginApi.GetUserApps200ResponseInner
• OneLoginApi.Hook
• OneLoginApi.HookConditionsInner
• OneLoginApi.HookOptions
• OneLoginApi.HookStatus
• OneLoginApi.Id
• OneLoginApi.ListAccessTokenClaims200ResponseInner
• OneLoginApi.ListActions200ResponseInner
• OneLoginApi.ListAppUsers200ResponseInner
• OneLoginApi.ListAuthorizationServers200ResponseInner
• OneLoginApi.ListAuthorizationServers200ResponseInnerConfiguration
• OneLoginApi.ListConditionOperators200ResponseInner
• OneLoginApi.ListConditionValues200ResponseInner
• OneLoginApi.ListConditions200ResponseInner
• OneLoginApi.ListMappingConditionOperators200ResponseInner
• OneLoginApi.ListMappingConditions200ResponseInner
• OneLoginApi.ListScopes200ResponseInner
• OneLoginApi.Log
• OneLoginApi.Mapping
• OneLoginApi.Registration
• OneLoginApi.RemoveRoleUsersRequest
• OneLoginApi.RevokeTokenRequest
• OneLoginApi.RiskDevice
• OneLoginApi.RiskRule
• OneLoginApi.RiskUser
• OneLoginApi.Role
• OneLoginApi.Rule
• OneLoginApi.RuleId
• OneLoginApi.Schema
• OneLoginApi.Schema1
• OneLoginApi.Schema1AddedBy
• OneLoginApi.SchemaProvisioning
• OneLoginApi.Session
• OneLoginApi.SetRoleApps200ResponseInner
• OneLoginApi.Source
• OneLoginApi.Status
• OneLoginApi.Status1
• OneLoginApi.Status2
• OneLoginApi.Status2Status
• OneLoginApi.TrackEventRequest
• OneLoginApi.UpdateAuthorizationServer400Response
• OneLoginApi.UpdateClientAppRequest
• OneLoginApi.UpdateEnvironmentVariableRequest
• OneLoginApi.UpdateRole200Response
• OneLoginApi.User
• OneLoginApi.VerifyEnrollmentRequest
• OneLoginApi.VerifyFactorRequest
• OneLoginApi.VerifyFactorSaml200Response
• OneLoginApi.VerifyFactorSamlRequest
• OneLoginApi.VerifyFactorVoice200ResponseInner

Documentation for Authorization

All endpoints do not require authorization.