Class Rule

Rule resource. A unit that has a condition which on evaluation with input returns defined values.

Inheritance
object
Rule
Inherited Members
Namespace: Oci.IdentitydomainsService.Models
Assembly: OCI.DotNetSDK.Identitydomains.dll
Syntax
public class Rule

Properties

Active

Declaration
[JsonProperty(PropertyName = "active")]
public bool? Active { get; set; }
Property Value
Type Description
bool?

If true, rule is active
SCIM++ Properties:

  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: boolean
  • uniqueness: none

CompartmentOcid

Declaration
[JsonProperty(PropertyName = "compartmentOcid")]
public string CompartmentOcid { get; set; }
Property Value
Type Description
string

OCI Compartment Id (ocid) in which the resource lives.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: string
  • uniqueness: none

Condition

Declaration
[Required(ErrorMessage = "Condition is required.")]
[JsonProperty(PropertyName = "condition")]
public string Condition { get; set; }
Property Value
Type Description
string

SCIM filters
Deprecated Since: 17.3.4
SCIM++ Properties:

  • caseExact: true
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: true
  • returned: default
  • type: string
  • uniqueness: none
Remarks

Required

ConditionGroup

Declaration
[JsonProperty(PropertyName = "conditionGroup")]
public RuleConditionGroup ConditionGroup { get; set; }
Property Value
Type Description
RuleConditionGroup

DeleteInProgress

Declaration
[JsonProperty(PropertyName = "deleteInProgress")]
public bool? DeleteInProgress { get; set; }
Property Value
Type Description
bool?

A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: boolean
  • uniqueness: none

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Rule Description
SCIM++ Properties:

  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none

DomainOcid

Declaration
[JsonProperty(PropertyName = "domainOcid")]
public string DomainOcid { get; set; }
Property Value
Type Description
string

OCI Domain Id (ocid) in which the resource lives.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: string
  • uniqueness: none

ExternalId

Declaration
[JsonProperty(PropertyName = "externalId")]
public string ExternalId { get; set; }
Property Value
Type Description
string

An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none

Id

Declaration
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: always
  • type: string
  • uniqueness: global

IdcsCreatedBy

Declaration
[JsonProperty(PropertyName = "idcsCreatedBy")]
public IdcsCreatedBy IdcsCreatedBy { get; set; }
Property Value
Type Description
IdcsCreatedBy

IdcsLastModifiedBy

Declaration
[JsonProperty(PropertyName = "idcsLastModifiedBy")]
public IdcsLastModifiedBy IdcsLastModifiedBy { get; set; }
Property Value
Type Description
IdcsLastModifiedBy

IdcsLastUpgradedInRelease

Declaration
[JsonProperty(PropertyName = "idcsLastUpgradedInRelease")]
public string IdcsLastUpgradedInRelease { get; set; }
Property Value
Type Description
string

The release number when the resource was upgraded.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: request
  • type: string
  • uniqueness: none

IdcsPreventedOperations

Declaration
[JsonProperty(PropertyName = "idcsPreventedOperations", ItemConverterType = typeof(ResponseEnumConverter))]
public List<IdcsPreventedOperations> IdcsPreventedOperations { get; set; }
Property Value
Type Description
List<IdcsPreventedOperations>

Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
SCIM++ Properties:

  • idcsSearchable: false
  • multiValued: true
  • mutability: readOnly
  • required: false
  • returned: request
  • type: string
  • uniqueness: none

Locked

Declaration
[JsonProperty(PropertyName = "locked")]
public bool? Locked { get; set; }
Property Value
Type Description
bool?

Shows if the rule is locked
SCIM++ Properties:

  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: boolean
  • uniqueness: none

Meta

Declaration
[JsonProperty(PropertyName = "meta")]
public Meta Meta { get; set; }
Property Value
Type Description
Meta

Name

Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

Rule name
SCIM++ Properties:

  • caseExact: true
  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: true
  • returned: always
  • type: string
  • uniqueness: none
Remarks

Required

Ocid

Declaration
[JsonProperty(PropertyName = "ocid")]
public string Ocid { get; set; }
Property Value
Type Description
string

Unique OCI identifier for the SCIM Resource.
SCIM++ Properties:

  • caseExact: true
  • idcsSearchable: true
  • multiValued: false
  • mutability: immutable
  • required: false
  • returned: default
  • type: string
  • uniqueness: global

PolicyType

Declaration
[Required(ErrorMessage = "PolicyType is required.")]
[JsonProperty(PropertyName = "policyType")]
public RulePolicyType PolicyType { get; set; }
Property Value
Type Description
RulePolicyType
Remarks

Required

Return

Declaration
[Required(ErrorMessage = "Return is required.")]
[JsonProperty(PropertyName = "return")]
public List<RuleReturn> Return { get; set; }
Property Value
Type Description
List<RuleReturn>

The return values are the then portion of a Rule
SCIM++ Properties:

  • idcsCompositeKey: [name]
  • idcsSearchable: false
  • multiValued: true
  • mutability: readWrite
  • required: true
  • returned: default
  • type: complex
  • uniqueness: none
Remarks

Required

RuleGroovy

Declaration
[JsonProperty(PropertyName = "ruleGroovy")]
public string RuleGroovy { get; set; }
Property Value
Type Description
string

The Groovy script that is run instead of the rule, if policy type allows the rule to be a Groovy script.
SCIM++ Properties:

  • caseExact: true
  • idcsSearchable: false
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none

Schemas

Declaration
[Required(ErrorMessage = "Schemas is required.")]
[JsonProperty(PropertyName = "schemas")]
public List<string> Schemas { get; set; }
Property Value
Type Description
List<string>

REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: false
  • multiValued: true
  • mutability: readWrite
  • required: true
  • returned: default
  • type: string
  • uniqueness: none
Remarks

Required

Tags

Declaration
[JsonProperty(PropertyName = "tags")]
public List<Tags> Tags { get; set; }
Property Value
Type Description
List<Tags>

A list of tags on this resource.
SCIM++ Properties:

  • idcsCompositeKey: [key, value]
  • idcsSearchable: true
  • multiValued: true
  • mutability: readWrite
  • required: false
  • returned: request
  • type: complex
  • uniqueness: none

TenancyOcid

Declaration
[JsonProperty(PropertyName = "tenancyOcid")]
public string TenancyOcid { get; set; }
Property Value
Type Description
string

OCI Tenant Id (ocid) in which the resource lives.
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: string
  • uniqueness: none