@onelogin/sdk

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

Class	Method	HTTP request	Description
OneLoginApi.DefaultApi	activateFactor	POST /api/2/mfa/users/{user_id}/verifications
OneLoginApi.DefaultApi	addAccessTokenClaim	POST /api/2/api_authorizations/{id}/claims
OneLoginApi.DefaultApi	addClientApp	POST /api/2/api_authorizations/{id}/clients
OneLoginApi.DefaultApi	addRoleAdmins	POST /api/2/roles/{role_id}/admins
OneLoginApi.DefaultApi	addRoleUsers	POST /api/2/roles/{role_id}/users
OneLoginApi.DefaultApi	addScope	POST /api/2/api_authorizations/{id}/scopes
OneLoginApi.DefaultApi	bulkMappingSort	PUT /api/2/apps/mappings/sort
OneLoginApi.DefaultApi	bulkSort	PUT /api/2/apps/{app_id}/rules/sort
OneLoginApi.DefaultApi	createApp	POST /api/2/apps
OneLoginApi.DefaultApi	createAuthorizationServer	POST /api/2/api_authorizations
OneLoginApi.DefaultApi	createEnvironmentVariable	POST /api/2/hooks/envs
OneLoginApi.DefaultApi	createHook	POST /api/2/hooks
OneLoginApi.DefaultApi	createMapping	POST /api/2/mappings
OneLoginApi.DefaultApi	createRiskRule	POST /api/2/risk/rules
OneLoginApi.DefaultApi	createRoles	POST /api/2/roles
OneLoginApi.DefaultApi	createRule	POST /api/2/apps/{app_id}/rules
OneLoginApi.DefaultApi	createUser	POST /api/2/users
OneLoginApi.DefaultApi	deleteAccessTokenClaim	DELETE /api/2/api_authorizations/{id}/claims/{claim_id}
OneLoginApi.DefaultApi	deleteApp	DELETE /api/2/apps/{app_id}
OneLoginApi.DefaultApi	deleteAppParameter	DELETE /api/2/apps/{app_id}/parameters/{parameter_id}
OneLoginApi.DefaultApi	deleteAuthorizationServer	DELETE /api/2/api_authorizations/{id}
OneLoginApi.DefaultApi	deleteEnvironmentVariable	DELETE /api/2/hooks/envs/{envvar_id}
OneLoginApi.DefaultApi	deleteFactor	DELETE /api/2/mfa/users/{user_id}/devices/{device_id}
OneLoginApi.DefaultApi	deleteHook	DELETE /api/2/hooks/{hook_id}
OneLoginApi.DefaultApi	deleteMapping	DELETE /api/2/mappings/{mapping_id}
OneLoginApi.DefaultApi	deleteRiskRule	DELETE /api/2/risk/rules/{risk_rule_id}
OneLoginApi.DefaultApi	deleteRole	DELETE /api/2/roles/{role_id}
OneLoginApi.DefaultApi	deleteRule	DELETE /api/2/apps/{app_id}/rules/{rule_id}
OneLoginApi.DefaultApi	deleteScope	DELETE /api/2/api_authorizations/{id}/scopes/{scope_id}
OneLoginApi.DefaultApi	deleteUser	DELETE /api/2/users/{user_id}
OneLoginApi.DefaultApi	dryRunMapping	POST /api/2/mappings/{mapping_id}/dryrun
OneLoginApi.DefaultApi	enrollFactor	POST /api/2/mfa/users/{user_id}/registrations
OneLoginApi.DefaultApi	generateMfaToken	POST /api/2/mfs/users/{user_id}/mfa_token
OneLoginApi.DefaultApi	generateSamlAssertion	POST /api/2/saml_assertion
OneLoginApi.DefaultApi	generateToken	POST /auth/oauth2/v2/token
OneLoginApi.DefaultApi	getApp	GET /api/2/apps/{app_id}
OneLoginApi.DefaultApi	getAuthorizationServer	GET /api/2/api_authorizations/{id}
OneLoginApi.DefaultApi	getAvailableFactors	GET /api/2/mfa/users/{user_id}/factors
OneLoginApi.DefaultApi	getClientApps	GET /api/2/api_authorizations/{id}/clients
OneLoginApi.DefaultApi	getEnrolledFactors	GET /api/2/mfa/users/{user_id}/devices
OneLoginApi.DefaultApi	getEnvironmentVariable	GET /api/2/hooks/envs/{envvar_id}
OneLoginApi.DefaultApi	getHook	GET /api/2/hooks/{hook_id}
OneLoginApi.DefaultApi	getLogs	GET /api/2/hooks/{hook_id}/logs
OneLoginApi.DefaultApi	getMapping	GET /api/2/mappings/{mapping_id}
OneLoginApi.DefaultApi	getRateLimit	GET /auth/rate_limit
OneLoginApi.DefaultApi	getRiskRule	GET /api/2/risk/rules/{risk_rule_id}
OneLoginApi.DefaultApi	getRiskScore	POST /api/2/risk/verify
OneLoginApi.DefaultApi	getRole	GET /api/2/roles/{role_id}
OneLoginApi.DefaultApi	getRoleAdmins	GET /api/2/roles/{role_id}/admins
OneLoginApi.DefaultApi	getRoleApps	GET /api/2/roles/{role_id}/apps
OneLoginApi.DefaultApi	getRoleUsers	GET /api/2/roles/{role_id}/users
OneLoginApi.DefaultApi	getRule	GET /api/2/apps/{app_id}/rules/{rule_id}
OneLoginApi.DefaultApi	getScoreInsights	GET /api/2/risk/scores
OneLoginApi.DefaultApi	getUser	GET /api/2/users/{user_id}
OneLoginApi.DefaultApi	getUserApps	GET /api/2/users/{user_id}/apps
OneLoginApi.DefaultApi	listAccessTokenClaims	GET /api/2/api_authorizations/{id}/claims
OneLoginApi.DefaultApi	listActionValues	GET /api/2/apps/{app_id}/rules/actions/{actuion_value}/values
OneLoginApi.DefaultApi	listActions	GET /api/2/apps/{app_id}/rules/actions
OneLoginApi.DefaultApi	listAppUsers	GET /api/2/apps/{app_id}/users
OneLoginApi.DefaultApi	listApps	GET /api/2/apps
OneLoginApi.DefaultApi	listAuthorizationServers	GET /api/2/api_authorizations
OneLoginApi.DefaultApi	listConditionOperators	GET /api/2/apps/{app_id}/rules/conditions/{condition_value}/operators
OneLoginApi.DefaultApi	listConditionValues	GET /api/2/apps/{app_id}/rules/conditions/{condition_value}/values
OneLoginApi.DefaultApi	listConditions	GET /api/2/apps/{app_id}/rules/conditions
OneLoginApi.DefaultApi	listConnectors	GET /api/2/connectors
OneLoginApi.DefaultApi	listEnvironmentVariables	GET /api/2/hooks/envs
OneLoginApi.DefaultApi	listHooks	GET /api/2/hooks
OneLoginApi.DefaultApi	listMappingActionValues	GET /api/2/apps/mappings/actions/{actuion_value}/values
OneLoginApi.DefaultApi	listMappingActions	GET /api/2/apps/mappings/actions
OneLoginApi.DefaultApi	listMappingConditionOperators	GET /api/2/apps/mappings/conditions/{condition_value}/operators
OneLoginApi.DefaultApi	listMappingConditionValues	GET /api/2/apps/mappings/conditions/{condition_value}/values
OneLoginApi.DefaultApi	listMappingConditions	GET /api/2/apps/mappings/conditions
OneLoginApi.DefaultApi	listMappings	GET /api/2/mappings
OneLoginApi.DefaultApi	listRiskRules	GET /api/2/risk/rules
OneLoginApi.DefaultApi	listRoles	GET /api/2/roles
OneLoginApi.DefaultApi	listRules	GET /api/2/apps/{app_id}/rules
OneLoginApi.DefaultApi	listScopes	GET /api/2/api_authorizations/{id}/scopes
OneLoginApi.DefaultApi	listUsers	GET /api/2/users
OneLoginApi.DefaultApi	removeClientApp	DELETE /api/2/api_authorizations/{id}/clients/{client_app_id}
OneLoginApi.DefaultApi	removeRoleAdmins	DELETE /api/2/roles/{role_id}/admins
OneLoginApi.DefaultApi	removeRoleUsers	DELETE /api/2/roles/{role_id}/users
OneLoginApi.DefaultApi	revokeToken	POST /auth/oauth2/revoke
OneLoginApi.DefaultApi	setRoleApps	PUT /api/2/roles/{role_id}/apps
OneLoginApi.DefaultApi	trackEvent	POST /api/2/risk/events
OneLoginApi.DefaultApi	updateAccessTokenClaim	PUT /api/2/api_authorizations/{id}/claims/{claim_id}
OneLoginApi.DefaultApi	updateApp	PUT /api/2/apps/{app_id}
OneLoginApi.DefaultApi	updateAuthorizationServer	PUT /api/2/api_authorizations/{id}
OneLoginApi.DefaultApi	updateClientApp	PUT /api/2/api_authorizations/{id}/clients/{client_app_id}
OneLoginApi.DefaultApi	updateEnvironmentVariable	PUT /api/2/hooks/envs/{envvar_id}
OneLoginApi.DefaultApi	updateHook	PUT /api/2/hooks/{hook_id}
OneLoginApi.DefaultApi	updateMapping	PUT /api/2/mappings/{mapping_id}
OneLoginApi.DefaultApi	updateRiskRule	PUT /api/2/risk/rules/{risk_rule_id}
OneLoginApi.DefaultApi	updateRole	PUT /api/2/roles/{role_id}
OneLoginApi.DefaultApi	updateRule	PUT /api/2/apps/{app_id}/rules/{rule_id}
OneLoginApi.DefaultApi	updateScope	PUT /api/2/api_authorizations/{id}/scopes/{scope_id}
OneLoginApi.DefaultApi	updateUser	PUT /api/2/users/{user_id}
OneLoginApi.DefaultApi	verifyEnrollment	PUT /api/2/mfa/users/{user_id}/registrations/{registration_id}
OneLoginApi.DefaultApi	verifyEnrollmentVoiceProtect	GET /api/2/mfa/users/{user_id}/registrations/{registration_id}
OneLoginApi.DefaultApi	verifyFactor	PUT /api/2/mfa/users/{user_id}/verifications/{verification_id}
OneLoginApi.DefaultApi	verifyFactorSaml	POST /api/2/saml_assertion/verify_factor
OneLoginApi.DefaultApi	verifyFactorVoice	GET /api/2/mfa/users/{user_id}/verifications/{verification_id}

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.