Skip to content

Access control model

Reference documentation

This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand how to manage access control in Atlan. For that, we would suggest starting with the access control and personalization snippets.

Base class for Atlan access control assets.

classDiagram
    direction RL
    class AccessControl {
        <<abstract>>
    }
    link AccessControl "../accesscontrol"
    class Asset {
        <<abstract>>
    }
    link Asset "../entities/asset"
    Asset <|-- AccessControl : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../entities/referenceable"
    Referenceable <|-- Asset : extends
    class Persona
    link Persona "../entities/persona"
    AccessControl <|-- Persona : extends
    class Purpose
    link Purpose "../entities/purpose"
    AccessControl <|-- Purpose : extends
    class AuthPolicy
    link AuthPolicy "../entities/authpolicy"
    Asset <|-- AuthPolicy : extends
    class AuthService
    link AuthService "../entities/authservice"
    Asset <|-- AuthService : extends

Type-specific properties

Following are the properties uniquely available on AccessControl assets in Atlan.

channelLink
TBC
1
2
3
builder.channelLink("String0"); // (1)
accessControl.getChannelLink(); // (2)
client.assets.select().where(AccessControl.CHANNEL_LINK.eq("String0")); // (3)

  1. Set the channelLink for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the channelLink from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their channelLink exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

defaultNavigation
TBC
1
2
3
builder.defaultNavigation("String0"); // (1)
accessControl.getDefaultNavigation(); // (2)
client.assets.select().where(AccessControl.DEFAULT_NAVIGATION.eq("String0")); // (3)

  1. Set the defaultNavigation for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the defaultNavigation from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their defaultNavigation exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

denyAssetFilters
TBC
1
2
3
4
5
builder // (1)
    .denyAssetFilter("String0")
    .denyAssetFilter("String1");
accessControl.getDenyAssetFilters(); // (2)
client.assets.select().where(AccessControl.DENY_ASSET_FILTERS.eq("String0")); // (3)

  1. Set the denyAssetFilters for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the denyAssetFilters from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their denyAssetFilters exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

denyAssetTabs
TBC
1
2
3
4
5
builder // (1)
    .denyAssetTab(AssetSidebarTab.OVERVIEW)
    .denyAssetTab(AssetSidebarTab.COLUMNS);
accessControl.getDenyAssetTabs(); // (2)
client.assets.select().where(AccessControl.DENY_ASSET_TABS.eq(AssetSidebarTab.OVERVIEW)); // (3)

  1. Set the denyAssetTabs for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the denyAssetTabs from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their denyAssetTabs exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

denyAssetTypes
TBC
1
2
3
4
5
builder // (1)
    .denyAssetType("String0")
    .denyAssetType("String1");
accessControl.getDenyAssetTypes(); // (2)
client.assets.select().where(AccessControl.DENY_ASSET_TYPES.eq("String0")); // (3)

  1. Set the denyAssetTypes for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the denyAssetTypes from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their denyAssetTypes exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

denyCustomMetadataGuids
TBC
1
2
3
4
5
builder // (1)
    .denyCustomMetadataGuid("String0")
    .denyCustomMetadataGuid("String1");
accessControl.getDenyCustomMetadataGuids(); // (2)
client.assets.select().where(AccessControl.DENY_CUSTOM_METADATA_GUIDS.eq("String0")); // (3)

  1. Set the denyCustomMetadataGuids for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the denyCustomMetadataGuids from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their denyCustomMetadataGuids exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

denyNavigationPages
TBC
1
2
3
4
5
builder // (1)
    .denyNavigationPage("String0")
    .denyNavigationPage("String1");
accessControl.getDenyNavigationPages(); // (2)
client.assets.select().where(AccessControl.DENY_NAVIGATION_PAGES.eq("String0")); // (3)

  1. Set the denyNavigationPages for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the denyNavigationPages from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their denyNavigationPages exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

isAccessControlEnabled
TBC
1
2
3
builder.isAccessControlEnabled(true); // (1)
accessControl.getIsAccessControlEnabled(); // (2)
client.assets.select().where(AccessControl.IS_ACCESS_CONTROL_ENABLED.eq(true)); // (3)

  1. Set the isAccessControlEnabled for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the isAccessControlEnabled from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their isAccessControlEnabled exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

channel_link
TBC
1
2
3
builder.channel_link = ...  # (1)
access_control.channel_link  # (2)
FluentSearch().where(FluentSearch.asset_type(AccessControl)).where(AccessControl.CHANNEL_LINK.eq("String0"))  # (3)

  1. Set the channel_link for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the channel_link from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their channel_link exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

default_navigation
TBC
1
2
3
builder.default_navigation = ...  # (1)
access_control.default_navigation  # (2)
FluentSearch().where(FluentSearch.asset_type(AccessControl)).where(AccessControl.DEFAULT_NAVIGATION.eq("String0"))  # (3)

  1. Set the default_navigation for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the default_navigation from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their default_navigation exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

deny_asset_filters
TBC
1
2
3
builder.deny_asset_filters = {...}  # (1)
access_control.deny_asset_filters  # (2)
FluentSearch().where(FluentSearch.asset_type(AccessControl)).where(AccessControl.DENY_ASSET_FILTERS.eq("String0"))  # (3)

  1. Set the deny_asset_filters for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the deny_asset_filters from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their deny_asset_filters exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

deny_asset_tabs
TBC
1
2
3
builder.deny_asset_tabs = {...}  # (1)
access_control.deny_asset_tabs  # (2)
FluentSearch().where(FluentSearch.asset_type(AccessControl)).where(AccessControl.DENY_ASSET_TABS.eq("String0"))  # (3)

  1. Set the deny_asset_tabs for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the deny_asset_tabs from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their deny_asset_tabs exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

deny_asset_types
TBC
1
2
3
builder.deny_asset_types = {...}  # (1)
access_control.deny_asset_types  # (2)
FluentSearch().where(FluentSearch.asset_type(AccessControl)).where(AccessControl.DENY_ASSET_TYPES.eq("String0"))  # (3)

  1. Set the deny_asset_types for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the deny_asset_types from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their deny_asset_types exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

deny_custom_metadata_guids
TBC
1
2
3
builder.deny_custom_metadata_guids = {...}  # (1)
access_control.deny_custom_metadata_guids  # (2)
FluentSearch().where(FluentSearch.asset_type(AccessControl)).where(AccessControl.DENY_CUSTOM_METADATA_GUIDS.eq("String0"))  # (3)

  1. Set the deny_custom_metadata_guids for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the deny_custom_metadata_guids from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their deny_custom_metadata_guids exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

deny_navigation_pages
TBC
1
2
3
builder.deny_navigation_pages = {...}  # (1)
access_control.deny_navigation_pages  # (2)
FluentSearch().where(FluentSearch.asset_type(AccessControl)).where(AccessControl.DENY_NAVIGATION_PAGES.eq("String0"))  # (3)

  1. Set the deny_navigation_pages for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the deny_navigation_pages from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their deny_navigation_pages exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

is_access_control_enabled
TBC
1
2
3
builder.is_access_control_enabled = ...  # (1)
access_control.is_access_control_enabled  # (2)
FluentSearch().where(FluentSearch.asset_type(AccessControl)).where(AccessControl.IS_ACCESS_CONTROL_ENABLED.eq(True))  # (3)

  1. Set the is_access_control_enabled for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the is_access_control_enabled from a AccessControl.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their is_access_control_enabled exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

channelLink
TBC
1
2
3
4
5
{
  "attributes": {
    "channelLink": "String0" // (1)
  }
}

  1. Set the channelLink for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets.

defaultNavigation
TBC
1
2
3
4
5
{
  "attributes": {
    "defaultNavigation": "String0" // (1)
  }
}

  1. Set the defaultNavigation for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets.

denyAssetFilters
TBC
1
2
3
4
5
6
7
8
{
  "attributes": {
    "denyAssetFilters": [ // (1)
      "String0",
      "String1"
    ]
  }
}

  1. Set the denyAssetFilters for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets.

denyAssetTabs
TBC
1
2
3
4
5
6
7
8
{
  "attributes": {
    "denyAssetTabs": [ // (1)
      "Overview",
      "Columns"
    ]
  }
}

  1. Set the denyAssetTabs for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets.

denyAssetTypes
TBC
1
2
3
4
5
6
7
8
{
  "attributes": {
    "denyAssetTypes": [ // (1)
      "String0",
      "String1"
    ]
  }
}

  1. Set the denyAssetTypes for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets.

denyCustomMetadataGuids
TBC
1
2
3
4
5
6
7
8
{
  "attributes": {
    "denyCustomMetadataGuids": [ // (1)
      "String0",
      "String1"
    ]
  }
}

  1. Set the denyCustomMetadataGuids for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets.

denyNavigationPages
TBC
1
2
3
4
5
6
7
8
{
  "attributes": {
    "denyNavigationPages": [ // (1)
      "String0",
      "String1"
    ]
  }
}

  1. Set the denyNavigationPages for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets.

isAccessControlEnabled
TBC
1
2
3
4
5
{
  "attributes": {
    "isAccessControlEnabled": true // (1)
  }
}

  1. Set the isAccessControlEnabled for a AccessControl.

    For more details

    For more information, see the asset CRUD snippets.

Relationships

The following illustrates how the various pieces of access control inter-relate with each other:

erDiagram
    Persona |o--o{ AuthPolicy : policies
    Purpose |o--o{ AuthPolicy : policies
    AuthPolicy }o..o{ Asset : policyResources