onelogin 1.6.0 → 3.0.0.pre.alpha.1

data/docs/Schema.md

@@ -0,0 +1,56 @@
+# OneLogin::Schema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Apps unique ID in OneLogin. | [optional] |
+| **connector_id** | **Integer** | ID of the apps underlying connector. | [optional] |
+| **name** | **String** | App name. | [optional] |
+| **description** | **String** | Freeform description of the app. | [optional] |
+| **notes** | **String** | Freeform notes about the app. | [optional] |
+| **policy_id** | **Integer** | The security policy assigned to the app. | [optional] |
+| **brand_id** | **Integer** | The custom login page branding to use for this app. Applies to app initiated logins via OIDC or SAML. | [optional] |
+| **icon_url** | **String** | A link to the apps icon url. | [optional] |
+| **visible** | **Boolean** | Indicates if the app is visible in the OneLogin portal. | [optional] |
+| **auth_method** | **Integer** | An ID indicating the type of app. | [optional] |
+| **tab_id** | **Integer** | ID of the OneLogin portal tab that the app is assigned to. | [optional] |
+| **created_at** | **String** | The date the app was created. | [optional] |
+| **updated_at** | **String** | The date the app was last updated. | [optional] |
+| **role_ids** | **Array<Integer>** | List of Role IDs that are assigned to the app. On App Create or Update the entire array is replaced with the values provided. | [optional] |
+| **allow_assumed_signin** | **Boolean** | Indicates whether or not administrators can access the app as a user that they have assumed control over. | [optional] |
+| **provisioning** | [**SchemaProvisioning**](SchemaProvisioning.md) |  | [optional] |
+| **sso** | **Object** |  | [optional] |
+| **configuration** | **Object** |  | [optional] |
+| **parameters** | **Object** |  | [optional] |
+| **enforcement_point** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Schema.new(
+  id: null,
+  connector_id: null,
+  name: null,
+  description: null,
+  notes: null,
+  policy_id: null,
+  brand_id: null,
+  icon_url: null,
+  visible: null,
+  auth_method: null,
+  tab_id: null,
+  created_at: null,
+  updated_at: null,
+  role_ids: null,
+  allow_assumed_signin: null,
+  provisioning: null,
+  sso: null,
+  configuration: null,
+  parameters: null,
+  enforcement_point: null
+)
+```
+

data/docs/Schema1.md

@@ -0,0 +1,28 @@
+# OneLogin::Schema1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **username** | **String** |  | [optional] |
+| **added_by** | [**Schema1AddedBy**](Schema1AddedBy.md) |  | [optional] |
+| **added_at** | **String** |  | [optional] |
+| **assigned** | **Boolean** | Indicates if assigned to role or not. Defaults to true. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Schema1.new(
+  id: null,
+  name: null,
+  username: null,
+  added_by: null,
+  added_at: null,
+  assigned: null
+)
+```
+

data/docs/Schema1AddedBy.md

@@ -0,0 +1,20 @@
+# OneLogin::Schema1AddedBy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Schema1AddedBy.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/SchemaProvisioning.md

@@ -0,0 +1,18 @@
+# OneLogin::SchemaProvisioning
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** | Indicates if provisioning is enabled for this app. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::SchemaProvisioning.new(
+  enabled: null
+)
+```
+

data/docs/Session.md

@@ -0,0 +1,18 @@
+# OneLogin::Session
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | If you use a database to track sessions, you can send us the session ID. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Session.new(
+  id: null
+)
+```
+

data/docs/SetRoleApps200ResponseInner.md

@@ -0,0 +1,18 @@
+# OneLogin::SetRoleApps200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Apps unique ID in OneLogin. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::SetRoleApps200ResponseInner.new(
+  id: null
+)
+```
+

data/docs/Source.md

@@ -0,0 +1,20 @@
+# OneLogin::Source
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** | The name of the source | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Source.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/Status.md

@@ -0,0 +1,24 @@
+# OneLogin::Status
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **Boolean** |  | [optional] |
+| **code** | **Integer** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Status.new(
+  error: null,
+  code: null,
+  type: null,
+  message: null
+)
+```
+

data/docs/Status1.md

@@ -0,0 +1,22 @@
+# OneLogin::Status1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **status_code** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Status1.new(
+  message: null,
+  status_code: null,
+  name: null
+)
+```
+

data/docs/Status2.md

@@ -0,0 +1,18 @@
+# OneLogin::Status2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | [**Status2Status**](Status2Status.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Status2.new(
+  status: null
+)
+```
+

data/docs/Status2Status.md

@@ -0,0 +1,24 @@
+# OneLogin::Status2Status
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **code** | **Integer** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **error** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Status2Status.new(
+  type: null,
+  code: null,
+  message: null,
+  error: null
+)
+```
+

data/docs/TrackEventRequest.md

@@ -0,0 +1,34 @@
+# OneLogin::TrackEventRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verb** | **String** | Verbs are used to distinguish between different types of events. |  |
+| **ip** | **String** | The IP address of the User's request. |  |
+| **user_agent** | **String** | The user agent of the User's request. |  |
+| **user** | [**RiskUser**](RiskUser.md) |  |  |
+| **source** | [**Source**](Source.md) |  | [optional] |
+| **session** | [**Session**](Session.md) |  | [optional] |
+| **device** | [**RiskDevice**](RiskDevice.md) |  | [optional] |
+| **fp** | **String** | Set to the value of the __tdli_fp cookie. | [optional] |
+| **published** | **String** | Date and time of the event in IS08601 format. Useful for preloading old events. Defaults to date time this API request is received. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::TrackEventRequest.new(
+  verb: null,
+  ip: null,
+  user_agent: null,
+  user: null,
+  source: null,
+  session: null,
+  device: null,
+  fp: null,
+  published: null
+)
+```
+

data/docs/UpdateAuthorizationServer400Response.md

@@ -0,0 +1,24 @@
+# OneLogin::UpdateAuthorizationServer400Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **status_code** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::UpdateAuthorizationServer400Response.new(
+  field: null,
+  message: null,
+  status_code: null,
+  name: null
+)
+```
+

data/docs/UpdateClientAppRequest.md

@@ -0,0 +1,18 @@
+# OneLogin::UpdateClientAppRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **scopes** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::UpdateClientAppRequest.new(
+  scopes: null
+)
+```
+

data/docs/UpdateEnvironmentVariableRequest.md

@@ -0,0 +1,18 @@
+# OneLogin::UpdateEnvironmentVariableRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** | The secret value that will be encrypted at rest and injected in applicable hook functions at run time. |  |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::UpdateEnvironmentVariableRequest.new(
+  value: null
+)
+```
+

data/docs/UpdateRole200Response.md

@@ -0,0 +1,18 @@
+# OneLogin::UpdateRole200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::UpdateRole200Response.new(
+  id: null
+)
+```
+

data/docs/User.md

@@ -0,0 +1,90 @@
+# OneLogin::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **username** | **String** | A username for the user. | [optional] |
+| **email** | **String** | A valid email for the user. | [optional] |
+| **firstname** | **String** | The user's first name. | [optional] |
+| **lastname** | **String** | The user's last name. | [optional] |
+| **title** | **String** | The user's job title. | [optional] |
+| **department** | **String** | The user's department. | [optional] |
+| **company** | **String** | The user's company. | [optional] |
+| **comment** | **String** | Free text related to the user. | [optional] |
+| **group_id** | **Integer** | The ID of the Group in OneLogin that the user is assigned to. | [optional] |
+| **role_ids** | **Array<Integer>** | A list of OneLogin Role IDs of the user | [optional] |
+| **phone** | **String** | The E.164 format phone number for a user. | [optional] |
+| **state** | **Integer** |  | [optional] |
+| **status** | **Integer** |  | [optional] |
+| **directory_id** | **Integer** | The ID of the OneLogin Directory of the user. | [optional] |
+| **trusted_idp_id** | **Integer** | The ID of the OneLogin Trusted IDP of the user. | [optional] |
+| **manager_ad_id** | **String** | The ID of the user's manager in Active Directory. | [optional] |
+| **manager_user_id** | **String** | The OneLogin User ID for the user's manager. | [optional] |
+| **samaccount_name** | **String** | The user's Active Directory username. | [optional] |
+| **member_of** | **String** | The user's directory membership. | [optional] |
+| **userprincipalname** | **String** | The principle name of the user. | [optional] |
+| **distinguished_name** | **String** | The distinguished name of the user. | [optional] |
+| **external_id** | **String** | The ID of the user in an external directory. | [optional] |
+| **activated_at** | **String** |  | [optional] |
+| **last_login** | **String** |  | [optional] |
+| **invitation_sent_at** | **String** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
+| **preferred_locale_code** | **String** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **custom_attributes** | **Object** |  | [optional] |
+| **invalid_login_attempts** | **Integer** |  | [optional] |
+| **locked_until** | **String** |  | [optional] |
+| **password_changed_at** | **String** |  | [optional] |
+| **password** | **String** | The password to set for a user. | [optional] |
+| **password_confirmation** | **String** | Required if the password is being set. | [optional] |
+| **password_algorithm** | **String** | Use this when importing a password that's already hashed. Prepend the salt value to the cleartext password value before SHA-256-encoding it | [optional] |
+| **salt** | **String** | The salt value used with the password_algorithm. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::User.new(
+  id: null,
+  username: null,
+  email: null,
+  firstname: null,
+  lastname: null,
+  title: null,
+  department: null,
+  company: null,
+  comment: null,
+  group_id: null,
+  role_ids: null,
+  phone: null,
+  state: null,
+  status: null,
+  directory_id: null,
+  trusted_idp_id: null,
+  manager_ad_id: null,
+  manager_user_id: null,
+  samaccount_name: null,
+  member_of: null,
+  userprincipalname: null,
+  distinguished_name: null,
+  external_id: null,
+  activated_at: null,
+  last_login: null,
+  invitation_sent_at: null,
+  updated_at: null,
+  preferred_locale_code: null,
+  created_at: null,
+  custom_attributes: null,
+  invalid_login_attempts: null,
+  locked_until: null,
+  password_changed_at: null,
+  password: null,
+  password_confirmation: null,
+  password_algorithm: null,
+  salt: null
+)
+```
+

data/docs/VerifyEnrollmentRequest.md

@@ -0,0 +1,18 @@
+# OneLogin::VerifyEnrollmentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **otp** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::VerifyEnrollmentRequest.new(
+  otp: null
+)
+```
+

data/docs/VerifyFactorRequest.md

@@ -0,0 +1,20 @@
+# OneLogin::VerifyFactorRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **otp** | **String** | OTP code provided by the device or SMS message sent to user. | [optional] |
+| **device_id** | **Integer** | ID of the specified device which has been registerd for the given user. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::VerifyFactorRequest.new(
+  otp: null,
+  device_id: null
+)
+```
+

data/docs/VerifyFactorSaml200Response.md

@@ -0,0 +1,20 @@
+# OneLogin::VerifyFactorSaml200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **String** | Provides the SAML assertion. | [optional] |
+| **message** | **String** | Plain text description describing the outcome of the response. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::VerifyFactorSaml200Response.new(
+  data: null,
+  message: null
+)
+```
+

data/docs/VerifyFactorSamlRequest.md

@@ -0,0 +1,26 @@
+# OneLogin::VerifyFactorSamlRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID of the app for which you want to generate a SAML token. This is the app ID in OneLogin. |  |
+| **device_id** | **String** | Provide the MFA device_id you are submitting for verification. The device_id is supplied by the Generate SAML Assertion API. |  |
+| **state_token** | **String** | state_token associated with the MFA device_id you are submitting. The state_token is supplied by the Generate SAML Assertion API. |  |
+| **otp_token** | **String** | Provide the OTP value for the MFA factor you are submitting for verification. | [optional] |
+| **do_not_notify** | **Boolean** | When verifying MFA via Protect Push, set this to true to stop additional push notifications being sent to the OneLogin Protect device. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::VerifyFactorSamlRequest.new(
+  app_id: null,
+  device_id: null,
+  state_token: null,
+  otp_token: null,
+  do_not_notify: null
+)
+```
+

data/docs/VerifyFactorVoice200ResponseInner.md

@@ -0,0 +1,22 @@
+# OneLogin::VerifyFactorVoice200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **device_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::VerifyFactorVoice200ResponseInner.new(
+  id: null,
+  status: null,
+  device_id: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="onelogin"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="onelogin-ruby-sdk"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'