GET restapi/sites/{customerId}/logindetails/v1

Get login details for an itslearning site by customerId.

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId	The customerId for the site	integer	Required

Body Parameters

None.

Response Information

Resource Description

Itslearning.RestApi.Entities.SiteLoginDetails

Name	Description	Type	Additional information
IsNativeLoginDefault	True if native login is set as default for the site, and false otherwise.	boolean	None.
FederatedLoginProviders	The list of federated login providers for the site.	Collection of Itslearning.RestApi.Entities.FederatedLoginProvider	None.
DisableForgottenPasswordLink	True if the forgotten password link not visible for the site.	boolean	None.
IsParentPortalEnabled	True if the parent portal is enabled for the site.	boolean	None.
IsFronterUpgradedSite	IsFronterUpgradedSite flag.	boolean	None.
IsParentAppEnabled	Determines whether parent app is enabled.	boolean	None.
OrgApiBaseUrl	The Url to Organisation Api (AKA Content Import).	string	None.
CustomerId	The customer id for this site.	integer	None.
Title	The title used for the site.	string	None.
ShortName	The short name used for the site.	string	None.
CultureName	The culture name used for the site.	string	None.
BaseUrl	Base url for the site.	string	None.
IsPersonalRestApiEnabled	Check to see if the Personal API has been enabled for this site.	boolean	None.
ShowCustomerInDropdownList	Flag to identify wheteher customer should appear in dropdown lists.	boolean	None.
CountryCode	The country code for the customer.	string	None.
StateCode	The state code for the customer.	string	None.
Segment	The education segment.	Itsolutions.ItslUtils.Constants.CustomerEducationSegment	None.

Response Formats

application/json, text/json

Sample:

{
  "IsNativeLoginDefault": true,
  "FederatedLoginProviders": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "IconUrl": "sample string 3",
      "OpenInExternalBrowser": true,
      "ButtonText": "sample string 5",
      "LogoutType": 1
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "IconUrl": "sample string 3",
      "OpenInExternalBrowser": true,
      "ButtonText": "sample string 5",
      "LogoutType": 1
    }
  ],
  "DisableForgottenPasswordLink": true,
  "IsParentPortalEnabled": true,
  "IsFronterUpgradedSite": true,
  "IsParentAppEnabled": true,
  "OrgApiBaseUrl": "sample string 6",
  "CustomerId": 7,
  "Title": "sample string 8",
  "ShortName": "sample string 9",
  "CultureName": "sample string 10",
  "BaseUrl": "sample string 11",
  "IsPersonalRestApiEnabled": true,
  "ShowCustomerInDropdownList": true,
  "CountryCode": "sample string 14",
  "StateCode": "sample string 15",
  "Segment": 0
}

application/xml, text/xml

Sample:

<SiteLoginDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BaseUrl>sample string 11</BaseUrl>
  <CountryCode>sample string 14</CountryCode>
  <CultureName>sample string 10</CultureName>
  <CustomerId>7</CustomerId>
  <IsPersonalRestApiEnabled>true</IsPersonalRestApiEnabled>
  <Segment>Higher</Segment>
  <ShortName>sample string 9</ShortName>
  <ShowCustomerInDropdownList>true</ShowCustomerInDropdownList>
  <StateCode>sample string 15</StateCode>
  <Title>sample string 8</Title>
  <IsFronterUpgradedSite>true</IsFronterUpgradedSite>
  <IsParentAppEnabled>true</IsParentAppEnabled>
  <OrgApiBaseUrl>sample string 6</OrgApiBaseUrl>
  <DisableForgottenPasswordLink>true</DisableForgottenPasswordLink>
  <FederatedLoginProviders>
    <FederatedLoginProvider>
      <ButtonText>sample string 5</ButtonText>
      <IconUrl>sample string 3</IconUrl>
      <Id>1</Id>
      <LogoutType>Full</LogoutType>
      <Name>sample string 2</Name>
      <OpenInExternalBrowser>true</OpenInExternalBrowser>
    </FederatedLoginProvider>
    <FederatedLoginProvider>
      <ButtonText>sample string 5</ButtonText>
      <IconUrl>sample string 3</IconUrl>
      <Id>1</Id>
      <LogoutType>Full</LogoutType>
      <Name>sample string 2</Name>
      <OpenInExternalBrowser>true</OpenInExternalBrowser>
    </FederatedLoginProvider>
  </FederatedLoginProviders>
  <IsNativeLoginDefault>true</IsNativeLoginDefault>
  <IsParentPortalEnabled>true</IsParentPortalEnabled>
</SiteLoginDetails>