ResourceRuleParms
Parameters defining the new resource rule including the resource to which it applies.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| DateTimeContext | DateTimeContext | [optional] | |
| Description | string | The description of the resource rule. | [optional] |
| DeviceCertificateContext | DeviceCertificateContext | [optional] | |
| DisableSSO | bool? | A flag indicating if single-sign on is disabled for this resource rule. | [optional] |
| Enabled | bool? | A flag indicating if this resource rule is enabled or not. Only enabled resource rules are considered during authentication. | [optional] |
| GroupIds | List<string> | The UUIDs of groups associated with this resource rule. The resource rule will only apply to users in one of the specified groups. When creating a resource rule, if no groupsIds are specified, the resource rule will apply to all users. | [optional] |
| Groups | List<Group> | The groups associated with this resource rule. The resource rule only applies to users in one of the specified groups. If no groups are specified, the resource rule applies to all users. This attribute is ignored if the groupIds attribute is specified. The groupIds attribute should be used instead. | [optional] |
| HighRiskAuthenticationFlow | string | The UUID of the authentication flow to use when the risk score is High. Required with v2 APIs. | [optional] |
| HighRiskEnableSmartLogin | bool? | A flag indicating if Smart Login is enabled for High risk.This parameter is deprecated, use the highRiskAuthenticationFlow attribute with v2 APIs. | [optional] |
| HighRiskFirstStep | string | The authenticator type to use in the first step of a two-step authentication scenario when the risk score is High. Only the values NONE, EXTERNAL, PASSWORD or DENY should be used for highRiskFirstStep. Other values are defined for backwards compatibility. Some values are not supported by all application types.This parameter is deprecated, use the highRiskAuthenticationFlow attribute with v2 APIs. | [optional] |
| HighRiskSecondStep | List<ResourceRuleParms.HighRiskSecondStepEnum> | The authenticator type to use during in the second step of a two-step authentication scenario when the risk score is High. Some values are not supported by all application types.This parameter is deprecated, use the highRiskAuthenticationFlow attribute with v2 APIs. | [optional] |
| IpContext | IpContext | [optional] | |
| KbaContext | KbaContext | [optional] | |
| LocationContext | LocationContext | [optional] | |
| LocationHistoryContext | LocationHistoryContext | [optional] | |
| LowRiskAuthenticationFlow | string | The UUID of the authentication flow to use when the risk score is Low. Required with v2 APIs. | [optional] |
| LowRiskEnableSmartLogin | bool? | A flag indicating if Smart Login is enabled for Low risk.This parameter is deprecated, use the lowhRiskAuthenticationFlow attribute with v2 APIs. | [optional] |
| LowRiskFirstStep | string | The authenticator type to use in the first step of a two-step authentication scenario when the risk score is Low. Only the values NONE, EXTERNAL, PASSWORD should be used for lowRiskFirstStep. The value DENY can only be specified for low risk authentication when using Smart Login, otherwise DENY can only be specified for medium or high risk values. Other values are defined for backwards compatibility. Some values are not supported by all application types. This parameter is deprecated, use the lowRiskAuthenticationFlow attribute with v2 APIs. | [optional] |
| LowRiskSecondStep | List<ResourceRuleParms.LowRiskSecondStepEnum> | The authenticator type to use during in the second step of a two-step authentication scenario when the risk score is Low. Some values are not supported by all application types. This parameter is deprecated, use the lowRiskAuthenticationFlow attribute with v2 APIs. | [optional] |
| LowRiskThreshold | int? | Risk scores below this value are considered Low risk. | [optional] |
| MachineContext | MachineContext | [optional] | |
| MediumRiskAuthenticationFlow | string | The UUID of the authentication flow to use when the risk score is Medium. Required with v2 APIs. | [optional] |
| MediumRiskEnableSmartLogin | bool? | A flag indicating if Smart Login is enabled for Medium risk.This parameter is deprecated, use the mediumRiskAuthenticationFlow attribute with v2 APIs. | [optional] |
| MediumRiskFirstStep | string | The authenticator type to use in the first step of a two-step authentication scenario when the risk score is Medium. Only the values NONE, EXTERNAL, PASSWORD or DENY should be used for mediumRiskFirstStep. Other values are defined for backwards compatibility. Some values are not supported by all application types. This parameter is deprecated, use the mediumRiskAuthenticationFlow attribute with v2 APIs. | [optional] |
| MediumRiskSecondStep | List<ResourceRuleParms.MediumRiskSecondStepEnum> | The authenticator type to use during in the second step of a two-step authentication scenario when the risk score is Medium. Some values are not supported by all application types.This parameter is deprecated, use the mediumRiskAuthenticationFlow attribute with v2 APIs. | [optional] |
| MediumRiskThreshold | int? | Risk scores below this value are considered Medium risk. Risk scores equal or greater than this value are considered High risk. | [optional] |
| Name | string | The name of the resource rule. | [optional] |
| RemoveDateTimeContext | bool? | When updating a resource rule, if removeDateTimeContext is set to true, the existing date time context is removed. This attribute is ignored when creating a resource rule. | [optional] |
| RemoveDeviceCertificateContext | bool? | When updating a resource rule, if removeDeviceCertificateContext is set to true, the existing device certificate context is removed. This attribute is ignored when creating a resource rule. | [optional] |
| RemoveIPContext | bool? | When updating a resource rule, if removeIPContext is set to true, the existing IP context is removed. This attribute is ignored when creating a resource rule. | [optional] |
| RemoveKBAContext | bool? | When updating a resource rule, if removeKBAContext is set to true, the existing KBA context is removed. This attribute is ignored when creating a resource rule. | [optional] |
| RemoveLocationContext | bool? | When updating a resource rule, if removeLocationContext is set to true, the existing location context is removed. This attribute is ignored when creating a resource rule. | [optional] |
| RemoveLocationHistoryContext | bool? | When updating a resource rule, if removeLocationHistoryContext is set to true, the existing location history context is removed. This attribute is ignored when creating a resource rule. | [optional] |
| RemoveMachineContext | bool? | When updating a resource rule, if removeMachineContext is set to true, the existing machine context is removed. This attribute is ignored when creating a resource rule. | [optional] |
| RemoveTravelVelocityContext | bool? | When updating a resource rule, if removeTravelVelocityContext is set to true, the existing travel velocity context is removed. This attribute is ignored when creating a resource rule. | [optional] |
| ResourceId | string | The UUID of the resource to which this resource rule is assigned. This value is only used when creating a resource rule. | [optional] |
| RiskEngineContexts | List<TransactionContext> | If risk engine rules are defined, the transaction contexts specify the level at which risk is applied to the authentication request if the corresponding risk engine rules trigger risk. If set to null, no changes are made. If set to an empty set, transaction contexts are removed. | [optional] |
| SkipSecondFactorIfUserNotExist | bool? | A flag indicating if second factor will be skipped if user doesn't exist when the first factor was EXTERNAL. | [optional] |
| StrictAccess | bool? | A flag indicating if this resource rule enforces strict access. Strict access means that if this rule denies access, the user is denied access even if other resource rules allow access. | [optional] |
| TransactionContexts | List<TransactionContext> | If transaction details are specified during an authentication request, the transaction contexts specify the level at which risk is applied to the authentication request if the corresponding transaction rules trigger risk. A maximum of two are allowed. If set to null, no changes are made. If set to an empty set, transaction contexts are removed. | [optional] |
| TravelVelocityContext | TravelVelocityContext | [optional] |