Most types of Oracle Cloud Infrastructure resources have an Oracle-assigned unique ID called an Oracle Cloud Identifier (OCID). It's included as part of the resource's information in both the Console and API.
To use the API, you need the OCID for your The root compartment that contains all of your organization's compartments and other Oracle Cloud Infrastructure cloud resources.. For information about where to find it, see the next section.
OCIDs use this syntax:
ocid1.<RESOURCE TYPE>.<REALM>.[REGION][.FUTURE USE].<UNIQUE ID>
- ocid1: The literal string indicating the version of the OCID.
- resource type: The type of resource (for example,
group, and so on).
- realm: The realm the resource is in. A realm is a set of regions that share entities. Possible values are
oc1for the commercial realm ,
oc2for the Government Cloud realm, or
oc3for the Federal Government Cloud realm. The regions in the commercial realm (OC1) belong to the domain
oraclecloud.com. The regions in the Government Cloud (OC2) belong to the domain
- region: The region the resource is in (for example,
eu-frankfurt-1). With the introduction of the Frankfurt region, the format switched from a three-character code to a longer string. This part is present in the OCID only for regional resources or those specific to a single availability domain. If the region is not applicable to the resource, this part might be blank (see the example tenancy ID below).
- future use: Reserved for future use. Currently blank.
- unique ID: The unique portion of the ID. The format may vary depending on the type of resource or service.
If you use the Oracle Cloud Infrastructure API, you need your tenancy's OCID in order to sign the API requests. You also use the tenancy ID in some of the IAM API operations.
Get the tenancy OCID from the Oracle Cloud Infrastructure Console on the Tenancy Details page:
Open the navigation menu, under Governance and Administration, go to Administration and click Tenancy Details.
The tenancy OCID is shown under Tenancy Information. Click Copy to copy it to your clipboard.
The tenancy OCID looks something like this (notice the word "tenancy" in it):
Name and Description (IAM Only)
The IAM service requires you to assign a unique, unchangeable name to each of your IAM resources (users, groups, dynamic groups, federations, and policies). The name must be unique within the scope of the type of resource (for example, you can only have one user with the name BobSmith). Notice that this requirement is specific to IAM and not the other services.
The name you assign to a user at creation is their login for the Console.
You can use these names instead of the OCID when writing a policy (for example,
Allow group <GROUP NAME> to manage all-resources in compartment <COMPARTMENT NAME>).
In addition to the name, you must also assign a description to each of your IAM resources (although it can be an empty string). It can be a friendly description or other information that helps you easily identify the resource. The description does not have to be unique, and you can change it whenever you like. For example, you might want to use the description to store the user's email address if you're not already using the email address as the user's unique name.
For most of the Oracle Cloud Infrastructure resources you create (other than those in IAM), you can optionally assign a display name. It can be a friendly description or other information that helps you easily identify the resource. The display name does not have to be unique, and you can change it whenever you like. The Console shows the resource's display name along with its OCID.