Class Group
A collection of users who all need the same type of access to a particular set of resources or compartment.
For conceptual information about groups and other IAM Service components, see
Overview of IAM.
If you're federating with an identity provider (IdP), you need to create mappings between the groups
defined in the IdP and groups you define in the IAM service. For more information, see
Identity Providers and Federation. Also see
{@link IdentityProvider} and
{@link IdpGroupMapping}.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
talk to an administrator. If you're an administrator who needs to write policies to give users access,
see Get Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values
using the API.
Inherited Members
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class GroupProperties
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.
|
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 Group.LifecycleStateEnum? LifecycleState { get; set; }Property Value
| Type | Description |
|---|---|
| Group.LifecycleStateEnum? | The group's current state. After creating a group, make sure its |
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.
|
Remarks
Required