Tenant - Retrieves a list of tenants

Retrieves a list of all available tenants.

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Responses

200

Success: List of available tenants retrieved successfully.

text/plainapplication/jsontext/json

Class for storing details about tenant.

tenantIdstring · uuidOptional

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the tenantId property.

tenantNamestring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the tenantName property.

servicePrincipalProfileIdstring · uuidOptional

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the servicePrincipalProfileId property.

capacityIdstring · uuid · nullableOptional

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the capacityId property.

defaultThemeIdstring · uuid · nullableOptional

A public property of type nullable Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the DefaultThemeId property.

Default: null

tenantExportConfigstring · nullableOptional

A public property of string type that has both a getter and a setter method, which allows for getting and setting the value of the TenantExportConfig property.

Default: ""

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

get

/tenants

HTTPcURLJavaScriptPython

GET /tenants HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "tenantId": "123e4567-e89b-12d3-a456-426614174000",
    "tenantName": "text",
    "servicePrincipalProfileId": "123e4567-e89b-12d3-a456-426614174000",
    "capacityId": "123e4567-e89b-12d3-a456-426614174000",
    "defaultThemeId": "123e4567-e89b-12d3-a456-426614174000",
    "tenantExportConfig": ""
  }
]