Skip to content

admin

Fabric tenant administration (settings, tags, workloads, users)

Authentication scope: fabric

List all tenant settings

Terminal window
fabio admin list-tenant-settings

Read-only · Returns list

Update a tenant setting

Terminal window
fabio admin update-tenant-setting --setting-name <value>
Flag Type Required Description
--setting-name string Yes Tenant setting name
--file string No Path to JSON file with setting body
--content string No Inline JSON content for setting body

Mutates state · Returns object

List all capacities’ delegated tenant setting overrides

Terminal window
fabio admin list-capacities-tenant-overrides

Read-only · Returns list

List delegated tenant setting overrides for a capacity

Terminal window
fabio admin list-capacity-tenant-overrides --capacity-id <value>
Flag Type Required Description
--capacity-id string Yes Capacity ID

Read-only · Returns list

Delete a capacity delegated tenant setting override

Terminal window
fabio admin delete-capacity-tenant-override --capacity-id <value> --setting-name <value>
Flag Type Required Description
--capacity-id string Yes Capacity ID
--setting-name string Yes Tenant setting name

Mutates state · Destructive · Returns void

Update a capacity delegated tenant setting override

Terminal window
fabio admin update-capacity-tenant-override --capacity-id <value> --setting-name <value>
Flag Type Required Description
--capacity-id string Yes Capacity ID
--setting-name string Yes Tenant setting name
--file string No Path to JSON file with override body
--content string No Inline JSON content for override body

Mutates state · Returns object

List all domains’ delegated tenant setting overrides

Terminal window
fabio admin list-domains-tenant-overrides

Read-only · Returns list

List all workspaces’ delegated tenant setting overrides

Terminal window
fabio admin list-workspaces-tenant-overrides

Read-only · Returns list

List tags

Terminal window
fabio admin list-tags

Read-only · Returns list

Bulk-create tags

Terminal window
fabio admin create-tags
Flag Type Required Description
--name string No Tag display name (repeatable). Convenience for the common case — builds the {"createTagsRequest":[{"displayName":...}]} body for you
--file string No Path to JSON file with tag definitions
--content string No Inline JSON content with tag definitions

Mutates state · Returns object

Update a tag

Terminal window
fabio admin update-tag --tag-id <value>
Flag Type Required Description
--tag-id string Yes Tag ID
--name string No New tag name
--description string No New tag description

Mutates state · Returns object

Delete a tag

Terminal window
fabio admin delete-tag --tag-id <value>
Flag Type Required Description
--tag-id string Yes Tag ID

Mutates state · Destructive · Returns void

List workloads

Terminal window
fabio admin list-workloads

Read-only · Returns list

List workload assignments

Terminal window
fabio admin list-workload-assignments

Read-only · Returns list

Create a workload assignment

Terminal window
fabio admin create-workload-assignment
Flag Type Required Description
--file string No Path to JSON file with assignment body
--content string No Inline JSON content for assignment body

Mutates state · Returns object

Delete a workload assignment

Terminal window
fabio admin delete-workload-assignment --assignment-id <value>
Flag Type Required Description
--assignment-id string Yes Assignment ID

Mutates state · Destructive · Returns void

List workspaces (admin view)

Terminal window
fabio admin list-workspaces
Flag Type Required Description
--include string No Include additional data in the response (e.g. “encryption”)
--encryption-status string No Filter workspaces by encryption status (only valid when –include=encryption is set). Valid values: Disabled, Active, EnableInProgress, DisableInProgress, Failed

Read-only · Returns list

Show workspace details (admin view)

Terminal window
fabio admin show-workspace --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID

Read-only · Returns object

List users in a workspace (admin view)

Terminal window
fabio admin list-workspace-users --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID

Read-only · Returns list

List git connections across workspaces

Terminal window
fabio admin list-git-connections

Read-only · Returns list

Grant temporary admin access to a workspace

Terminal window
fabio admin grant-admin-access --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID

Mutates state · Returns void

Remove temporary admin access from a workspace

Terminal window
fabio admin remove-admin-access --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID

Mutates state · Destructive · Returns void

Restore a deleted workspace

Terminal window
fabio admin restore-workspace --workspace <value> --name <value> --capacity-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--name string Yes Restored workspace name
--capacity-id string Yes Capacity ID to assign the restored workspace

Mutates state · Returns void

List network communication policies

Terminal window
fabio admin list-network-policies
Flag Type Required Description
--filter string No Filter by policy direction (e.g. “inbound/publicAccessRules/defaultAction eq ‘deny’”, “outbound/publicAccessRules/defaultAction eq ‘deny’”, or both combined with or)

Examples

Terminal window
fabio admin list-network-policies
Terminal window
fabio admin list-network-policies --filter "inbound/publicAccessRules/defaultAction eq 'deny'"

Read-only · Returns list

List items (admin view)

Terminal window
fabio admin list-items

Read-only · Returns list

Show item details (admin view)

Terminal window
fabio admin show-item --workspace <value> --item-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--item-id string Yes Item ID

Read-only · Returns object

List users with access to an item (admin view)

Terminal window
fabio admin list-item-users --workspace <value> --item-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--item-id string Yes Item ID

Read-only · Returns list

Bulk-set sensitivity labels on items

Terminal window
fabio admin bulk-set-labels
Flag Type Required Description
--file string No Path to JSON file with label assignments
--content string No Inline JSON content with label assignments

Mutates state · Returns object

Bulk-remove sensitivity labels from items

Terminal window
fabio admin bulk-remove-labels
Flag Type Required Description
--file string No Path to JSON file with item IDs
--content string No Inline JSON content with item IDs

Mutates state · Returns object

List external data shares

Terminal window
fabio admin list-external-data-shares

Read-only · Returns list

Revoke an external data share

Terminal window
fabio admin revoke-external-data-share --workspace <value> --item-id <value> --share-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--item-id string Yes Item ID
--share-id string Yes External data share ID

Mutates state · Destructive · Returns void

Remove all sharing links for specified items

Terminal window
fabio admin remove-all-sharing-links
Flag Type Required Description
--file string No Path to JSON file with items
--content string No Inline JSON content with items

Mutates state · Destructive · Long-running operation · Returns object

Bulk-remove sharing links

Terminal window
fabio admin bulk-remove-sharing-links
Flag Type Required Description
--file string No Path to JSON file with sharing link removals
--content string No Inline JSON content with sharing link removals

Mutates state · Long-running operation · Returns object

List domains (admin view)

Terminal window
fabio admin list-domains
Flag Type Required Description
--non-empty-only bool No Only return domains with workspaces assigned that contain one or more items the user has at least read access to
--with-assigned-workspaces-only bool No Only return domains that have at least one workspace assigned to them, or to any of their subdomains

Examples

Terminal window
fabio admin list-domains
Terminal window
fabio admin list-domains --with-assigned-workspaces-only
Terminal window
fabio admin list-domains --non-empty-only --with-assigned-workspaces-only

Read-only · Returns list

Create a domain

Terminal window
fabio admin create-domain --name <value>
Flag Type Required Description
--name string Yes Domain name
--description string No Domain description
--parent-id string No Parent domain ID (for subdomains)

Mutates state · Returns object

Show domain details

Terminal window
fabio admin show-domain --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID

Read-only · Returns object

Update a domain

Terminal window
fabio admin update-domain --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID
--name string No New name
--description string No New description

Mutates state · Returns object

Delete a domain

Terminal window
fabio admin delete-domain --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID

Mutates state · Destructive · Returns void

List workspaces in a domain

Terminal window
fabio admin list-domain-workspaces --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID

Read-only · Returns list

Assign workspaces to a domain

Terminal window
fabio admin assign-domain-workspaces --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID
--workspace-ids string No Workspace IDs (comma-separated)

Mutates state · Returns void

Unassign workspaces from a domain

Terminal window
fabio admin unassign-domain-workspaces --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID
--workspace-ids string No Workspace IDs (comma-separated)

Mutates state · Returns void

Unassign all workspaces from a domain

Terminal window
fabio admin unassign-all-domain-workspaces --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID

Mutates state · Returns void

List role assignments for a domain

Terminal window
fabio admin list-domain-role-assignments --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID

Read-only · Returns list

Bulk-assign roles to a domain

Terminal window
fabio admin bulk-assign-domain-roles --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID
--file string No Path to JSON file with role assignments
--content string No Inline JSON content with role assignments

Mutates state · Returns void

Bulk-unassign roles from a domain

Terminal window
fabio admin bulk-unassign-domain-roles --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID
--file string No Path to JSON file with role unassignments
--content string No Inline JSON content with role unassignments

Mutates state · Returns void

Sync domain role assignments to subdomains

Terminal window
fabio admin sync-domain-roles-to-subdomains --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID
--role string No Role to sync (Contributor or Admin). Note: syncing Admins is not supported by the API

Mutates state · Returns void

Assign workspaces to a domain by capacities

Terminal window
fabio admin assign-domain-workspaces-by-capacities --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID
--capacity-ids string No Capacity IDs (comma-separated)

Mutates state · Returns void

Assign workspaces to a domain by principals

Terminal window
fabio admin assign-domain-workspaces-by-principals --domain-id <value>
Flag Type Required Description
--domain-id string Yes Domain ID
--principal-ids string No Principal IDs (comma-separated)
--principal-type string No Principal type (User, Group, ServicePrincipal, ServicePrincipalProfile)

Mutates state · Returns void

List access details for a user

Terminal window
fabio admin list-user-access --user-id <value>
Flag Type Required Description
--user-id string Yes User ID

Read-only · Returns list