Class DynamicGroup

A dynamic group defines a matching rule. Every bare metal or virtual machine instance is deployed with an instance certificate. The certificate contains metadata about the instance. This includes the instance OCID and the compartment OCID, along with a few other optional properties. When an API call is made using this instance certificate as the authenticator, the certificate can be matched to one or multiple dynamic groups. The instance can then get access to the API based on the permissions granted in policies written for the dynamic groups.
This works like regular user/group membership. But in that case, the membership is a static relationship, whereas in a dynamic group, the membership of an instance certificate to a dynamic group is determined during runtime. For more information, see Managing Dynamic Groups.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Inheritance

object

DynamicGroup

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.IdentityService.Models

Assembly: OCI.DotNetSDK.Identity.dll

Syntax

public class DynamicGroup

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the tenancy containing the group.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

[Required(ErrorMessage = "Description is required.")]
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	The description you assign to the group. Does not have to be unique, and it's changeable. (For tenancies that support identity domains) You can have an empty description.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the group.

Remarks

Required

InactiveStatus

Declaration

[JsonProperty(PropertyName = "inactiveStatus")]
public long? InactiveStatus { get; set; }

Property Value

Type	Description
long?	The detailed status of INACTIVE lifecycleState.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DynamicGroup.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
DynamicGroup.LifecycleStateEnum?	The group's current state. After creating a group, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it.

Remarks

Required

MatchingRule

Declaration

[Required(ErrorMessage = "MatchingRule is required.")]
[JsonProperty(PropertyName = "matchingRule")]
public string MatchingRule { get; set; }

Property Value

Type	Description
string	A rule string that defines which instance certificates will be matched. For syntax, see Managing Dynamic Groups.

Remarks

Required

Name

Declaration

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

Property Value

Type	Description
string	The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	Date and time the group was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required