Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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.

Properties

compartmentId

compartmentId: string

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

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 policy. Does not have to be unique, and it's changeable.

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 policy.

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 policy's current state. After creating a policy, make sure its {@code lifecycleState} changes from CREATING to ACTIVE before using it.

name

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

statements

statements: Array<string>

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

timeCreated

timeCreated: Date

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

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

Optional versionDate

versionDate: Date

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.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Policy): object

getJsonObj

  • getJsonObj(obj: Policy): object