GET api/v1/Reports/CsvUpload/GetTenantInfobyTenantName?tenantName={tenantName}

Gets the tenantId by TenantName

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tenantName

TenantName

 string

Required
version

string

None.

Body Parameters

None.

Response Information

Resource Description

Int

Tenant
NameDescriptionTypeAdditional information
ID

integer

None.
Name

string

None.
TenantSlugName

string

None.
ConnectionString

string

None.
ContainerName

string

None.
SiteName

string

None.
HeaderLogoImageUrl

string

None.
CSSUrl

string

None.
SecurityProviderName

string

None.
HeaderImageUrl

string

None.
IsFooterVisible

boolean

None.
TenantURL

string

None.
LoginURL

string

None.
EmailServerName

string

None.
ServerUserName

string

None.
ServerPassword

string

None.
TermsOfService

string

None.
Attributes

Dictionary of string [key] and Object [value]

None.
ConfirmationUrl

string

None.
PaymentUrl

string

None.
LogoutUrl

string

None.
LogoUrl

string

None.
Status

string

None.
AADUMConfig

string

None.
SAML2AuthServiceUrl

string

None.
AADConfig

AADConfig

None.
SAMLConfig

SAMLConfig

None.
ThemeData

ThemeData

None.
IsSAMLTenant

boolean

None.
IsHybrid

boolean

None.
IsTrailVersion

boolean

None.
IsPasswordExpiration

boolean

None.
TrailEndDate

string

None.
DeviceCount

integer

None.
WorkflowData

string

None.
ShortcutKeys

Collection of string

None.
MobileHotkeys

Collection of string

None.
WebHotkeys

Collection of string

None.
ActiveFeatures

Collection of string

None.
PasswordExpirationInDays

integer

None.
SignalRNegotiateUrl

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ID": 1,
  "Name": "sample string 2",
  "TenantSlugName": "sample string 3",
  "ConnectionString": "sample string 4",
  "ContainerName": "sample string 5",
  "SiteName": "sample string 6",
  "HeaderLogoImageUrl": "sample string 7",
  "CSSUrl": "sample string 8",
  "SecurityProviderName": "sample string 9",
  "HeaderImageUrl": "sample string 10",
  "IsFooterVisible": true,
  "TenantURL": "sample string 12",
  "LoginURL": "sample string 13",
  "EmailServerName": "sample string 14",
  "ServerUserName": "sample string 15",
  "ServerPassword": "sample string 16",
  "TermsOfService": "sample string 17",
  "Attributes": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "ConfirmationUrl": "sample string 18",
  "PaymentUrl": "sample string 19",
  "LogoutUrl": "sample string 20",
  "LogoUrl": "sample string 21",
  "Status": "sample string 22",
  "AADUMConfig": "sample string 23",
  "SAML2AuthServiceUrl": "sample string 24",
  "AADConfig": {
    "Domain": "sample string 1",
    "AdminLoginId": "sample string 2",
    "AuthorizationType": 0,
    "DefaultRole": "sample string 3",
    "GroupName": "sample string 4",
    "IsAdminConsentGiven": true,
    "ImportType": 0,
    "IdentityType": 0
  },
  "SAMLConfig": {
    "IdentityType": 0,
    "IdpType": 0,
    "TenantType": 0,
    "IDPEndPoint": "sample string 1",
    "AppIdUrl": "sample string 2",
    "Mapping": "sample string 3",
    "SamlCertkey": "sample string 4",
    "SamlCertpath": "sample string 5",
    "AdvancedSettings": "sample string 6",
    "IDPLogOutEndPoint": "sample string 7"
  },
  "ThemeData": {
    "IsCustomSetting": true,
    "CustomData": {
      "LogoImage": "sample string 1",
      "OrganizationName": "sample string 2",
      "BGColor": "sample string 3",
      "PaneColor": "sample string 4",
      "TabOnSelect": "sample string 5",
      "TabDisable": "sample string 6",
      "TextColor": "sample string 7",
      "BackgroundImageUrl": "sample string 8",
      "PrimaryColor1": "sample string 9",
      "PrimaryColor2": "sample string 10",
      "PrimaryColor3": "sample string 11",
      "PrimaryColor4": "sample string 12",
      "SecondaryColor": "sample string 13"
    },
    "IsDarkHeaderRequired": true
  },
  "IsSAMLTenant": true,
  "IsHybrid": true,
  "IsTrailVersion": true,
  "IsPasswordExpiration": true,
  "TrailEndDate": "sample string 29",
  "DeviceCount": 30,
  "WorkflowData": "sample string 31",
  "ShortcutKeys": [
    "sample string 1",
    "sample string 2"
  ],
  "MobileHotkeys": [
    "sample string 1",
    "sample string 2"
  ],
  "WebHotkeys": [
    "sample string 1",
    "sample string 2"
  ],
  "ActiveFeatures": [
    "sample string 1",
    "sample string 2"
  ],
  "PasswordExpirationInDays": 32,
  "SignalRNegotiateUrl": "sample string 33"
}

text/html

Sample: 
{"ID":1,"Name":"sample string 2","TenantSlugName":"sample string 3","ConnectionString":"sample string 4","ContainerName":"sample string 5","SiteName":"sample string 6","HeaderLogoImageUrl":"sample string 7","CSSUrl":"sample string 8","SecurityProviderName":"sample string 9","HeaderImageUrl":"sample string 10","IsFooterVisible":true,"TenantURL":"sample string 12","LoginURL":"sample string 13","EmailServerName":"sample string 14","ServerUserName":"sample string 15","ServerPassword":"sample string 16","TermsOfService":"sample string 17","Attributes":{"sample string 1":{},"sample string 3":{}},"ConfirmationUrl":"sample string 18","PaymentUrl":"sample string 19","LogoutUrl":"sample string 20","LogoUrl":"sample string 21","Status":"sample string 22","AADUMConfig":"sample string 23","SAML2AuthServiceUrl":"sample string 24","AADConfig":{"Domain":"sample string 1","AdminLoginId":"sample string 2","AuthorizationType":0,"DefaultRole":"sample string 3","GroupName":"sample string 4","IsAdminConsentGiven":true,"ImportType":0,"IdentityType":0},"SAMLConfig":{"IdentityType":0,"IdpType":0,"TenantType":0,"IDPEndPoint":"sample string 1","AppIdUrl":"sample string 2","Mapping":"sample string 3","SamlCertkey":"sample string 4","SamlCertpath":"sample string 5","AdvancedSettings":"sample string 6","IDPLogOutEndPoint":"sample string 7"},"ThemeData":{"IsCustomSetting":true,"CustomData":{"LogoImage":"sample string 1","OrganizationName":"sample string 2","BGColor":"sample string 3","PaneColor":"sample string 4","TabOnSelect":"sample string 5","TabDisable":"sample string 6","TextColor":"sample string 7","BackgroundImageUrl":"sample string 8","PrimaryColor1":"sample string 9","PrimaryColor2":"sample string 10","PrimaryColor3":"sample string 11","PrimaryColor4":"sample string 12","SecondaryColor":"sample string 13"},"IsDarkHeaderRequired":true},"IsSAMLTenant":true,"IsHybrid":true,"IsTrailVersion":true,"IsPasswordExpiration":true,"TrailEndDate":"sample string 29","DeviceCount":30,"WorkflowData":"sample string 31","ShortcutKeys":["sample string 1","sample string 2"],"MobileHotkeys":["sample string 1","sample string 2"],"WebHotkeys":["sample string 1","sample string 2"],"ActiveFeatures":["sample string 1","sample string 2"],"PasswordExpirationInDays":32,"SignalRNegotiateUrl":"sample string 33"}

text/xml

Sample: 
<Tenant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
  <AADConfig>
    <AdminLoginId>sample string 2</AdminLoginId>
    <AuthorizationType>UserLevel</AuthorizationType>
    <DefaultRole>sample string 3</DefaultRole>
    <Domain>sample string 1</Domain>
    <GroupName>sample string 4</GroupName>
    <IdentityType>IDP</IdentityType>
    <ImportType>ImportUserBasicProfile</ImportType>
    <IsAdminConsentGiven>true</IsAdminConsentGiven>
  </AADConfig>
  <AADUMConfig>sample string 23</AADUMConfig>
  <ActiveFeatures xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ActiveFeatures>
  <Attributes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Attributes>
  <CSSUrl>sample string 8</CSSUrl>
  <ConfirmationUrl>sample string 18</ConfirmationUrl>
  <ConnectionString>sample string 4</ConnectionString>
  <ContainerName>sample string 5</ContainerName>
  <DeviceCount>30</DeviceCount>
  <EmailServerName>sample string 14</EmailServerName>
  <HeaderImageUrl>sample string 10</HeaderImageUrl>
  <HeaderLogoImageUrl>sample string 7</HeaderLogoImageUrl>
  <ID>1</ID>
  <IsFooterVisible>true</IsFooterVisible>
  <IsHybrid>true</IsHybrid>
  <IsPasswordExpiration>true</IsPasswordExpiration>
  <IsSAMLTenant>true</IsSAMLTenant>
  <IsTrailVersion>true</IsTrailVersion>
  <LoginURL>sample string 13</LoginURL>
  <LogoUrl>sample string 21</LogoUrl>
  <LogoutUrl>sample string 20</LogoutUrl>
  <MobileHotkeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </MobileHotkeys>
  <Name>sample string 2</Name>
  <PasswordExpirationInDays>32</PasswordExpirationInDays>
  <PaymentUrl>sample string 19</PaymentUrl>
  <SAML2AuthServiceUrl>sample string 24</SAML2AuthServiceUrl>
  <SAMLConfig>
    <AdvancedSettings>sample string 6</AdvancedSettings>
    <AppIdUrl>sample string 2</AppIdUrl>
    <IDPEndPoint>sample string 1</IDPEndPoint>
    <IDPLogOutEndPoint>sample string 7</IDPLogOutEndPoint>
    <IdentityType>IDP</IdentityType>
    <IdpType>AAD</IdpType>
    <Mapping>sample string 3</Mapping>
    <SamlCertkey>sample string 4</SamlCertkey>
    <SamlCertpath>sample string 5</SamlCertpath>
    <TenantType>SingleTenant</TenantType>
  </SAMLConfig>
  <SecurityProviderName>sample string 9</SecurityProviderName>
  <ServerPassword>sample string 16</ServerPassword>
  <ServerUserName>sample string 15</ServerUserName>
  <ShortcutKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ShortcutKeys>
  <SignalRNegotiateUrl>sample string 33</SignalRNegotiateUrl>
  <SiteName>sample string 6</SiteName>
  <Status>sample string 22</Status>
  <TenantSlugName>sample string 3</TenantSlugName>
  <TenantURL>sample string 12</TenantURL>
  <TermsOfService>sample string 17</TermsOfService>
  <ThemeData>
    <CustomData>
      <BGColor>sample string 3</BGColor>
      <BackgroundImageUrl>sample string 8</BackgroundImageUrl>
      <LogoImage>sample string 1</LogoImage>
      <OrganizationName>sample string 2</OrganizationName>
      <PaneColor>sample string 4</PaneColor>
      <PrimaryColor1>sample string 9</PrimaryColor1>
      <PrimaryColor2>sample string 10</PrimaryColor2>
      <PrimaryColor3>sample string 11</PrimaryColor3>
      <PrimaryColor4>sample string 12</PrimaryColor4>
      <SecondaryColor>sample string 13</SecondaryColor>
      <TabDisable>sample string 6</TabDisable>
      <TabOnSelect>sample string 5</TabOnSelect>
      <TextColor>sample string 7</TextColor>
    </CustomData>
    <IsCustomSetting>true</IsCustomSetting>
    <IsDarkHeaderRequired>true</IsDarkHeaderRequired>
  </ThemeData>
  <TrailEndDate>sample string 29</TrailEndDate>
  <WebHotkeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WebHotkeys>
  <WorkflowData>sample string 31</WorkflowData>
</Tenant>