onelogin 1.8.0 → 3.0.0.pre.alpha.1

data/docs/Device.md

@@ -0,0 +1,26 @@
+# OneLogin::Device
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **device_id** | **String** |  | [optional] |
+| **user_display_name** | **String** |  | [optional] |
+| **type_display_name** | **String** |  | [optional] |
+| **auth_factor_name** | **String** |  | [optional] |
+| **default** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Device.new(
+  device_id: null,
+  user_display_name: null,
+  type_display_name: null,
+  auth_factor_name: null,
+  default: null
+)
+```
+

data/docs/EnrollFactorRequest.md

@@ -0,0 +1,28 @@
+# OneLogin::EnrollFactorRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **factor_id** | **Integer** | The identifier of the factor to enroll the user with. |  |
+| **display_name** | **String** | A name for the users device. |  |
+| **expires_in** | **String** | Defaults to 120. Valid values are: 120-900 seconds. | [optional] |
+| **verified** | **Boolean** | Defaults to false. | [optional] |
+| **redirect_to** | **String** | Redirects MagicLink success page to specified URL after 2 seconds. | [optional] |
+| **custom_message** | **String** | A message template that will be sent via SMS. Max length of the message after template items are inserted is 160 characters including the OTP code. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::EnrollFactorRequest.new(
+  factor_id: null,
+  display_name: null,
+  expires_in: null,
+  verified: null,
+  redirect_to: null,
+  custom_message: null
+)
+```
+

data/docs/Envvar.md

@@ -0,0 +1,24 @@
+# OneLogin::Envvar
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique identifier for the Hook Environment Variable | [optional] |
+| **name** | **String** | The name of the environment variable. | [optional] |
+| **created_at** | **String** | The ISO8601 formatted date that the environment variable was created. | [optional] |
+| **updated_at** | **String** | The ISO8601 formatted date that the environment variable was last updated. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Envvar.new(
+  id: null,
+  name: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/ErrorStatus.md

@@ -0,0 +1,22 @@
+# OneLogin::ErrorStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **errors** | [**Array<ErrorStatusErrorsInner>**](ErrorStatusErrorsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::ErrorStatus.new(
+  code: null,
+  message: null,
+  errors: null
+)
+```
+

data/docs/ErrorStatusErrorsInner.md

@@ -0,0 +1,20 @@
+# OneLogin::ErrorStatusErrorsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** |  | [optional] |
+| **message** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::ErrorStatusErrorsInner.new(
+  field: null,
+  message: null
+)
+```
+

data/docs/FactorInner.md

@@ -0,0 +1,32 @@
+# OneLogin::FactorInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | MFA device identifier. | [optional] |
+| **status** | **String** | accepted : factor has been verified. pending: registered but has not been verified. | [optional] |
+| **default** | **Boolean** | True = is user's default MFA device for OneLogin. | [optional] |
+| **auth_factor_name** | **String** | \"Official\" authentication factor name, as it appears to administrators in OneLogin. | [optional] |
+| **type_display_name** | **String** | Authentication factor display name as it appears to users upon initial registration, as defined by admins at Settings > Authentication Factors. | [optional] |
+| **user_display_name** | **String** | Authentication factor display name assigned by users when they enroll the device. | [optional] |
+| **expires_at** | **String** | A short lived token that is required to Verify the Factor. This token expires based on the expires_in parameter passed in. | [optional] |
+| **factor_data** | [**FactorInnerFactorData**](FactorInnerFactorData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::FactorInner.new(
+  id: null,
+  status: null,
+  default: null,
+  auth_factor_name: null,
+  type_display_name: null,
+  user_display_name: null,
+  expires_at: null,
+  factor_data: null
+)
+```
+

data/docs/FactorInnerFactorData.md

@@ -0,0 +1,20 @@
+# OneLogin::FactorInnerFactorData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verification_token** | **String** | The token which can be used to verify the factor registration. | [optional] |
+| **totp_url** | **String** | OTP Url that can be leveraged for any authenticator that supports the key uri format. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::FactorInnerFactorData.new(
+  verification_token: null,
+  totp_url: null
+)
+```
+

data/docs/GenerateMfaToken200Response.md

@@ -0,0 +1,24 @@
+# OneLogin::GenerateMfaToken200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mfa_token** | **String** | Token can function as a temporary MFA token. It can be used to authenticate for any app when valid. | [optional] |
+| **reusable** | **Boolean** | true indcates the token can be used multiple times. false indicates the token is invalid after a single use | [optional] |
+| **expires_at** | **String** | Defines the expiration time and date for the token. Format is UTC time. | [optional] |
+| **device_id** | **String** | Defines the expiration time and date for the token. Format is UTC time. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::GenerateMfaToken200Response.new(
+  mfa_token: null,
+  reusable: null,
+  expires_at: null,
+  device_id: null
+)
+```
+

data/docs/GenerateMfaToken422Response.md

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

data/docs/GenerateMfaToken422ResponseDetails.md

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

data/docs/GenerateMfaTokenRequest.md

@@ -0,0 +1,20 @@
+# OneLogin::GenerateMfaTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_in** | **String** | Set the duration of the token in seconds. | [optional] |
+| **reusable** | **Boolean** | Defines if the token is reusable multiple times within the expiry window. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::GenerateMfaTokenRequest.new(
+  expires_in: null,
+  reusable: null
+)
+```
+

data/docs/GenerateSamlAssertionRequest.md

@@ -0,0 +1,26 @@
+# OneLogin::GenerateSamlAssertionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username_or_email** | **String** | Set this to the username or email of the OneLogin user accessing the app for which you want to generate a SAML token. |  |
+| **password** | **String** | Password of the OneLogin user accessing the app for which you want to generate a SAML token. |  |
+| **app_id** | **String** | App ID of the app for which you want to generate a SAML token. This is the app ID in OneLogin. |  |
+| **subdomain** | **String** | Set to the subdomain of the OneLogin user accessing the app for which you want to generate a SAML token. |  |
+| **ip_address** | **String** | Whitelisted IP address, if MFA is required and you need to honor IP address whitelisting defined in MFA policies. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::GenerateSamlAssertionRequest.new(
+  username_or_email: null,
+  password: null,
+  app_id: null,
+  subdomain: null,
+  ip_address: null
+)
+```
+

data/docs/GenerateToken200Response.md

@@ -0,0 +1,28 @@
+# OneLogin::GenerateToken200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **expires_in** | **Integer** |  | [optional] |
+| **refresh_token** | **String** |  | [optional] |
+| **token_type** | **String** |  | [optional] |
+| **accountt_id** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::GenerateToken200Response.new(
+  access_token: null,
+  created_at: null,
+  expires_in: null,
+  refresh_token: null,
+  token_type: null,
+  accountt_id: null
+)
+```
+

data/docs/GenerateToken400Response.md

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

data/docs/GenerateTokenRequest.md

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

data/docs/GetAuthorizationServer200Response.md

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

data/docs/GetAvailableFactors200ResponseInner.md

@@ -0,0 +1,22 @@
+# OneLogin::GetAvailableFactors200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **factor_id** | **Integer** | Identifier for the factor which will be used for user enrollment | [optional] |
+| **name** | **String** | Authentication factor name, as it appears to administrators in OneLogin. | [optional] |
+| **auth_factor_name** | **String** | Internal use only | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::GetAvailableFactors200ResponseInner.new(
+  factor_id: null,
+  name: null,
+  auth_factor_name: null
+)
+```
+

data/docs/GetClientApps200ResponseInner.md

@@ -0,0 +1,24 @@
+# OneLogin::GetClientApps200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **scopes** | [**Array<GetClientApps200ResponseInnerScopesInner>**](GetClientApps200ResponseInnerScopesInner.md) |  | [optional] |
+| **app_id** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **api_auth_id** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::GetClientApps200ResponseInner.new(
+  scopes: null,
+  app_id: null,
+  name: null,
+  api_auth_id: null
+)
+```
+

data/docs/GetClientApps200ResponseInnerScopesInner.md

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

data/docs/GetRateLimit200Response.md

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

data/docs/GetRateLimit200ResponseData.md

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

data/docs/GetRiskScore200Response.md

@@ -0,0 +1,20 @@
+# OneLogin::GetRiskScore200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **score** | **Float** | A risk score 0 is low risk and 100 is the highest risk level possible. | [optional] |
+| **triggers** | **Array<String>** | Triggers are indicators of some of the key items that influenced the risk score. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::GetRiskScore200Response.new(
+  score: null,
+  triggers: null
+)
+```
+

data/docs/GetRiskScore400Response.md

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

data/docs/GetRiskScoreRequest.md

@@ -0,0 +1,30 @@
+# OneLogin::GetRiskScoreRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::GetRiskScoreRequest.new(
+  ip: null,
+  user_agent: null,
+  user: null,
+  source: null,
+  session: null,
+  device: null,
+  fp: null
+)
+```
+

data/docs/GetScoreInsights200Response.md

@@ -0,0 +1,20 @@
+# OneLogin::GetScoreInsights200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **scores** | [**GetScoreInsights200ResponseScores**](GetScoreInsights200ResponseScores.md) |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::GetScoreInsights200Response.new(
+  scores: null,
+  total: null
+)
+```
+

data/docs/GetScoreInsights200ResponseScores.md

@@ -0,0 +1,26 @@
+# OneLogin::GetScoreInsights200ResponseScores
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **minimal** | **Integer** |  | [optional] |
+| **low** | **Integer** |  | [optional] |
+| **medium** | **Integer** |  | [optional] |
+| **high** | **Integer** |  | [optional] |
+| **very_high** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::GetScoreInsights200ResponseScores.new(
+  minimal: null,
+  low: null,
+  medium: null,
+  high: null,
+  very_high: null
+)
+```
+

data/docs/GetUserApps200ResponseInner.md

@@ -0,0 +1,32 @@
+# OneLogin::GetUserApps200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The App ID | [optional] |
+| **icon_url** | **String** | A url for the icon that represents the app in the OneLogin portal | [optional] |
+| **extension** | **Boolean** | Boolean that indicates if the OneLogin browser extension is required to launch this app. | [optional] |
+| **login_id** | **Integer** | Unqiue identifier for this user and app combination. | [optional] |
+| **name** | **String** | The name of the app. | [optional] |
+| **provisioning_status** | **String** |  | [optional] |
+| **provisioning_state** | **String** | If provisioning is enabled this indicates the state of provisioning for the given user. | [optional] |
+| **provisioning_enabled** | **Boolean** | Indicates if provisioning is enabled for this app. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::GetUserApps200ResponseInner.new(
+  id: null,
+  icon_url: null,
+  extension: null,
+  login_id: null,
+  name: null,
+  provisioning_status: null,
+  provisioning_state: null,
+  provisioning_enabled: null
+)
+```
+