Show / Hide Table of Contents

Class Policy

A document that specifies the type of access a group has to the resources in a compartment. For information about policies and other IAM Service components, see Overview of IAM. If you're new to policies, see Get Started with Policies.
The word "policy" is used by people in different ways:

  • An individual statement written in the policy language
  • A collection of statements in a single, named "policy" document (which has an Oracle Cloud ID (OCID) assigned to it)
  • The overall body of policies your organization uses to control access to resources
    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.
    Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Inheritance
System.Object
Policy
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class Policy : object

Properties

CompartmentId

Declaration
public string CompartmentId { get; set; }
Property Value
Type Description
System.String

The OCID of the compartment containing the policy (either the tenancy or another compartment).

Remarks

Required

DefinedTags

Declaration
public System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, System.Object>> DefinedTags { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.Dictionary<System.String, System.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
public string Description { get; set; }
Property Value
Type Description
System.String

The description you assign to the policy. Does not have to be unique, and it's changeable.

Remarks

Required

FreeformTags

Declaration
public System.Collections.Generic.Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.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
public string Id { get; set; }
Property Value
Type Description
System.String

The OCID of the policy.

Remarks

Required

InactiveStatus

Declaration
public System.Nullable<long> InactiveStatus { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

The detailed status of INACTIVE lifecycleState.

LifecycleState

Declaration
public System.Nullable<Policy.LifecycleStateEnum> LifecycleState { get; set; }
Property Value
Type Description
System.Nullable<Policy.LifecycleStateEnum>

The policy's current state. After creating a policy, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Remarks

Required

Name

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

The name you assign to the policy during creation. The name must be unique across all policies in the tenancy and cannot be changed.

Remarks

Required

Statements

Declaration
public System.Collections.Generic.List<string> Statements { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

An array of one or more policy statements written in the policy language.

Remarks

Required

TimeCreated

Declaration
public System.Nullable<System.DateTime> TimeCreated { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Date and time the policy was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z

Remarks

Required

VersionDate

Declaration
public System.Nullable<System.DateTime> VersionDate { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

The version of the policy. If null or set to an empty string, when a request comes in for authorization, the policy will be evaluated according to the current behavior of the services at that moment. If set to a particular date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date.

In This Article
Back to top