Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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](https://docs.cloud.oracle.com/Content/Identity/dynamicgroups/managingdynamicgroups.htm).

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

compartmentId

compartmentId: string

The OCID of the tenancy containing the group.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

description

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.

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

id

id: string

The OCID of the group.

Optional inactiveStatus

inactiveStatus: undefined | number

The detailed status of INACTIVE lifecycleState. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

lifecycleState

lifecycleState: LifecycleState

The group's current state. After creating a group, make sure its {@code lifecycleState} changes from CREATING to ACTIVE before using it.

matchingRule

matchingRule: string

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

name

name: 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.

timeCreated

timeCreated: Date

Date and time the group was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj