Authenticate Test
Security/Authenticate
NOTE: THIS IS FOR TESSITURA USE ONLY. Custom implementations of this endpoint are not supported. Authenticate the provided credentials
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Security/Authenticate

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : AuthenticationRequest

Request object type AuthenticationRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Application string N
MachineLocation string N
Password string Y
UserGroup string N
UserName string Y 
{
  "UserName": "sample string 1",
  "UserGroup": "sample string 2",
  "Password": "sample string 3",
  "MachineLocation": "sample string 4",
  "Application": "sample string 5"
}
<AuthenticationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Application>sample string 5</Application>
  <MachineLocation>sample string 4</MachineLocation>
  <Password>sample string 3</Password>
  <UserGroup>sample string 2</UserGroup>
  <UserName>sample string 1</UserName>
</AuthenticationRequest>

Response object type : AuthenticationResponse

Response object type AuthenticationResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
CurrentLoginCount integer
IsAuthenticated boolean
MachineLocation string
Message string
MustChangePassword boolean
User User
UserGroup UserGroupSummary 
{
  "IsAuthenticated": true,
  "UserGroup": {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "IsAdmin": true,
    "AllowApp": true,
    "AllowTablet": true,
    "AllowOnTheGo": true,
    "AllowAnalytics": true,
    "Division": {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Organization": {
        "Id": 1,
        "Description": "sample string 1",
        "LicenseeAccountCode": "sample string 2"
      }
    }
  },
  "User": {
    "Id": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "EmailAddress": "sample string 4",
    "Inactive": true,
    "WorkerConstituentId": 1,
    "Locked": true,
    "ActiveDirectoryUserName": "sample string 7",
    "LoginCount": 8,
    "MaxLogins": 9
  },
  "MustChangePassword": true,
  "MachineLocation": "sample string 3",
  "CurrentLoginCount": 4,
  "Message": "sample string 5"
}
<AuthenticationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentLoginCount>4</CurrentLoginCount>
  <IsAuthenticated>true</IsAuthenticated>
  <MachineLocation>sample string 3</MachineLocation>
  <Message>sample string 5</Message>
  <MustChangePassword>true</MustChangePassword>
  <User>
    <ActiveDirectoryUserName>sample string 7</ActiveDirectoryUserName>
    <EmailAddress>sample string 4</EmailAddress>
    <FirstName>sample string 2</FirstName>
    <Id>sample string 1</Id>
    <Inactive>true</Inactive>
    <LastName>sample string 3</LastName>
    <Locked>true</Locked>
    <LoginCount>8</LoginCount>
    <MaxLogins>9</MaxLogins>
    <WorkerConstituentId>1</WorkerConstituentId>
  </User>
  <UserGroup>
    <AllowAnalytics>true</AllowAnalytics>
    <AllowApp>true</AllowApp>
    <AllowOnTheGo>true</AllowOnTheGo>
    <AllowTablet>true</AllowTablet>
    <Description>sample string 3</Description>
    <Division>
      <Description>sample string 3</Description>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <Organization>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <LicenseeAccountCode>sample string 2</LicenseeAccountCode>
      </Organization>
    </Division>
    <Id>sample string 1</Id>
    <IsAdmin>true</IsAdmin>
    <Name>sample string 2</Name>
  </UserGroup>
</AuthenticationResponse>
Change Version Description Contract Old New
Property Added 15.0.0 CurrentLoginCount has been added to AuthenticationResponse AuthenticationResponse AuthenticationResponse.CurrentLoginCount
Property Added 15.0.0 MachineLocation has been added to AuthenticationResponse AuthenticationResponse AuthenticationResponse.MachineLocation
Property Added 15.0.0 Message has been added to AuthenticationResponse AuthenticationResponse AuthenticationResponse.Message
Property Added 15.0.0 MustChangePassword has been added to AuthenticationResponse AuthenticationResponse AuthenticationResponse.MustChangePassword
Property Added 15.0.0 Application has been added to AuthenticationRequest AuthenticationRequest AuthenticationRequest.Application