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 |
|
-
Set the
channelLink
for aAccessControl
. -
Retrieve the
channelLink
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
defaultNavigation
for aAccessControl
. -
Retrieve the
defaultNavigation
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
denyAssetFilters
for aAccessControl
. -
Retrieve the
denyAssetFilters
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
denyAssetTabs
for aAccessControl
. -
Retrieve the
denyAssetTabs
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
denyAssetTypes
for aAccessControl
. -
Retrieve the
denyAssetTypes
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
denyCustomMetadataGuids
for aAccessControl
. -
Retrieve the
denyCustomMetadataGuids
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
denyNavigationPages
for aAccessControl
. -
Retrieve the
denyNavigationPages
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
isAccessControlEnabled
for aAccessControl
. -
Retrieve the
isAccessControlEnabled
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
channel_link
for aAccessControl
. -
Retrieve the
channel_link
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
default_navigation
for aAccessControl
. -
Retrieve the
default_navigation
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
deny_asset_filters
for aAccessControl
. -
Retrieve the
deny_asset_filters
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
deny_asset_tabs
for aAccessControl
. -
Retrieve the
deny_asset_tabs
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
deny_asset_types
for aAccessControl
. -
Retrieve the
deny_asset_types
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
deny_custom_metadata_guids
for aAccessControl
. -
Retrieve the
deny_custom_metadata_guids
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
deny_navigation_pages
for aAccessControl
. -
Retrieve the
deny_navigation_pages
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
is_access_control_enabled
for aAccessControl
. -
Retrieve the
is_access_control_enabled
from aAccessControl
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
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 |
|
-
Set the
channelLink
for aAccessControl
.For more details
For more information, see the asset CRUD snippets.
defaultNavigation
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
defaultNavigation
for aAccessControl
.For more details
For more information, see the asset CRUD snippets.
denyAssetFilters
TBC | |
---|---|
1 2 3 4 5 6 7 8 |
|
-
Set the
denyAssetFilters
for aAccessControl
.For more details
For more information, see the asset CRUD snippets.
denyAssetTabs
TBC | |
---|---|
1 2 3 4 5 6 7 8 |
|
-
Set the
denyAssetTabs
for aAccessControl
.For more details
For more information, see the asset CRUD snippets.
denyAssetTypes
TBC | |
---|---|
1 2 3 4 5 6 7 8 |
|
-
Set the
denyAssetTypes
for aAccessControl
.For more details
For more information, see the asset CRUD snippets.
denyCustomMetadataGuids
TBC | |
---|---|
1 2 3 4 5 6 7 8 |
|
-
Set the
denyCustomMetadataGuids
for aAccessControl
.For more details
For more information, see the asset CRUD snippets.
denyNavigationPages
TBC | |
---|---|
1 2 3 4 5 6 7 8 |
|
-
Set the
denyNavigationPages
for aAccessControl
.For more details
For more information, see the asset CRUD snippets.
isAccessControlEnabled
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
isAccessControlEnabled
for aAccessControl
.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