Admin - Get Power BI Encryption Keys

Returns the encryption keys for the tenant.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/admin/tenantKeys

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/tenantKeys

Sample Response

{
  "value": [
    {
      "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
      "name": "Contoso Sales",
      "keyVaultKeyIdentifier": "https://contoso-vault2.vault.azure.net/keys/ContosoKeyVault/b2ab4ba1c7b341eea5ecaaa2wb54c4d2",
      "isDefault": true,
      "createdAt": "2019-04-30T21:35:15.867-07:00",
      "updatedAt": "2019-04-30T21:35:15.867-07:00"
    }
  ]
}

Definitions

TenantKey

Encryption key information

TenantKeys

Encryption keys information

TenantKey

Encryption key information

Name Type Description
createdAt
  • string

The creation time of the encryption key

id
  • string

The ID of the encryption key

isDefault
  • boolean

Whether the encryption key is the default key for the entire tenant. Any newly created capacity inherits the default key.

keyVaultKeyIdentifier
  • string

The URI that uniquely specifies the encryption key in Azure Key Vault

name
  • string

The name of the encryption key

updatedAt
  • string

The last update time of the encryption key

TenantKeys

Encryption keys information

Name Type Description
odata.context
  • string
value

Encryption keys