Edit

Share via

Tenants - List Tenant Settings

Service:
Admin
API Version:
v1

Returns a list of the tenant settings.

Permissions

The caller must be a Fabric administrator or authenticate using a service principal.

Required Delegated Scopes

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 25 requests per minute.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/tenantsettings
With optional parameters: 
GET https://api.fabric.microsoft.com/v1/admin/tenantsettings?continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
continuationToken
 query

string

A token for retrieving the next page of results.

Responses

Name Type Description
200 OK

TenantSettings

OK. The operation was successful.
Other Status Codes

ErrorResponse

Common error codes:

  • Forbidden - The caller doesn't have permissions to call the API.

Examples

List tenant settings example

Sample request

GET https://api.fabric.microsoft.com/v1/admin/tenantsettings

Sample response

Status code:
200 
{
  "value": [
    {
      "settingName": "AdminApisIncludeDetailedMetadata",
      "title": "Enhance admin APIs responses with detailed metadata",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "tenantSettingGroup": "AdminApiSettings"
    },
    {
      "settingName": "DatamartTenant",
      "title": "Create Datamarts (Preview)",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "enabledSecurityGroups": [
        {
          "graphId": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
          "name": "TestComputeCdsa"
        },
        {
          "graphId": "1fecf19f-6e33-41b3-89fa-de8c821f3b79",
          "name": "TestComputeGroup2"
        },
        {
          "graphId": "64bc10f1-1f1b-4a7e-b7a0-c87d89cba2b4",
          "name": "TestCertifiers"
        }
      ],
      "tenantSettingGroup": "DatamartSettings"
    },
    {
      "settingName": "CertifyDatasets",
      "title": "Certification",
      "enabled": true,
      "canSpecifySecurityGroups": true,
      "tenantSettingGroup": "ExportAndSharing"
    }
  ]
}

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
TenantSetting

Tenant level setting details.
TenantSettingProperty

Tenant setting property.
TenantSettingPropertyType

Tenant setting property type. Additional tenant setting property types may be added over time.
TenantSettings

A list of tenant settings.
TenantSettingSecurityGroup

Tenant setting security group.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

TenantSetting

Object

Tenant level setting details.

Name Type Description
canSpecifySecurityGroups

boolean

Indicates if the tenant setting is enabled for a security group. False - The tenant setting is enabled for the entire organization. True - The tenant setting is enabled for security groups.
delegateToCapacity

boolean

Indicates whether the tenant setting can be delegated to a capacity admin. False - Capacity admin cannot override the tenant setting. True - Capacity admin can override the tenant setting.
delegateToDomain

boolean

Indicates whether the tenant setting can be delegated to a domain admin. False - Domain admin cannot override the tenant setting. True - Domain admin can override the tenant setting.
delegateToWorkspace

boolean

Indicates whether the tenant setting can be delegated to a workspace admin. False - Workspace admin cannot override the tenant setting. True - Workspace admin can override the tenant setting.
enabled

boolean

The status of the tenant setting. False - Disabled, True - Enabled.
enabledSecurityGroups

TenantSettingSecurityGroup[]

A list of enabled security groups.
excludedSecurityGroups

TenantSettingSecurityGroup[]

A list of excluded security groups.
properties

TenantSettingProperty[]

Tenant setting properties.
settingName

string

The name of the tenant setting.
tenantSettingGroup

string

Tenant setting group name.
title

string

The title of the tenant setting.

TenantSettingProperty

Object

Tenant setting property.

Name Type Description
name

string

The name of the property.
type

TenantSettingPropertyType

The type of the property.
value

string

The value of the property.

TenantSettingPropertyType

Enumeration

Tenant setting property type. Additional tenant setting property types may be added over time.

Value Description
FreeText

UI accepts any string for the text box.
Url

UI accepts only URLs for the text box.
Boolean

A checkbox in the UI.
MailEnabledSecurityGroup

UI accepts only email enabled security groups for the text box.
Integer

UI accepts only integers for the text box.

TenantSettings

Object

A list of tenant settings.

Name Type Description
continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.
value

TenantSetting[]

A list of tenant settings.

TenantSettingSecurityGroup

Object

Tenant setting security group.

Name Type Description
graphId

string

The graph ID of the security group.
name

string

The name of the security group.