GET api/v2.0/Authentication/GetTenantDetail?communityUrl={communityUrl}

Returns information about a Tenant for a given Connected Community Site Url.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
communityUrl

The Url for a Connected Community Site.

string

Required

Body Parameters

None.

Response Information

Resource Description

Summary Information about a Community Site.

Collection of TenantDetail
NameDescriptionTypeAdditional information
TenantKey

globally unique identifier

None.

FullName

string

None.

ShortName

string

None.

HomePage

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "TenantKey": "74219b03-455f-4073-86e3-740a35c10368",
    "FullName": "sample string 2",
    "ShortName": "sample string 3",
    "HomePage": "sample string 4"
  },
  {
    "TenantKey": "74219b03-455f-4073-86e3-740a35c10368",
    "FullName": "sample string 2",
    "ShortName": "sample string 3",
    "HomePage": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfTenantDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
  <TenantDetail>
    <FullName>sample string 2</FullName>
    <HomePage>sample string 4</HomePage>
    <ShortName>sample string 3</ShortName>
    <TenantKey>74219b03-455f-4073-86e3-740a35c10368</TenantKey>
  </TenantDetail>
  <TenantDetail>
    <FullName>sample string 2</FullName>
    <HomePage>sample string 4</HomePage>
    <ShortName>sample string 3</ShortName>
    <TenantKey>74219b03-455f-4073-86e3-740a35c10368</TenantKey>
  </TenantDetail>
</ArrayOfTenantDetail>