Tenants - Get Tenant Settings

Service:

Fabric REST APIs

API Version:

v1

Returns a list of the tenant settings.

Permissions

The user must have administrator rights (such as Office 365 Global Administrator or Fabric Service Administrator).

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

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

Responses

Name	Type	Description
200 OK	TenantSettings	OK. The operation was successful.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred

Examples

Example

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "tenantSettings": [
    {
      "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
ErrorResponse	The error response
ErrorResponseDetails	The error response details
RelatedResource	The related resource details object
TenantSetting	Tenant setting details
TenantSettings	This is response wrapper for a list of tenant settings
TenantSettingSecurityGroup	Tenant setting security group

ErrorResponse

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
errorResponseDetails	ErrorResponseDetails[]	List of additional error details
message	string	A human readable representation of the error
relatedResource	RelatedResource	The related resource details
requestId	string	ID of the request associated with the error

ErrorResponseDetails

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	RelatedResource	The related resource details

RelatedResource

The related resource details object

Name	Type	Description
resourceId	string	The resource ID that is involved in the error
resourceType	string	The type of the resource that is involved in the error

TenantSetting

Tenant setting details

Name	Type	Description
canSpecifySecurityGroups	boolean	Is the tenant setting enabled for security group
enabled	boolean	staus of the tenant setting
enabledSecurityGroups	TenantSettingSecurityGroup	list of enabled security groups
excludedSecurityGroups	TenantSettingSecurityGroup	list of excluded security groups
settingName	string	The name of tenant setting
tenantSettingGroup	string	Tenanant setting group name
title	string	The title of tenant setting

TenantSettings

This is response wrapper for a list of tenant settings

Name	Type	Description
tenantSettings	TenantSetting[]	The list of tenant settings

TenantSettingSecurityGroup

Tenant setting security group

Name	Type	Description
graphId	string	The graph ID of the security group
name	string	The name of the security group