onelogin 1.8.0 → 3.0.0.pre.alpha.1

data/docs/Hook.md

@@ -0,0 +1,46 @@
+# OneLogin::Hook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Hook unique ID in OneLogin. | [optional] |
+| **type** | **String** | A string describing the type of hook. e.g. `pre-authentication` |  |
+| **disabled** | **Boolean** | Boolean to enable or disable the hook. Disabled hooks will not run. | [default to true] |
+| **timeout** | **Integer** | The number of seconds to allow the hook function to run before before timing out. Maximum timeout varies based on the type of hook. | [default to 1] |
+| **env_vars** | **Array<String>** | Environment Variable objects that will be available via process.env.ENV_VAR_NAME in the hook code. |  |
+| **runtime** | **String** | The Smart Hooks supported Node.js version to execute this hook with. |  |
+| **retries** | **Integer** | Number of retries if execution fails. | [default to 0] |
+| **packages** | **Object** | An object containing NPM packages that are bundled with the hook function. |  |
+| **function** | **String** | A base64 encoded string containing the javascript function code. |  |
+| **context_version** | **String** | The semantic version of the content that will be injected into this hook. | [optional] |
+| **status** | **String** | String describing the state of the hook function. When a hook is ready and disabled is false it will be executed. | [optional] |
+| **options** | [**HookOptions**](HookOptions.md) |  | [optional] |
+| **conditions** | [**Array<HookConditionsInner>**](HookConditionsInner.md) | An array of objects that let you limit the execution of a hook to users in specific roles. | [optional] |
+| **created_at** | **String** | ISO8601 format date that they hook function was created. | [optional] |
+| **updated_at** | **String** | ISO8601 format date that they hook function was last updated. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Hook.new(
+  id: null,
+  type: null,
+  disabled: null,
+  timeout: null,
+  env_vars: null,
+  runtime: null,
+  retries: null,
+  packages: null,
+  function: null,
+  context_version: null,
+  status: null,
+  options: null,
+  conditions: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/HookConditionsInner.md

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

data/docs/HookOptions.md

@@ -0,0 +1,22 @@
+# OneLogin::HookOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **risk_enabled** | **Boolean** |  | [optional] |
+| **location_enabled** | **Boolean** |  | [optional] |
+| **mfa_device_info_enabled** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::HookOptions.new(
+  risk_enabled: null,
+  location_enabled: null,
+  mfa_device_info_enabled: null
+)
+```
+

data/docs/HookStatus.md

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

data/docs/Id.md

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

data/docs/ListAccessTokenClaims200ResponseInner.md

@@ -0,0 +1,34 @@
+# OneLogin::ListAccessTokenClaims200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **label** | **String** |  | [optional] |
+| **user_attribute_mappings** | **String** |  | [optional] |
+| **user_attribute_macros** | **String** |  | [optional] |
+| **attributes_transformations** | **String** |  | [optional] |
+| **skip_if_blank** | **Boolean** |  | [optional] |
+| **values** | **Array<String>** |  | [optional] |
+| **default_values** | **String** |  | [optional] |
+| **provisioned_entitlements** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::ListAccessTokenClaims200ResponseInner.new(
+  id: null,
+  label: null,
+  user_attribute_mappings: null,
+  user_attribute_macros: null,
+  attributes_transformations: null,
+  skip_if_blank: null,
+  values: null,
+  default_values: null,
+  provisioned_entitlements: null
+)
+```
+

data/docs/ListActions200ResponseInner.md

@@ -0,0 +1,20 @@
+# OneLogin::ListActions200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the Action. | [optional] |
+| **value** | **String** | The unique identifier of the action. This should be used when defining actions for a User Mapping. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::ListActions200ResponseInner.new(
+  name: null,
+  value: null
+)
+```
+

data/docs/ListAppUsers200ResponseInner.md

@@ -0,0 +1,26 @@
+# OneLogin::ListAppUsers200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **firstname** | **String** |  | [optional] |
+| **id** | **Integer** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **lastname** | **String** |  | [optional] |
+| **username** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::ListAppUsers200ResponseInner.new(
+  firstname: null,
+  id: null,
+  email: null,
+  lastname: null,
+  username: null
+)
+```
+

data/docs/ListAuthorizationServers200ResponseInner.md

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

data/docs/ListAuthorizationServers200ResponseInnerConfiguration.md

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

data/docs/ListConditionOperators200ResponseInner.md

@@ -0,0 +1,20 @@
+# OneLogin::ListConditionOperators200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name or description of the operator. | [optional] |
+| **value** | **String** | The condition operator value to use when creating or updating App Rules. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::ListConditionOperators200ResponseInner.new(
+  name: null,
+  value: null
+)
+```
+

data/docs/ListConditionValues200ResponseInner.md

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

data/docs/ListConditions200ResponseInner.md

@@ -0,0 +1,20 @@
+# OneLogin::ListConditions200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the Condition. | [optional] |
+| **value** | **String** | The unique identifier of the condition. This should be used when defining conditions for a rule. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::ListConditions200ResponseInner.new(
+  name: null,
+  value: null
+)
+```
+

data/docs/ListMappingConditionOperators200ResponseInner.md

@@ -0,0 +1,20 @@
+# OneLogin::ListMappingConditionOperators200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name or description of the operator. | [optional] |
+| **value** | **String** | The condition operator value to use when creating or updating User Mappings. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::ListMappingConditionOperators200ResponseInner.new(
+  name: null,
+  value: null
+)
+```
+

data/docs/ListMappingConditions200ResponseInner.md

@@ -0,0 +1,20 @@
+# OneLogin::ListMappingConditions200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the Condition. | [optional] |
+| **value** | **String** | The unique identifier of the condition. This should be used when defining conditions for a User Mapping. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::ListMappingConditions200ResponseInner.new(
+  name: null,
+  value: null
+)
+```
+

data/docs/ListScopes200ResponseInner.md

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

data/docs/Log.md

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

data/docs/Mapping.md

@@ -0,0 +1,30 @@
+# OneLogin::Mapping
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **name** | **String** | The name of the mapping. |  |
+| **enabled** | **Boolean** | Indicates if the mapping is enabled or not. |  |
+| **match** | **String** | Indicates how conditions should be matched. |  |
+| **position** | **Integer** | Indicates the order of the mapping. When `null` this will default to last position. |  |
+| **conditions** | [**Array<Condition>**](Condition.md) | An array of conditions that the user must meet in order for the mapping to be applied. | [optional] |
+| **actions** | [**Array<Action>**](Action.md) | An array of actions that will be applied to the users that are matched by the conditions. |  |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Mapping.new(
+  id: null,
+  name: null,
+  enabled: null,
+  match: null,
+  position: null,
+  conditions: null,
+  actions: null
+)
+```
+

data/docs/Registration.md

@@ -0,0 +1,22 @@
+# OneLogin::Registration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Registration identifier. | [optional] |
+| **status** | **String** | pending registration has not been completed successfully. accepted registration has successfully completed. | [optional] |
+| **device_id** | **String** | Device id to be used with Verify the Factor. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Registration.new(
+  id: null,
+  status: null,
+  device_id: null
+)
+```
+

data/docs/RemoveRoleUsersRequest.md

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

data/docs/RevokeTokenRequest.md

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

data/docs/RiskDevice.md

@@ -0,0 +1,18 @@
+# OneLogin::RiskDevice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | This device's unique identifier | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::RiskDevice.new(
+  id: null
+)
+```
+

data/docs/RiskRule.md

@@ -0,0 +1,30 @@
+# OneLogin::RiskRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** | The name of this rule | [optional] |
+| **description** | **String** |  | [optional] |
+| **type** | **String** | The type parameter specifies the type of rule that will be created. | [optional] |
+| **target** | **String** | The target parameter that will be used when evaluating the rule against an incoming event. | [optional] |
+| **filters** | **Array<String>** | A list of IP addresses or country codes or names to evaluate against each event. | [optional] |
+| **source** | [**Source**](Source.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::RiskRule.new(
+  id: null,
+  name: null,
+  description: null,
+  type: null,
+  target: null,
+  filters: null,
+  source: null
+)
+```
+

data/docs/RiskUser.md

@@ -0,0 +1,22 @@
+# OneLogin::RiskUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique identifier for the user. |  |
+| **name** | **String** | A name for the user. | [optional] |
+| **authenticated** | **Boolean** | Indicates if the metadata supplied in this event should be considered as trusted for the user. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::RiskUser.new(
+  id: null,
+  name: null,
+  authenticated: null
+)
+```
+

data/docs/Role.md

@@ -0,0 +1,26 @@
+# OneLogin::Role
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **name** | **String** |  |  |
+| **apps** | **Array<Integer>** |  | [optional] |
+| **users** | **Array<Integer>** |  | [optional] |
+| **admins** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Role.new(
+  id: null,
+  name: null,
+  apps: null,
+  users: null,
+  admins: null
+)
+```
+

data/docs/Rule.md

@@ -0,0 +1,30 @@
+# OneLogin::Rule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **name** | **String** | The name of the rule. | [optional] |
+| **match** | **String** | Indicates how conditions should be matched. | [optional] |
+| **enabled** | **Boolean** | Indicates if the rule is enabled or not. | [optional] |
+| **position** | **Integer** | Indicates the order of the rule. When `null` this will default to last position. | [optional] |
+| **conditions** | [**Array<Condition>**](Condition.md) | An array of conditions that the user must meet in order for the rule to be applied. | [optional] |
+| **actions** | [**Array<Action>**](Action.md) | An array of actions that will be applied to the users that are matched by the conditions. | [optional] |
+
+## Example
+
+```ruby
+require 'onelogin'
+
+instance = OneLogin::Rule.new(
+  id: null,
+  name: null,
+  match: null,
+  enabled: null,
+  position: null,
+  conditions: null,
+  actions: null
+)
+```
+

data/docs/RuleId.md

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