onelogin

OneLogin - the Ruby gem for the OneLogin 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: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build onelogin.gemspec

Then either install the gem locally:

gem install ./onelogin-1.0.0.gem

(for development, run gem install --dev ./onelogin-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'onelogin', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/onelogin/onelogin-ruby-sdk, then add the following in the Gemfile:

gem 'onelogin', :git => 'https://github.com/onelogin/onelogin-ruby-sdk.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'onelogin'

client_id = ENV.fetch('ONELOGIN_CLIENT_ID')
client_secret = ENV.fetch('ONELOGIN_CLIENT_SECRET')

OneLogin.configure do |config|
  config.host = '<your onelogin host>'
  config.debugging = true if ENV.fetch('DEBUG', false)
end
OneLogin::Api.new(client_id, client_secret)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
OneLogin::DefaultApi	activate_factor	POST /api/2/mfa/users/{user_id}/verifications
OneLogin::DefaultApi	add_access_token_claim	POST /api/2/api_authorizations/{id}/claims
OneLogin::DefaultApi	add_client_app	POST /api/2/api_authorizations/{id}/clients
OneLogin::DefaultApi	add_role_admins	POST /api/2/roles/{role_id}/admins
OneLogin::DefaultApi	add_role_users	POST /api/2/roles/{role_id}/users
OneLogin::DefaultApi	add_scope	POST /api/2/api_authorizations/{id}/scopes
OneLogin::DefaultApi	bulk_mapping_sort	PUT /api/2/apps/mappings/sort
OneLogin::DefaultApi	bulk_sort	PUT /api/2/apps/{app_id}/rules/sort
OneLogin::DefaultApi	create_app	POST /api/2/apps
OneLogin::DefaultApi	create_authorization_server	POST /api/2/api_authorizations
OneLogin::DefaultApi	create_environment_variable	POST /api/2/hooks/envs
OneLogin::DefaultApi	create_hook	POST /api/2/hooks
OneLogin::DefaultApi	create_mapping	POST /api/2/mappings
OneLogin::DefaultApi	create_risk_rule	POST /api/2/risk/rules
OneLogin::DefaultApi	create_roles	POST /api/2/roles
OneLogin::DefaultApi	create_rule	POST /api/2/apps/{app_id}/rules
OneLogin::DefaultApi	create_user	POST /api/2/users
OneLogin::DefaultApi	delete_access_token_claim	DELETE /api/2/api_authorizations/{id}/claims/{claim_id}
OneLogin::DefaultApi	delete_app	DELETE /api/2/apps/{app_id}
OneLogin::DefaultApi	delete_app_parameter	DELETE /api/2/apps/{app_id}/parameters/{parameter_id}
OneLogin::DefaultApi	delete_authorization_server	DELETE /api/2/api_authorizations/{id}
OneLogin::DefaultApi	delete_environment_variable	DELETE /api/2/hooks/envs/{envvar_id}
OneLogin::DefaultApi	delete_factor	DELETE /api/2/mfa/users/{user_id}/devices/{device_id}
OneLogin::DefaultApi	delete_hook	DELETE /api/2/hooks/{hook_id}
OneLogin::DefaultApi	delete_mapping	DELETE /api/2/mappings/{mapping_id}
OneLogin::DefaultApi	delete_risk_rule	DELETE /api/2/risk/rules/{risk_rule_id}
OneLogin::DefaultApi	delete_role	DELETE /api/2/roles/{role_id}
OneLogin::DefaultApi	delete_rule	DELETE /api/2/apps/{app_id}/rules/{rule_id}
OneLogin::DefaultApi	delete_scope	DELETE /api/2/api_authorizations/{id}/scopes/{scope_id}
OneLogin::DefaultApi	delete_user	DELETE /api/2/users/{user_id}
OneLogin::DefaultApi	dry_run_mapping	POST /api/2/mappings/{mapping_id}/dryrun
OneLogin::DefaultApi	enroll_factor	POST /api/2/mfa/users/{user_id}/registrations
OneLogin::DefaultApi	generate_mfa_token	POST /api/2/mfs/users/{user_id}/mfa_token
OneLogin::DefaultApi	generate_saml_assertion	POST /api/2/saml_assertion
OneLogin::DefaultApi	generate_token	POST /auth/oauth2/v2/token
OneLogin::DefaultApi	get_app	GET /api/2/apps/{app_id}
OneLogin::DefaultApi	get_authorization_server	GET /api/2/api_authorizations/{id}
OneLogin::DefaultApi	get_available_factors	GET /api/2/mfa/users/{user_id}/factors
OneLogin::DefaultApi	get_client_apps	GET /api/2/api_authorizations/{id}/clients
OneLogin::DefaultApi	get_enrolled_factors	GET /api/2/mfa/users/{user_id}/devices
OneLogin::DefaultApi	get_environment_variable	GET /api/2/hooks/envs/{envvar_id}
OneLogin::DefaultApi	get_hook	GET /api/2/hooks/{hook_id}
OneLogin::DefaultApi	get_logs	GET /api/2/hooks/{hook_id}/logs
OneLogin::DefaultApi	get_mapping	GET /api/2/mappings/{mapping_id}
OneLogin::DefaultApi	get_rate_limit	GET /auth/rate_limit
OneLogin::DefaultApi	get_risk_rule	GET /api/2/risk/rules/{risk_rule_id}
OneLogin::DefaultApi	get_risk_score	POST /api/2/risk/verify
OneLogin::DefaultApi	get_role	GET /api/2/roles/{role_id}
OneLogin::DefaultApi	get_role_admins	GET /api/2/roles/{role_id}/admins
OneLogin::DefaultApi	get_role_apps	GET /api/2/roles/{role_id}/apps
OneLogin::DefaultApi	get_role_users	GET /api/2/roles/{role_id}/users
OneLogin::DefaultApi	get_rule	GET /api/2/apps/{app_id}/rules/{rule_id}
OneLogin::DefaultApi	get_score_insights	GET /api/2/risk/scores
OneLogin::DefaultApi	get_user	GET /api/2/users/{user_id}
OneLogin::DefaultApi	get_user_apps	GET /api/2/users/{user_id}/apps
OneLogin::DefaultApi	list_access_token_claims	GET /api/2/api_authorizations/{id}/claims
OneLogin::DefaultApi	list_action_values	GET /api/2/apps/{app_id}/rules/actions/{actuion_value}/values
OneLogin::DefaultApi	list_actions	GET /api/2/apps/{app_id}/rules/actions
OneLogin::DefaultApi	list_app_users	GET /api/2/apps/{app_id}/users
OneLogin::DefaultApi	list_apps	GET /api/2/apps
OneLogin::DefaultApi	list_authorization_servers	GET /api/2/api_authorizations
OneLogin::DefaultApi	list_condition_operators	GET /api/2/apps/{app_id}/rules/conditions/{condition_value}/operators
OneLogin::DefaultApi	list_condition_values	GET /api/2/apps/{app_id}/rules/conditions/{condition_value}/values
OneLogin::DefaultApi	list_conditions	GET /api/2/apps/{app_id}/rules/conditions
OneLogin::DefaultApi	list_connectors	GET /api/2/connectors
OneLogin::DefaultApi	list_environment_variables	GET /api/2/hooks/envs
OneLogin::DefaultApi	list_hooks	GET /api/2/hooks
OneLogin::DefaultApi	list_mapping_action_values	GET /api/2/apps/mappings/actions/{actuion_value}/values
OneLogin::DefaultApi	list_mapping_actions	GET /api/2/apps/mappings/actions
OneLogin::DefaultApi	list_mapping_condition_operators	GET /api/2/apps/mappings/conditions/{condition_value}/operators
OneLogin::DefaultApi	list_mapping_condition_values	GET /api/2/apps/mappings/conditions/{condition_value}/values
OneLogin::DefaultApi	list_mapping_conditions	GET /api/2/apps/mappings/conditions
OneLogin::DefaultApi	list_mappings	GET /api/2/mappings
OneLogin::DefaultApi	list_risk_rules	GET /api/2/risk/rules
OneLogin::DefaultApi	list_roles	GET /api/2/roles
OneLogin::DefaultApi	list_rules	GET /api/2/apps/{app_id}/rules
OneLogin::DefaultApi	list_scopes	GET /api/2/api_authorizations/{id}/scopes
OneLogin::DefaultApi	list_users	GET /api/2/users
OneLogin::DefaultApi	remove_client_app	DELETE /api/2/api_authorizations/{id}/clients/{client_app_id}
OneLogin::DefaultApi	remove_role_admins	DELETE /api/2/roles/{role_id}/admins
OneLogin::DefaultApi	remove_role_users	DELETE /api/2/roles/{role_id}/users
OneLogin::DefaultApi	revoke_token	POST /auth/oauth2/revoke
OneLogin::DefaultApi	set_role_apps	PUT /api/2/roles/{role_id}/apps
OneLogin::DefaultApi	track_event	POST /api/2/risk/events
OneLogin::DefaultApi	update_access_token_claim	PUT /api/2/api_authorizations/{id}/claims/{claim_id}
OneLogin::DefaultApi	update_app	PUT /api/2/apps/{app_id}
OneLogin::DefaultApi	update_authorization_server	PUT /api/2/api_authorizations/{id}
OneLogin::DefaultApi	update_client_app	PUT /api/2/api_authorizations/{id}/clients/{client_app_id}
OneLogin::DefaultApi	update_environment_variable	PUT /api/2/hooks/envs/{envvar_id}
OneLogin::DefaultApi	update_hook	PUT /api/2/hooks/{hook_id}
OneLogin::DefaultApi	update_mapping	PUT /api/2/mappings/{mapping_id}
OneLogin::DefaultApi	update_risk_rule	PUT /api/2/risk/rules/{risk_rule_id}
OneLogin::DefaultApi	update_role	PUT /api/2/roles/{role_id}
OneLogin::DefaultApi	update_rule	PUT /api/2/apps/{app_id}/rules/{rule_id}
OneLogin::DefaultApi	update_scope	PUT /api/2/api_authorizations/{id}/scopes/{scope_id}
OneLogin::DefaultApi	update_user	PUT /api/2/users/{user_id}
OneLogin::DefaultApi	verify_enrollment	PUT /api/2/mfa/users/{user_id}/registrations/{registration_id}
OneLogin::DefaultApi	verify_enrollment_voice_protect	GET /api/2/mfa/users/{user_id}/registrations/{registration_id}
OneLogin::DefaultApi	verify_factor	PUT /api/2/mfa/users/{user_id}/verifications/{verification_id}
OneLogin::DefaultApi	verify_factor_saml	POST /api/2/saml_assertion/verify_factor
OneLogin::DefaultApi	verify_factor_voice	GET /api/2/mfa/users/{user_id}/verifications/{verification_id}

Documentation for Models

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

Documentation for Authorization

All endpoints do not require authorization.