Oracle Cloud Infrastructure Documentation

Data Catalog Policies

To control who has access to Data Catalog, and the type of access for each group of users, you must create policies.

By default only the users in the Administrators group have access to all Data Catalog resources. For everyone else who's involved with Data Catalog, you must create new policies that assigns them proper rights to Data Catalog resources.

For a complete list of Oracle Cloud Infrastructure policies, see policy reference.

Resource-Types

Data Catalog offers both aggregate and individual resource-types for writing policies.

You can use aggregate resource-types to write fewer policies. For example, instead of allowing a group to manage data-catalogs and data-catalog-data-assets, you can have a policy that allows the group to manage the aggregate resource-type, data-catalog-family.

Aggregate Resource-Type Individual Resource-Types
data-catalog-family

data-catalogs

data-catalog-data-assets

data-catalog-glossaries

The APIs covered for the aggregate data-catalog-family resource-type cover the APIs for data-catalogs, data-catalog-data-assets and data-catalog-glossaries.

For example,

allow group catalog-admins to manage data-catalog-family in compartment x

is the same as writing the following three policies:

allow group catalog-admins to manage data-catalogs in compartment x
allow group catalog-admins to manage data-catalog-data-assets in compartment x
allow group catalog-admins to manage data-catalog-glossaries in compartment x

Supported Variables

To add conditions to your policies, you can either use Oracle Cloud Infrastructure general or service specific variables.

Operations for This Resource Type...

Can Use These Variables...

Variable Type

Comments

data-catalog-family

target.catalog.id

Entity (OCID)

Not available to use with CreateCatalog or work request operations.

data-catalogs

target.catalog.id

Entity (OCID)

Not available to use with CreateCatalog or work request operations.

data-catalog-data-assets

target.catalog.id

Entity (OCID)

Not available to use with work request operations.

target.data-asset.key

The key is the Universally Unique Identifier (UUID) for the data asset, in a string format. This id is not an OCID.

Available to use only with data asset operations except for CreateDataAsset.

data-catalog-glossaries

target.catalog.id

Entity (OCID)

Not available to use with work request operations.

target.glossary.key

String

The key is the Universally Unique Identifier (UUID) for the glossary, in a string format. This id is not an OCID.

Available to use only with glossary operations except for CreateGlossary.

Details for Verbs + Resource-Type Combinations

The following tables show the permissions and API operations covered by each verb for Data Catalog. The level of access is cumulative as you go from inspect > read > use > manage. A plus sign (+) in a table cell indicates incremental access compared to the cell directly above it, whereas "no extra" indicates no incremental access.

data-catalogs
data-catalog-data-assets
data-catalog-glossaries

Permissions Required for Each API Operation

The following table lists the API operations in a logical order, grouped by resource type. The resource types are data-catalogs, data-catalog-data-assets, and data-catalog-glossaries.

For information about permissions, see permissions.

API Operation

Permissions Required to Use the Operation

ListCatalogs

CATALOG_INSPECT

GetCatalog

CATALOG_READ

UpdateCatalog

CATALOG_UPDATE

CreateCatalog

CATALOG_CREATE

ChangeCatalogCompartment

CATALOG_MOVE

DeleteCatalog

CATALOG_DELETE

GetType

CATALOG_READ

ListTypes

CATALOG_READ

ListCatalogPermissions

CATALOG_READ

ListDataAssetPermissions

CATALOG_READ

ListSearchResults

CATALOG_READ

ListWorkRequests

CATALOG_WORK_REQUEST_INSPECT

GetWorkRequest

CATALOG_WORK_REQUEST_READ

ListWorkRequestLogs

CATALOG_WORK_REQUEST_READ

ListWorkRequestErrors

CATALOG_WORK_REQUEST_READ

ListJobDefinitions

CATALOG_JOB_DEFINITION_INSPECT

GetJobDefinition

CATALOG_JOB_DEFINITION_READ

ListJobDefinitionPermissions

CATALOG_JOB_DEFINITION_READ

UpdateJobDefinition

CATALOG_JOB_DEFINITION_UPDATE

CreateJobDefinition

CATALOG_JOB_DEFINITION_CREATE

DeleteJobDefinition

CATALOG_JOB_DEFINITION_DELETE

ListJobs

CATALOG_JOB_INSPECT

GetJob

CATALOG_JOB_READ

UpdateJob

CATALOG_JOB_UPDATE

CreateJob

CATALOG_JOB_CREATE

DeleteJob

CATALOG_JOB_DELETE

ListJobMetrics

CATALOG_JOB_READ

GetJobMetrics

CATALOG_JOB_READ

ListJobLogs

CATALOG_JOB_READ

GetJobLog

CATALOG_JOB_READ

ListJobExecutions

CATALOG_JOB_READ

GetJobExecution

CATALOG_JOB_READ

UpdateJobExecution

CATALOG_JOB_UPDATE

CreateJobExecution

CATALOG_JOB_UPDATE

DeleteJobExecution

CATALOG_JOB_UPDATE

ListDataAssets

CATALOG_DATA_ASSET_INSPECT

GetDataAsset

CATALOG_DATA_ASSET_READ

UpdateDataAsset

CATALOG_DATA_ASSET_UPDATE

CreateDataAsset

CATALOG_DATA_ASSET_CREATE

DeleteDataAsset

CATALOG_DATA_ASSET_DELETE

ListConnections

CATALOG_DATA_ASSET_READ

GetConnection

CATALOG_DATA_ASSET_READ

ParseConnection

CATALOG_DATA_ASSET_READ

UpdateConnection

CATALOG_DATA_ASSET_UPDATE

ImportConnection

CATALOG_DATA_ASSET_UPDATE

ValidateConnection

CATALOG_DATA_ASSET_UPDATE

TestConnection

CATALOG_DATA_ASSET_UPDATE

CreateConnection

CATALOG_DATA_ASSET_UPDATE

DeleteConnection

CATALOG_DATA_ASSET_UPDATE

ListFolders

CATALOG_DATA_ASSET_READ

GetFolder

CATALOG_DATA_ASSET_READ

UpdateFolder

CATALOG_DATA_ASSET_UPDATE

CreateFolder

CATALOG_DATA_ASSET_UPDATE

DeleteFolder

CATALOG_DATA_ASSET_UPDATE

ListEntities

CATALOG_DATA_ASSET_READ

GetEntity

CATALOG_DATA_ASSET_READ

UpdateEntity

CATALOG_DATA_ASSET_UPDATE

CreateEntity

CATALOG_DATA_ASSET_UPDATE

DeleteEntity

CATALOG_DATA_ASSET_UPDATE

ListAttributes

CATALOG_DATA_ASSET_READ

GetAttribute

CATALOG_DATA_ASSET_READ

UpdateAttribute

CATALOG_DATA_ASSET_UPDATE

CreateAttribute

CATALOG_DATA_ASSET_UPDATE

DeleteAttribute

CATALOG_DATA_ASSET_UPDATE

ListDataAssetTags

CATALOG_DATA_ASSET_TAG_INSPECT

GetDataAssetTag

CATALOG_DATA_ASSET_TAG_READ

Not used.

CATALOG_DATA_ASSET_TAG_UPDATE

CreateDataAssetTag

CATALOG_DATA_ASSET_TAG_CREATE

DeleteDataAssetTag

CATALOG_DATA_ASSET_TAG_DELETE

ListEntityTags

CATALOG_DATA_ASSET_TAG_INSPECT

GetEntityTag

CATALOG_DATA_ASSET_TAG_READ

Not used.

CATALOG_DATA_ASSET_TAG_UPDATE

CreateEntityTag

CATALOG_DATA_ASSET_TAG_CREATE

DeleteEntityTag

CATALOG_DATA_ASSET_TAG_DELETE

ListAttributeTags

CATALOG_DATA_ASSET_TAG_INSPECT

GetAttributeTag

CATALOG_DATA_ASSET_TAG_READ

Not used.

CATALOG_DATA_ASSET_TAG_UPDATE

CreateAttributeTag

CATALOG_DATA_ASSET_TAG_CREATE

DeleteAttributeTag

CATALOG_DATA_ASSET_TAG_DELETE

ListFolderTags

CATALOG_DATA_ASSET_TAG_INSPECT

GetFolderTag

CATALOG_DATA_ASSET_TAG_READ

Not used.

CATALOG_DATA_ASSET_TAG_UPDATE

CreateFolderTag

CATALOG_DATA_ASSET_TAG_CREATE

DeleteFolderTag

CATALOG_DATA_ASSET_TAG_DELETE

ListGlossaries

CATALOG_GLOSSARY_INSPECT

GetGlossary

CATALOG_GLOSSARY_READ

ExportGlossary

CATALOG_GLOSSARY_READ

UpdateGlossary

CATALOG_GLOSSARY_UPDATE

ImportGlossary

CATALOG_GLOSSARY_UPDATE

CreateGlossary

CATALOG_GLOSSARY_CREATE

DeleteGlossary

CATALOG_GLOSSARY_DELETE

ListGlossaryTerms

CATALOG_GLOSSARY_READ

GetTerm

CATALOG_GLOSSARY_READ

UpdateTerm

CATALOG_GLOSSARY_UPDATE

CreateTerm

CATALOG_GLOSSARY_UPDATE

DeleteTerm

CATALOG_GLOSSARY_UPDATE

ListGlossaryTermRelationships

CATALOG_GLOSSARY_READ

GetTermRelationship

CATALOG_GLOSSARY_READ

UpdateTermRelationship

CATALOG_GLOSSARY_UPDATE

CreateTermRelationship

CATALOG_GLOSSARY_UPDATE

DeleteTermRelationship

CATALOG_GLOSSARY_UPDATE

Creating a Policy

Here's how you create a policy:

  1. Open the Console navigation menu and then select Policies under Identity.
  2. Click Create Policy.
  3. Enter a name and description for the policy.
  4. In the Statement field, enter a policy rule in the following format:
    allow service datacatalog to <verb> <resource_type> in <compartment or tenancy details>
  5. Click Create.

For more information on creating policies, see how policies work and policy reference.

Policy Examples

A policy syntax goes like this:

allow <subject> to <verb> <resource-type> in <location> where <conditions>

For complete details, see policy syntax. For more information on creating policies, see how policies work, policy reference, and policy details for Object Storage.

Policy Examples to Enable Access to Data Catalog
Policy Examples to Enable Access to Oracle Object Storage
Security Policy Examples