onelogin 1.6.0 → 3.0.0.pre.alpha.1

data/README.md

@@ -1,517 +1,278 @@
-# OneLogin Ruby SDK
+# onelogin
 
-This SDK will let you execute all the API methods, version/1, described
-at https://developers.onelogin.com/api-docs/1/getting-started/dev-overview.
+OneLogin - the Ruby gem for the OneLogin API
 
-The toolkit is hosted on github. You can download it from:
-* Lastest release: https://github.com/onelogin/onelogin-ruby-sdk/releases/latest
-* Master repo: https://github.com/onelogin/onelogin-ruby-sdk/tree/master
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'onelogin'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install onelogin
-
-
-### Dependencies
-
-* httparty
-
-## Getting started
-
-You'll need a OneLogin account and a set of API credentials before you get started.
+- API version: 3.0.0-alpha.1
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
-If you don't have an account you can [sign up for a free developer account here](https://www.onelogin.com/developer-signup).
-
-|||
-|---|---|
-|client_id|Required: A valid OneLogin API client_id|
-|client_secret|Required: A valid OneLogin API client_secret|
-|region| Optional: `us` or `eu`. Defaults to `us`   |
-|max_results| Optional: Defaults to 1000  |
-|timeout| Optional: Defaults to 60 (requires httparty > 0.16.2) |
-
-```ruby
-require 'onelogin'
-
-client = OneLogin::Api::Client.new(
-    client_id: '',
-    client_secret:'',
-    region: 'us'
-)
-
-# Now you can make requests
-client.get_users
-```
-
-For all methods see Rubydoc of this SDK published at:
-http://www.rubydoc.info/github/onelogin/onelogin-ruby-sdk
-
-
-## Usage
-
-### Errors and exceptions
-
-OneLogin's API can return 400, 401, 403 or 404 when there was any issue executing the action. When that happens, the methods of the SDK will include error and errorMessage in the client. Use `error` and `error_description` of the Client to retrieve them.
-
-```ruby
-users = client.get_users
+## Installation
 
-if users.nil?
-    puts client.error
-    puts client.error_description
-end
-```
+### Build a gem
 
-In some scenarios there is an attribute not provided or invalid that causes the error,
-when that happens in addition to the error_description a error_attribute is available
-with the name of the attribute that caused the issue. Accesible at the client like:
+To build the Ruby code into a gem:
 
-```ruby
-client.error_attribute
+```shell
+gem build onelogin.gemspec
 ```
 
-### Authentication
-
-By default methods call internally to `get_access_token` if there is no valid access_token. You can also get tokens etc directly if needed.
-
-```ruby
-# Get an AccessToken
-token = client.get_access_token
-
-# Refresh an AccessToken
-token2 = client.regenerate_token
+Then either install the gem locally:
 
-# Revoke an AccessToken
-token3 = client.get_access_token
+```shell
+gem install ./onelogin-1.0.0.gem
 ```
 
-### Paging
-All OneLogin API endpoints that support paging are returned as enumerations to save you keeping track of the paging cursor.
+(for development, run `gem install --dev ./onelogin-1.0.0.gem` to install the development dependencies)
 
-User `take` to limit the results or get all results by enumerating.
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
-e.g.
-```ruby
-# List the first name of all users
-client.get_users.each do |user|
-    puts user.firstname
-end
+Finally add this to the Gemfile:
 
-# List the first name of all users starting with the 2nd user
-# `each` accepts a start param to skip first x results
-client.get_users.each(1) do |user|
-    puts user.firstname
-end
+    gem 'onelogin', '~> 1.0.0'
 
-# List the first 5 users with the name of Joe
-client.get_users(firstname: 'Joe').take(5).each do |user|
-    puts "#{user.firstname} #{user.lastname}"
-end
+### Install from Git
 
-# Get 10 event ids
-client.get_events.take(10).map{|event| event.id }
+If the Ruby gem is hosted at a git repository: https://github.com/onelogin/onelogin-ruby-sdk, then add the following in the Gemfile:
 
-# Get all roles
-client.get_roles.to_a
-```
+    gem 'onelogin', :git => 'https://github.com/onelogin/onelogin-ruby-sdk.git'
 
-For safety where some collections (e.g. `get_events`) have large numbers of resources there is a
-limit of 1000 total results returned. You can override this with the `max_results` param during Client initialization.
+### Include the Ruby code directly
 
-```
-client = OneLogin::Api::Client.new(
-    client_id: '',
-    client_secret:'',
-    max_results: 50000
-)
+Include the Ruby code directly using `-I` as follows:
 
-client.get_events.map {|event| event.id}
+```shell
+ruby -Ilib script.rb
 ```
 
+## Getting Started
 
-
-### Available Methods
+Please follow the [installation](#installation) procedure and then run the following code:
 
 ```ruby
-# Get rate limits
-rate_limits = client.get_rate_limits
-
-# Get Custom Attributes
-custom_global_attributes = client.get_custom_attributes
-
-# Get Users with no query parameters
-users = client.get_users
-
-# Get Users with query parameters
-query_parameters = {
-    email: "user@example.com"
-}
-users_filtered = client.get_users(query_parameters)
-
-query_parameters = {
-    email: "usermfa@example.com"
-}
-users_filtered2 = client.get_users(query_parameters)
-
-# Get Users with limit
-query_parameters = {
-    limit: 3
-}
-users_filtered_limited = client.get_users(query_parameters)
-
-# Only return the firstname and email fields for each user
-client.get_users(fields: 'email,firstname').each do |user|
-    puts "#{user.firstname} - #{user.email}"
-end
+# Load the gem
+require 'onelogin'
 
-# Get User by id
-user = client.get_user(users_filtered.first.id)
-user_mfa = client.get_user(users_filtered2.first.id)
-
-# Update User with specific id
-user = client.get_user(user.id)
-update_user_params = user.get_user_params
-update_user_params["firstname"] = 'modified_firstname'
-user = client.update_user(user.id, update_user_params)
-user = client.get_user(user.id)
-
-# Get Global Roles
-roles = client.get_roles
-
-# Get Role
-role = client.get_role(1234)
-
-# Assign & Remove Roles On Users
-role_ids = [
-    1234, 5678
-]
-result = client.assign_role_to_user(user.id, role_ids)
-role_ids.pop
-result = client.remove_role_from_user(user.id, role_ids)
-user = client.get_user(user.id)
-
-# Sets Password by ID Using Cleartext
-password = "Aa765431-XxX"
-result = client.set_password_using_clear_text(user.id, password, password)
-
-# Sets Password by ID Using Salt and SHA-256
-password = "Aa765432-YyY"
-salt = "11xxxx1"
-
-require 'digest'
-sha256 = Digest::SHA256.new
-hashed_salted_password = sha256.hexdigest("#{pw}#{salt}")
-result = client.set_password_using_hash_salt(user_mfa.id, hashed_salted_password, hashed_salted_password, "salt+sha256", salt)
-
- Set Custom Attribute Value to User
-customAttributes = {
-    custom_global_attributes[0]=> "xxxx",
-    custom_global_attributes[1]=> "yyyy"
-}
-result = client.set_custom_attribute_to_user(34687020, customAttributes)
-
-# Log Out User
-result = client.log_user_out(user.id)
-
-# Lock User
-result = client.lock_user(user.id, 5)
-
-# Get User apps
-apps = client.get_user_apps(user.id)
-
-# Get User Roles
-role_ids = client.get_user_roles(user.id)
-
-# Generate MFA Token
-mfa_token = client.generate_mfa_token(user.id)
-
-# Get all Connectors in a OneLogin account filtering by name*/
-apps = client.get_connectors({name:'SAML'})
-
-# Get all Apps in a OneLogin account using API v1 */
-apps_v1 = client.get_apps_v1
-
-# Get all Apps in a OneLogin account filtering by auth_method*/
-apps = client.get_apps({auth_method:6})
-
-# Create app
-app_data = {
- name: "Created SAML App by API",
- description:"Created SAML App by API description",
- notes: "Created SAML App by API notes",
- auth_method: 2,
- policy_id: 167865,
- allow_assumed_signin: false,
- parameters: {
-    saml_username: {
-        user_attribute_mappings: "email",
-        label: "NameID (fka Email)",
-    }
- },
- connector_id: 110016,
- visible: true,
- configuration: {
-   saml_initiater_id: "0",
-   encrypt_assertion: "0",
-   recipient: "http://sp.example.com/acs",
-   saml_notbefore: "3",
-   saml_nameid_format_id: "0",
-   saml_issuer_type: "0",
-   saml_sign_element: "0",
-   consumer_url: "http://sp.example.com/acs",
-   validator: ".*",
-   relaystate: "",
-   logout_url: "http://sp.example.com/sls",
-   saml_encryption_method_id: "0",
-   login: "http://sp.example.com/login",
-   saml_sessionnotonorafter: "1440",
-   generate_attribute_value_tags: "0",
-   saml_notonorafter: "3",
-   audience: "http://sp.example.com/audience",
-   signature_algorithm: "SHA-256"
- }
-}
-app = client.create_app(app_data)
-
-# Update app
-app_data[:name] = "Created SAML App by API updated"
-client.update_app(app.id, app_data)
-
-# Get app
-app = client.get_app(app.id)
-
-# Delete app
-result = client.delete_app(app.id)
-
-# Delete parameter from app
-result = client.delete_parameter_from_app(app.id, parameter_id)
-
-# Create user
-new_user_params = {
-    email: "testcreate_1@example.com",
-    firstname: "testcreate_1_fn",
-    lastname: "testcreate_1_ln",
-    username: "testcreate_1@example.com"
-}
-created_user = client.create_user(new_user_params)
-
-# Delete User
-result = client.delete_user(created_user.id)
-
-# Get EventTypes
-event_types = client.get_event_types
-
-# Get Events
-events = client.get_events
-
-query_events_params = {
-    limit: 2
-}
-events_limited = client.get_events(query_events_params)
-
-# Get Event
-event = client.get_event(events[0].id)
-
-# Create Event
-new_event_params = {
-    event_type_id: "000",
-    account_id: "00000",
-    actor_system: "00",
-    user_id: "00000000",
-    user_name: "test_event",
-    custom_message: "test creating event from python :)"
-}
-result = client.create_event(new_event_params)
-
-# Get Filtered Events
-query_events_params = array(
-  user_id: "00000000"
-)
-events = client.get_events(query_events_params)
-
-# Get Groups
-groups = client.get_groups
-
-# Get Group
-group = client.get_group(groups.first.id)
-
-# Get SAMLResponse directly
-app_id = "000000"
-saml_endpoint_response = client.get_saml_assertion("user@example.com", "Aa765431-XxX", app_id, "example-onelogin-subdomain")
-
-# Get SAMLResponse after MFA
-saml_endpoint_response2 = client.get_saml_assertion("usermfa@example.com", "Aa765432-YyY", app_id, "example-onelogin-subdomain")
-mfa = saml_endpoint_response2.mfa
-otp_token = "000000"
-saml_endpoint_response_after_verify = client.get_saml_assertion_verifying(app_id, mfa.devices[0].id, mfa.state_token, "78395727", nil)
-
-# Create Session Login Token
-session_login_token_params = {
-    username_or_email: "user@example.com",
-    password: "Aa765431-XxX",
-    subdomain: "example-onelogin-subdomain"
-}
-session_token_data = client.create_session_login_token(session_login_token_params)
-
-# Create Session Login Token MFA , after verify
-session_login_token_mfa_params = {
-    username_or_email: "usermfa@example.com",
-    password: "Aa765432-YyY",
-    subdomain: "example-onelogin-subdomain"
-}
-session_token_mfa_data = client.create_session_login_token(session_login_token_mfa_params)
-otp_token = "000000" # We get this value from OTP device
-session_token_data2 = client.get_session_token_verified(session_token_mfa_data.devices.first.id,session_token_mfa_data.state_token, otp_token)
-
-user_id = 00000000
-# Get Available Authentication Factors
-auth_factors = client.get_factors(user_id)
-
-# Enroll an Authentication Factor
-enroll_factor = client.enroll_factor(user_id, auth_factors.first.id, 'My Device', '+14156456830')
-
-# Get Enrolled Authentication Factors
-otp_devices = client.get_enrolled_factors(user_id)
-
-# Activate an Authentication Factor
-device_id = 0000000
-enrollment_response = client.activate_factor(user_id, device_id)
-
-# Verify an Authentication Factor
-result = client.verify_factor(user_id, device_id, otp_token="4242342423")
-
-# Remove a Factor
-result = client.remove_factor(user_id, device_id)
-
-# Generate Invite Link
-url_link = client.generate_invite_link("user@example.com")
-
-# Send Invite Link
-sent = client.send_invite_link("user@example.com")
-
-#Get Apps to Embed for a User
-embed_token = "30e256c101cd0d2e731de1ec222e93c4be8a1572"
-apps = client.get_embed_apps("30e256c101cd0d2e731de1ec222e93c4be8a1572", "user@example.com")
-
-# Get Privileges
-privileges = client.get_privileges()
-
-# Create Privilege
-name = "privilege_example"
-version = "2018-05-18"
-
-statement1 = OneLogin::Api::Models::Statement.new(
-    "Allow",
-    [
-        "users:List",
-        "users:Get",
-    ],
-    ["*"]
-)
-
-statement2 = OneLogin::Api::Models::Statement.new(
-    "Allow",
-    [
-        "apps:List",
-        "apps:Get",
-    ],
-    ["*"]
-)
-
-statements = [
-    statement1,
-    statement2
-]
-privilege = client.create_privilege(name, version, statements)
-
-# Update Privilege
-name = "privilege_example_updated"
-statement2 = OneLogin::Api::Models::Statement.new(
-    "Allow",
-    [
-        "apps:List",
-    ],
-    ["*"]
-)
-statements = [
-    statement1,
-    statement2
-]
-privilege = client.update_privilege(privilege.id, name, version, statements)
-
-# Get Privilege
-privileges = client.get_privilege(privilege.id)
-
-# Delete Privilege
-result = client.delete_privilege(privilege.id)
-
-# Gets a list of the roles assigned to a privilege
-assigned_roles = client.get_roles_assigned_to_privilege(privilege.id)
-
-# Assign roles to a privilege
-result = client.assign_roles_to_privilege(privilege.id, [role_id1, role_id2])
-
-# Remove role from a privilege
-result = client.remove_role_from_privilege(privilege.id, role_id_1)
-
-# Gets a list of the users assigned to a privilege
-assigned_users = client.get_users_assigned_to_privilege(privilege.id)
-
-# Assign users to a privilege
-result = client.assign_users_to_privilege(privilege.id, [user_id1, user_id2])
-
-# Remove user from a privilege
-result = client.remove_user_from_privilege(privilege.id, user_id2)
-```
+api_instance = OneLogin::DefaultApi.new
+authorization = 'authorization_example' # String | 
+user_id = 56 # Integer | Set to the id of the user.
+activate_factor_request = OneLogin::ActivateFactorRequest.new # ActivateFactorRequest | 
 
-## Proxy Servers
-If you're stuck behind a proxy then you can still use this SDK by providing at a minimum the
-host address of your proxy server.
+begin
+  api_instance.activate_factor(authorization, user_id, activate_factor_request)
+rescue OneLogin::ApiError => e
+  puts "Exception when calling DefaultApi->activate_factor: #{e}"
+end
 
-```ruby
-client = OneLogin::Api::Client.new(
-  client_id: 'some-client-id',
-  client_secret:'some-client-secret',
-  region: 'us',
-  proxy_host: 'https://blah.com',
-  proxy_port: '8080',
-  proxy_user: 'username',
-  proxy_pass: 'password'
-)
 ```
 
-* `proxy_host` - required, the host address of your proxy server
-* `proxy_port` - optional, the port number of your proxy server
-* `proxy_user` - optional, the username for your proxy server
-* `proxy_pass` - optional, the password for your proxy server
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/onelogin/onelogin-ruby-sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-## Code of Conduct
+## Documentation for API Endpoints
+
+All URIs are relative to *https://onelogininc.onelogin.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*OneLogin::DefaultApi* | [**activate_factor**](docs/DefaultApi.md#activate_factor) | **POST** /api/2/mfa/users/{user_id}/verifications | 
+*OneLogin::DefaultApi* | [**add_access_token_claim**](docs/DefaultApi.md#add_access_token_claim) | **POST** /api/2/api_authorizations/{id}/claims | 
+*OneLogin::DefaultApi* | [**add_client_app**](docs/DefaultApi.md#add_client_app) | **POST** /api/2/api_authorizations/{id}/clients | 
+*OneLogin::DefaultApi* | [**add_role_admins**](docs/DefaultApi.md#add_role_admins) | **POST** /api/2/roles/{role_id}/admins | 
+*OneLogin::DefaultApi* | [**add_role_users**](docs/DefaultApi.md#add_role_users) | **POST** /api/2/roles/{role_id}/users | 
+*OneLogin::DefaultApi* | [**add_scope**](docs/DefaultApi.md#add_scope) | **POST** /api/2/api_authorizations/{id}/scopes | 
+*OneLogin::DefaultApi* | [**bulk_mapping_sort**](docs/DefaultApi.md#bulk_mapping_sort) | **PUT** /api/2/apps/mappings/sort | 
+*OneLogin::DefaultApi* | [**bulk_sort**](docs/DefaultApi.md#bulk_sort) | **PUT** /api/2/apps/{app_id}/rules/sort | 
+*OneLogin::DefaultApi* | [**create_app**](docs/DefaultApi.md#create_app) | **POST** /api/2/apps | 
+*OneLogin::DefaultApi* | [**create_authorization_server**](docs/DefaultApi.md#create_authorization_server) | **POST** /api/2/api_authorizations | 
+*OneLogin::DefaultApi* | [**create_environment_variable**](docs/DefaultApi.md#create_environment_variable) | **POST** /api/2/hooks/envs | 
+*OneLogin::DefaultApi* | [**create_hook**](docs/DefaultApi.md#create_hook) | **POST** /api/2/hooks | 
+*OneLogin::DefaultApi* | [**create_mapping**](docs/DefaultApi.md#create_mapping) | **POST** /api/2/mappings | 
+*OneLogin::DefaultApi* | [**create_risk_rule**](docs/DefaultApi.md#create_risk_rule) | **POST** /api/2/risk/rules | 
+*OneLogin::DefaultApi* | [**create_roles**](docs/DefaultApi.md#create_roles) | **POST** /api/2/roles | 
+*OneLogin::DefaultApi* | [**create_rule**](docs/DefaultApi.md#create_rule) | **POST** /api/2/apps/{app_id}/rules | 
+*OneLogin::DefaultApi* | [**create_user**](docs/DefaultApi.md#create_user) | **POST** /api/2/users | 
+*OneLogin::DefaultApi* | [**delete_access_token_claim**](docs/DefaultApi.md#delete_access_token_claim) | **DELETE** /api/2/api_authorizations/{id}/claims/{claim_id} | 
+*OneLogin::DefaultApi* | [**delete_app**](docs/DefaultApi.md#delete_app) | **DELETE** /api/2/apps/{app_id} | 
+*OneLogin::DefaultApi* | [**delete_app_parameter**](docs/DefaultApi.md#delete_app_parameter) | **DELETE** /api/2/apps/{app_id}/parameters/{parameter_id} | 
+*OneLogin::DefaultApi* | [**delete_authorization_server**](docs/DefaultApi.md#delete_authorization_server) | **DELETE** /api/2/api_authorizations/{id} | 
+*OneLogin::DefaultApi* | [**delete_environment_variable**](docs/DefaultApi.md#delete_environment_variable) | **DELETE** /api/2/hooks/envs/{envvar_id} | 
+*OneLogin::DefaultApi* | [**delete_factor**](docs/DefaultApi.md#delete_factor) | **DELETE** /api/2/mfa/users/{user_id}/devices/{device_id} | 
+*OneLogin::DefaultApi* | [**delete_hook**](docs/DefaultApi.md#delete_hook) | **DELETE** /api/2/hooks/{hook_id} | 
+*OneLogin::DefaultApi* | [**delete_mapping**](docs/DefaultApi.md#delete_mapping) | **DELETE** /api/2/mappings/{mapping_id} | 
+*OneLogin::DefaultApi* | [**delete_risk_rule**](docs/DefaultApi.md#delete_risk_rule) | **DELETE** /api/2/risk/rules/{risk_rule_id} | 
+*OneLogin::DefaultApi* | [**delete_role**](docs/DefaultApi.md#delete_role) | **DELETE** /api/2/roles/{role_id} | 
+*OneLogin::DefaultApi* | [**delete_rule**](docs/DefaultApi.md#delete_rule) | **DELETE** /api/2/apps/{app_id}/rules/{rule_id} | 
+*OneLogin::DefaultApi* | [**delete_scope**](docs/DefaultApi.md#delete_scope) | **DELETE** /api/2/api_authorizations/{id}/scopes/{scope_id} | 
+*OneLogin::DefaultApi* | [**delete_user**](docs/DefaultApi.md#delete_user) | **DELETE** /api/2/users/{user_id} | 
+*OneLogin::DefaultApi* | [**dry_run_mapping**](docs/DefaultApi.md#dry_run_mapping) | **POST** /api/2/mappings/{mapping_id}/dryrun | 
+*OneLogin::DefaultApi* | [**enroll_factor**](docs/DefaultApi.md#enroll_factor) | **POST** /api/2/mfa/users/{user_id}/registrations | 
+*OneLogin::DefaultApi* | [**generate_mfa_token**](docs/DefaultApi.md#generate_mfa_token) | **POST** /api/2/mfs/users/{user_id}/mfa_token | 
+*OneLogin::DefaultApi* | [**generate_saml_assertion**](docs/DefaultApi.md#generate_saml_assertion) | **POST** /api/2/saml_assertion | 
+*OneLogin::DefaultApi* | [**generate_token**](docs/DefaultApi.md#generate_token) | **POST** /auth/oauth2/v2/token | 
+*OneLogin::DefaultApi* | [**get_app**](docs/DefaultApi.md#get_app) | **GET** /api/2/apps/{app_id} | 
+*OneLogin::DefaultApi* | [**get_authorization_server**](docs/DefaultApi.md#get_authorization_server) | **GET** /api/2/api_authorizations/{id} | 
+*OneLogin::DefaultApi* | [**get_available_factors**](docs/DefaultApi.md#get_available_factors) | **GET** /api/2/mfa/users/{user_id}/factors | 
+*OneLogin::DefaultApi* | [**get_client_apps**](docs/DefaultApi.md#get_client_apps) | **GET** /api/2/api_authorizations/{id}/clients | 
+*OneLogin::DefaultApi* | [**get_enrolled_factors**](docs/DefaultApi.md#get_enrolled_factors) | **GET** /api/2/mfa/users/{user_id}/devices | 
+*OneLogin::DefaultApi* | [**get_environment_variable**](docs/DefaultApi.md#get_environment_variable) | **GET** /api/2/hooks/envs/{envvar_id} | 
+*OneLogin::DefaultApi* | [**get_hook**](docs/DefaultApi.md#get_hook) | **GET** /api/2/hooks/{hook_id} | 
+*OneLogin::DefaultApi* | [**get_logs**](docs/DefaultApi.md#get_logs) | **GET** /api/2/hooks/{hook_id}/logs | 
+*OneLogin::DefaultApi* | [**get_mapping**](docs/DefaultApi.md#get_mapping) | **GET** /api/2/mappings/{mapping_id} | 
+*OneLogin::DefaultApi* | [**get_rate_limit**](docs/DefaultApi.md#get_rate_limit) | **GET** /auth/rate_limit | 
+*OneLogin::DefaultApi* | [**get_risk_rule**](docs/DefaultApi.md#get_risk_rule) | **GET** /api/2/risk/rules/{risk_rule_id} | 
+*OneLogin::DefaultApi* | [**get_risk_score**](docs/DefaultApi.md#get_risk_score) | **POST** /api/2/risk/verify | 
+*OneLogin::DefaultApi* | [**get_role**](docs/DefaultApi.md#get_role) | **GET** /api/2/roles/{role_id} | 
+*OneLogin::DefaultApi* | [**get_role_admins**](docs/DefaultApi.md#get_role_admins) | **GET** /api/2/roles/{role_id}/admins | 
+*OneLogin::DefaultApi* | [**get_role_apps**](docs/DefaultApi.md#get_role_apps) | **GET** /api/2/roles/{role_id}/apps | 
+*OneLogin::DefaultApi* | [**get_role_users**](docs/DefaultApi.md#get_role_users) | **GET** /api/2/roles/{role_id}/users | 
+*OneLogin::DefaultApi* | [**get_rule**](docs/DefaultApi.md#get_rule) | **GET** /api/2/apps/{app_id}/rules/{rule_id} | 
+*OneLogin::DefaultApi* | [**get_score_insights**](docs/DefaultApi.md#get_score_insights) | **GET** /api/2/risk/scores | 
+*OneLogin::DefaultApi* | [**get_user**](docs/DefaultApi.md#get_user) | **GET** /api/2/users/{user_id} | 
+*OneLogin::DefaultApi* | [**get_user_apps**](docs/DefaultApi.md#get_user_apps) | **GET** /api/2/users/{user_id}/apps | 
+*OneLogin::DefaultApi* | [**list_access_token_claims**](docs/DefaultApi.md#list_access_token_claims) | **GET** /api/2/api_authorizations/{id}/claims | 
+*OneLogin::DefaultApi* | [**list_action_values**](docs/DefaultApi.md#list_action_values) | **GET** /api/2/apps/{app_id}/rules/actions/{actuion_value}/values | 
+*OneLogin::DefaultApi* | [**list_actions**](docs/DefaultApi.md#list_actions) | **GET** /api/2/apps/{app_id}/rules/actions | 
+*OneLogin::DefaultApi* | [**list_app_users**](docs/DefaultApi.md#list_app_users) | **GET** /api/2/apps/{app_id}/users | 
+*OneLogin::DefaultApi* | [**list_apps**](docs/DefaultApi.md#list_apps) | **GET** /api/2/apps | 
+*OneLogin::DefaultApi* | [**list_authorization_servers**](docs/DefaultApi.md#list_authorization_servers) | **GET** /api/2/api_authorizations | 
+*OneLogin::DefaultApi* | [**list_condition_operators**](docs/DefaultApi.md#list_condition_operators) | **GET** /api/2/apps/{app_id}/rules/conditions/{condition_value}/operators | 
+*OneLogin::DefaultApi* | [**list_condition_values**](docs/DefaultApi.md#list_condition_values) | **GET** /api/2/apps/{app_id}/rules/conditions/{condition_value}/values | 
+*OneLogin::DefaultApi* | [**list_conditions**](docs/DefaultApi.md#list_conditions) | **GET** /api/2/apps/{app_id}/rules/conditions | 
+*OneLogin::DefaultApi* | [**list_connectors**](docs/DefaultApi.md#list_connectors) | **GET** /api/2/connectors | 
+*OneLogin::DefaultApi* | [**list_environment_variables**](docs/DefaultApi.md#list_environment_variables) | **GET** /api/2/hooks/envs | 
+*OneLogin::DefaultApi* | [**list_hooks**](docs/DefaultApi.md#list_hooks) | **GET** /api/2/hooks | 
+*OneLogin::DefaultApi* | [**list_mapping_action_values**](docs/DefaultApi.md#list_mapping_action_values) | **GET** /api/2/apps/mappings/actions/{actuion_value}/values | 
+*OneLogin::DefaultApi* | [**list_mapping_actions**](docs/DefaultApi.md#list_mapping_actions) | **GET** /api/2/apps/mappings/actions | 
+*OneLogin::DefaultApi* | [**list_mapping_condition_operators**](docs/DefaultApi.md#list_mapping_condition_operators) | **GET** /api/2/apps/mappings/conditions/{condition_value}/operators | 
+*OneLogin::DefaultApi* | [**list_mapping_condition_values**](docs/DefaultApi.md#list_mapping_condition_values) | **GET** /api/2/apps/mappings/conditions/{condition_value}/values | 
+*OneLogin::DefaultApi* | [**list_mapping_conditions**](docs/DefaultApi.md#list_mapping_conditions) | **GET** /api/2/apps/mappings/conditions | 
+*OneLogin::DefaultApi* | [**list_mappings**](docs/DefaultApi.md#list_mappings) | **GET** /api/2/mappings | 
+*OneLogin::DefaultApi* | [**list_risk_rules**](docs/DefaultApi.md#list_risk_rules) | **GET** /api/2/risk/rules | 
+*OneLogin::DefaultApi* | [**list_roles**](docs/DefaultApi.md#list_roles) | **GET** /api/2/roles | 
+*OneLogin::DefaultApi* | [**list_rules**](docs/DefaultApi.md#list_rules) | **GET** /api/2/apps/{app_id}/rules | 
+*OneLogin::DefaultApi* | [**list_scopes**](docs/DefaultApi.md#list_scopes) | **GET** /api/2/api_authorizations/{id}/scopes | 
+*OneLogin::DefaultApi* | [**list_users**](docs/DefaultApi.md#list_users) | **GET** /api/2/users | 
+*OneLogin::DefaultApi* | [**remove_client_app**](docs/DefaultApi.md#remove_client_app) | **DELETE** /api/2/api_authorizations/{id}/clients/{client_app_id} | 
+*OneLogin::DefaultApi* | [**remove_role_admins**](docs/DefaultApi.md#remove_role_admins) | **DELETE** /api/2/roles/{role_id}/admins | 
+*OneLogin::DefaultApi* | [**remove_role_users**](docs/DefaultApi.md#remove_role_users) | **DELETE** /api/2/roles/{role_id}/users | 
+*OneLogin::DefaultApi* | [**revoke_token**](docs/DefaultApi.md#revoke_token) | **POST** /auth/oauth2/revoke | 
+*OneLogin::DefaultApi* | [**set_role_apps**](docs/DefaultApi.md#set_role_apps) | **PUT** /api/2/roles/{role_id}/apps | 
+*OneLogin::DefaultApi* | [**track_event**](docs/DefaultApi.md#track_event) | **POST** /api/2/risk/events | 
+*OneLogin::DefaultApi* | [**update_access_token_claim**](docs/DefaultApi.md#update_access_token_claim) | **PUT** /api/2/api_authorizations/{id}/claims/{claim_id} | 
+*OneLogin::DefaultApi* | [**update_app**](docs/DefaultApi.md#update_app) | **PUT** /api/2/apps/{app_id} | 
+*OneLogin::DefaultApi* | [**update_authorization_server**](docs/DefaultApi.md#update_authorization_server) | **PUT** /api/2/api_authorizations/{id} | 
+*OneLogin::DefaultApi* | [**update_client_app**](docs/DefaultApi.md#update_client_app) | **PUT** /api/2/api_authorizations/{id}/clients/{client_app_id} | 
+*OneLogin::DefaultApi* | [**update_environment_variable**](docs/DefaultApi.md#update_environment_variable) | **PUT** /api/2/hooks/envs/{envvar_id} | 
+*OneLogin::DefaultApi* | [**update_hook**](docs/DefaultApi.md#update_hook) | **PUT** /api/2/hooks/{hook_id} | 
+*OneLogin::DefaultApi* | [**update_mapping**](docs/DefaultApi.md#update_mapping) | **PUT** /api/2/mappings/{mapping_id} | 
+*OneLogin::DefaultApi* | [**update_risk_rule**](docs/DefaultApi.md#update_risk_rule) | **PUT** /api/2/risk/rules/{risk_rule_id} | 
+*OneLogin::DefaultApi* | [**update_role**](docs/DefaultApi.md#update_role) | **PUT** /api/2/roles/{role_id} | 
+*OneLogin::DefaultApi* | [**update_rule**](docs/DefaultApi.md#update_rule) | **PUT** /api/2/apps/{app_id}/rules/{rule_id} | 
+*OneLogin::DefaultApi* | [**update_scope**](docs/DefaultApi.md#update_scope) | **PUT** /api/2/api_authorizations/{id}/scopes/{scope_id} | 
+*OneLogin::DefaultApi* | [**update_user**](docs/DefaultApi.md#update_user) | **PUT** /api/2/users/{user_id} | 
+*OneLogin::DefaultApi* | [**verify_enrollment**](docs/DefaultApi.md#verify_enrollment) | **PUT** /api/2/mfa/users/{user_id}/registrations/{registration_id} | 
+*OneLogin::DefaultApi* | [**verify_enrollment_voice_protect**](docs/DefaultApi.md#verify_enrollment_voice_protect) | **GET** /api/2/mfa/users/{user_id}/registrations/{registration_id} | 
+*OneLogin::DefaultApi* | [**verify_factor**](docs/DefaultApi.md#verify_factor) | **PUT** /api/2/mfa/users/{user_id}/verifications/{verification_id} | 
+*OneLogin::DefaultApi* | [**verify_factor_saml**](docs/DefaultApi.md#verify_factor_saml) | **POST** /api/2/saml_assertion/verify_factor | 
+*OneLogin::DefaultApi* | [**verify_factor_voice**](docs/DefaultApi.md#verify_factor_voice) | **GET** /api/2/mfa/users/{user_id}/verifications/{verification_id} | 
+
+
+## Documentation for Models
+
+ - [OneLogin::Action](docs/Action.md)
+ - [OneLogin::ActivateFactorRequest](docs/ActivateFactorRequest.md)
+ - [OneLogin::AddAccessTokenClaimRequest](docs/AddAccessTokenClaimRequest.md)
+ - [OneLogin::AddClientAppRequest](docs/AddClientAppRequest.md)
+ - [OneLogin::AddRoleUsers200ResponseInner](docs/AddRoleUsers200ResponseInner.md)
+ - [OneLogin::AddScopeRequest](docs/AddScopeRequest.md)
+ - [OneLogin::AuthMethod](docs/AuthMethod.md)
+ - [OneLogin::AuthServerConfiguration](docs/AuthServerConfiguration.md)
+ - [OneLogin::ClientApp](docs/ClientApp.md)
+ - [OneLogin::Condition](docs/Condition.md)
+ - [OneLogin::Connector](docs/Connector.md)
+ - [OneLogin::CreateAuthorizationServerRequest](docs/CreateAuthorizationServerRequest.md)
+ - [OneLogin::CreateEnvironmentVariableRequest](docs/CreateEnvironmentVariableRequest.md)
+ - [OneLogin::CreateRoles201ResponseInner](docs/CreateRoles201ResponseInner.md)
+ - [OneLogin::Device](docs/Device.md)
+ - [OneLogin::EnrollFactorRequest](docs/EnrollFactorRequest.md)
+ - [OneLogin::Envvar](docs/Envvar.md)
+ - [OneLogin::ErrorStatus](docs/ErrorStatus.md)
+ - [OneLogin::ErrorStatusErrorsInner](docs/ErrorStatusErrorsInner.md)
+ - [OneLogin::FactorInner](docs/FactorInner.md)
+ - [OneLogin::FactorInnerFactorData](docs/FactorInnerFactorData.md)
+ - [OneLogin::GenerateMfaToken200Response](docs/GenerateMfaToken200Response.md)
+ - [OneLogin::GenerateMfaToken422Response](docs/GenerateMfaToken422Response.md)
+ - [OneLogin::GenerateMfaToken422ResponseDetails](docs/GenerateMfaToken422ResponseDetails.md)
+ - [OneLogin::GenerateMfaTokenRequest](docs/GenerateMfaTokenRequest.md)
+ - [OneLogin::GenerateSamlAssertionRequest](docs/GenerateSamlAssertionRequest.md)
+ - [OneLogin::GenerateToken200Response](docs/GenerateToken200Response.md)
+ - [OneLogin::GenerateToken400Response](docs/GenerateToken400Response.md)
+ - [OneLogin::GenerateTokenRequest](docs/GenerateTokenRequest.md)
+ - [OneLogin::GetAuthorizationServer200Response](docs/GetAuthorizationServer200Response.md)
+ - [OneLogin::GetAvailableFactors200ResponseInner](docs/GetAvailableFactors200ResponseInner.md)
+ - [OneLogin::GetClientApps200ResponseInner](docs/GetClientApps200ResponseInner.md)
+ - [OneLogin::GetClientApps200ResponseInnerScopesInner](docs/GetClientApps200ResponseInnerScopesInner.md)
+ - [OneLogin::GetRateLimit200Response](docs/GetRateLimit200Response.md)
+ - [OneLogin::GetRateLimit200ResponseData](docs/GetRateLimit200ResponseData.md)
+ - [OneLogin::GetRiskScore200Response](docs/GetRiskScore200Response.md)
+ - [OneLogin::GetRiskScore400Response](docs/GetRiskScore400Response.md)
+ - [OneLogin::GetRiskScoreRequest](docs/GetRiskScoreRequest.md)
+ - [OneLogin::GetScoreInsights200Response](docs/GetScoreInsights200Response.md)
+ - [OneLogin::GetScoreInsights200ResponseScores](docs/GetScoreInsights200ResponseScores.md)
+ - [OneLogin::GetUserApps200ResponseInner](docs/GetUserApps200ResponseInner.md)
+ - [OneLogin::Hook](docs/Hook.md)
+ - [OneLogin::HookConditionsInner](docs/HookConditionsInner.md)
+ - [OneLogin::HookOptions](docs/HookOptions.md)
+ - [OneLogin::HookStatus](docs/HookStatus.md)
+ - [OneLogin::Id](docs/Id.md)
+ - [OneLogin::ListAccessTokenClaims200ResponseInner](docs/ListAccessTokenClaims200ResponseInner.md)
+ - [OneLogin::ListActions200ResponseInner](docs/ListActions200ResponseInner.md)
+ - [OneLogin::ListAppUsers200ResponseInner](docs/ListAppUsers200ResponseInner.md)
+ - [OneLogin::ListAuthorizationServers200ResponseInner](docs/ListAuthorizationServers200ResponseInner.md)
+ - [OneLogin::ListAuthorizationServers200ResponseInnerConfiguration](docs/ListAuthorizationServers200ResponseInnerConfiguration.md)
+ - [OneLogin::ListConditionOperators200ResponseInner](docs/ListConditionOperators200ResponseInner.md)
+ - [OneLogin::ListConditionValues200ResponseInner](docs/ListConditionValues200ResponseInner.md)
+ - [OneLogin::ListConditions200ResponseInner](docs/ListConditions200ResponseInner.md)
+ - [OneLogin::ListMappingConditionOperators200ResponseInner](docs/ListMappingConditionOperators200ResponseInner.md)
+ - [OneLogin::ListMappingConditions200ResponseInner](docs/ListMappingConditions200ResponseInner.md)
+ - [OneLogin::ListScopes200ResponseInner](docs/ListScopes200ResponseInner.md)
+ - [OneLogin::Log](docs/Log.md)
+ - [OneLogin::Mapping](docs/Mapping.md)
+ - [OneLogin::Registration](docs/Registration.md)
+ - [OneLogin::RemoveRoleUsersRequest](docs/RemoveRoleUsersRequest.md)
+ - [OneLogin::RevokeTokenRequest](docs/RevokeTokenRequest.md)
+ - [OneLogin::RiskDevice](docs/RiskDevice.md)
+ - [OneLogin::RiskRule](docs/RiskRule.md)
+ - [OneLogin::RiskUser](docs/RiskUser.md)
+ - [OneLogin::Role](docs/Role.md)
+ - [OneLogin::Rule](docs/Rule.md)
+ - [OneLogin::RuleId](docs/RuleId.md)
+ - [OneLogin::Schema](docs/Schema.md)
+ - [OneLogin::Schema1](docs/Schema1.md)
+ - [OneLogin::Schema1AddedBy](docs/Schema1AddedBy.md)
+ - [OneLogin::SchemaProvisioning](docs/SchemaProvisioning.md)
+ - [OneLogin::Session](docs/Session.md)
+ - [OneLogin::SetRoleApps200ResponseInner](docs/SetRoleApps200ResponseInner.md)
+ - [OneLogin::Source](docs/Source.md)
+ - [OneLogin::Status](docs/Status.md)
+ - [OneLogin::Status1](docs/Status1.md)
+ - [OneLogin::Status2](docs/Status2.md)
+ - [OneLogin::Status2Status](docs/Status2Status.md)
+ - [OneLogin::TrackEventRequest](docs/TrackEventRequest.md)
+ - [OneLogin::UpdateAuthorizationServer400Response](docs/UpdateAuthorizationServer400Response.md)
+ - [OneLogin::UpdateClientAppRequest](docs/UpdateClientAppRequest.md)
+ - [OneLogin::UpdateEnvironmentVariableRequest](docs/UpdateEnvironmentVariableRequest.md)
+ - [OneLogin::UpdateRole200Response](docs/UpdateRole200Response.md)
+ - [OneLogin::User](docs/User.md)
+ - [OneLogin::VerifyEnrollmentRequest](docs/VerifyEnrollmentRequest.md)
+ - [OneLogin::VerifyFactorRequest](docs/VerifyFactorRequest.md)
+ - [OneLogin::VerifyFactorSaml200Response](docs/VerifyFactorSaml200Response.md)
+ - [OneLogin::VerifyFactorSamlRequest](docs/VerifyFactorSamlRequest.md)
+ - [OneLogin::VerifyFactorVoice200ResponseInner](docs/VerifyFactorVoice200ResponseInner.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
 
-Everyone interacting in the OneLogin Ruby Sdk project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/onelogin/onelogin-ruby-sdk/blob/master/CODE_OF_CONDUCT.md).