Share via

Tenants - Get

  • Reference
Service:
Azure Sphere Public API
API Version:
v2

Gets tenant details by ID.

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}

URI Parameters

Name In Required Type Description
tenantId
 path True

string

The Azure Sphere tenant ID.

Responses

Name Type Description
200 OK

TenantIdentity

Success.

Examples

Get tenant details

Sample Request

GET https://prod.core.sphere.azure.net/v2/tenants/768c2cd6-1bf0-4521-9f53-084a331d81cb

Sample Response

Status code:
200 
{
  "Id": "768c2cd6-1bf0-4521-9f53-084a331d81cb",
  "Name": "ContosoTenant",
  "Roles": [
    "Administrator",
    "Contributor"
  ]
}

Definitions

TenantIdentity

Name Type Description
Id

string

Gets the Id of the tenant.
Name

string

Get the friendly name of the tenant.
Roles

string[]

Get the roles of the user in the tenant.