POST Users/ValidateCredentials
Validate user credentials. User needs to be allowed same projects that the API Consumer making this call is allowed. If credentials are valid a fully populated AuthenticatedUser object is returned. Some APIs may require an Authentication Token. Use this API to get an Authentication Token for that user.
Request Information
URI Parameters
None.
Body Parameters
The authentication user.
Smg.RestApi.Model.Users.UserCredentialsRepresents authentication credentials for a user
Request Formats
application/json, text/json
Sample:
{
"Username": "sample string 1",
"Password": "sample string 2",
"DeviceToken": "sample string 3"
}
application/xml, text/xml
Sample:
<UserCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Smg.RestApi.Model.Users"> <DeviceToken>sample string 3</DeviceToken> <Password>sample string 2</Password> <Username>sample string 1</Username> </UserCredentials>
Response Information
Resource Description
Smg.RestApi.Model.Users.AuthenticatedUserA user that has been authenticated with the system. When a user's credentials are validated an Authentication token will be generated. This token will be the value for a required HTTP header for APIs that do user specific things. The Authentication Token has an expiration date and it is only good until that date. After that, the user's credentials will need to be validated again to generate another token.
Response Formats
application/json, text/json
Sample:
{
"AuthenticationToken": "sample string 1",
"AuthenticationTokenCreated": "2024-04-23T23:08:37.61335-05:00",
"AuthenticationTokenExpires": "2024-04-23T23:08:37.6234435-05:00",
"Id": 4,
"Username": "sample string 5",
"DisplayName": "sample string 6",
"EmailAddress": "sample string 7",
"Tasks": [
"sample string 1",
"sample string 2"
],
"Projects": [
{
"Id": 1,
"ProjectDefinedId": "sample string 2",
"ProjectName": "sample string 3",
"AccessLevel": "sample string 4",
"Languages": [
{
"LanguageId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"IsLTR": true,
"ISOCode": "sample string 5"
},
{
"LanguageId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"IsLTR": true,
"ISOCode": "sample string 5"
}
],
"ReportingGroups": [
{
"GroupName": "sample string 1",
"QuickscoreCount": 2,
"HasQuickscores": true
},
{
"GroupName": "sample string 1",
"QuickscoreCount": 2,
"HasQuickscores": true
}
],
"UnitCount": 5
},
{
"Id": 1,
"ProjectDefinedId": "sample string 2",
"ProjectName": "sample string 3",
"AccessLevel": "sample string 4",
"Languages": [
{
"LanguageId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"IsLTR": true,
"ISOCode": "sample string 5"
},
{
"LanguageId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"IsLTR": true,
"ISOCode": "sample string 5"
}
],
"ReportingGroups": [
{
"GroupName": "sample string 1",
"QuickscoreCount": 2,
"HasQuickscores": true
},
{
"GroupName": "sample string 1",
"QuickscoreCount": 2,
"HasQuickscores": true
}
],
"UnitCount": 5
}
],
"UnauthorizedProjects": [
{
"Id": 1,
"ProjectDefinedId": "sample string 2",
"ProjectName": "sample string 3",
"AccessLevel": "sample string 4",
"Languages": [
{
"LanguageId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"IsLTR": true,
"ISOCode": "sample string 5"
},
{
"LanguageId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"IsLTR": true,
"ISOCode": "sample string 5"
}
],
"ReportingGroups": [
{
"GroupName": "sample string 1",
"QuickscoreCount": 2,
"HasQuickscores": true
},
{
"GroupName": "sample string 1",
"QuickscoreCount": 2,
"HasQuickscores": true
}
],
"UnitCount": 5
},
{
"Id": 1,
"ProjectDefinedId": "sample string 2",
"ProjectName": "sample string 3",
"AccessLevel": "sample string 4",
"Languages": [
{
"LanguageId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"IsLTR": true,
"ISOCode": "sample string 5"
},
{
"LanguageId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"IsLTR": true,
"ISOCode": "sample string 5"
}
],
"ReportingGroups": [
{
"GroupName": "sample string 1",
"QuickscoreCount": 2,
"HasQuickscores": true
},
{
"GroupName": "sample string 1",
"QuickscoreCount": 2,
"HasQuickscores": true
}
],
"UnitCount": 5
}
],
"RequiresPasswordUpdate": true,
"RequiresSecurePassword": true
}
application/xml, text/xml
Sample:
<AuthenticatedUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Smg.RestApi.Model.Users">
<DisplayName>sample string 6</DisplayName>
<EmailAddress>sample string 7</EmailAddress>
<Id>4</Id>
<Projects xmlns:d2p1="http://schemas.datacontract.org/2004/07/Smg.RestApi.Model">
<d2p1:Project>
<d2p1:AccessLevel>sample string 4</d2p1:AccessLevel>
<d2p1:Id>1</d2p1:Id>
<d2p1:Languages>
<d2p1:Language>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:ISOCode>sample string 5</d2p1:ISOCode>
<d2p1:IsLTR>true</d2p1:IsLTR>
<d2p1:LanguageId>1</d2p1:LanguageId>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:Language>
<d2p1:Language>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:ISOCode>sample string 5</d2p1:ISOCode>
<d2p1:IsLTR>true</d2p1:IsLTR>
<d2p1:LanguageId>1</d2p1:LanguageId>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:Language>
</d2p1:Languages>
<d2p1:ProjectDefinedId>sample string 2</d2p1:ProjectDefinedId>
<d2p1:ProjectName>sample string 3</d2p1:ProjectName>
<d2p1:ReportingGroups>
<d2p1:ReportingGroup>
<d2p1:GroupName>sample string 1</d2p1:GroupName>
<d2p1:HasQuickscores>true</d2p1:HasQuickscores>
<d2p1:QuickscoreCount>2</d2p1:QuickscoreCount>
</d2p1:ReportingGroup>
<d2p1:ReportingGroup>
<d2p1:GroupName>sample string 1</d2p1:GroupName>
<d2p1:HasQuickscores>true</d2p1:HasQuickscores>
<d2p1:QuickscoreCount>2</d2p1:QuickscoreCount>
</d2p1:ReportingGroup>
</d2p1:ReportingGroups>
<d2p1:UnitCount>5</d2p1:UnitCount>
</d2p1:Project>
<d2p1:Project>
<d2p1:AccessLevel>sample string 4</d2p1:AccessLevel>
<d2p1:Id>1</d2p1:Id>
<d2p1:Languages>
<d2p1:Language>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:ISOCode>sample string 5</d2p1:ISOCode>
<d2p1:IsLTR>true</d2p1:IsLTR>
<d2p1:LanguageId>1</d2p1:LanguageId>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:Language>
<d2p1:Language>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:ISOCode>sample string 5</d2p1:ISOCode>
<d2p1:IsLTR>true</d2p1:IsLTR>
<d2p1:LanguageId>1</d2p1:LanguageId>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:Language>
</d2p1:Languages>
<d2p1:ProjectDefinedId>sample string 2</d2p1:ProjectDefinedId>
<d2p1:ProjectName>sample string 3</d2p1:ProjectName>
<d2p1:ReportingGroups>
<d2p1:ReportingGroup>
<d2p1:GroupName>sample string 1</d2p1:GroupName>
<d2p1:HasQuickscores>true</d2p1:HasQuickscores>
<d2p1:QuickscoreCount>2</d2p1:QuickscoreCount>
</d2p1:ReportingGroup>
<d2p1:ReportingGroup>
<d2p1:GroupName>sample string 1</d2p1:GroupName>
<d2p1:HasQuickscores>true</d2p1:HasQuickscores>
<d2p1:QuickscoreCount>2</d2p1:QuickscoreCount>
</d2p1:ReportingGroup>
</d2p1:ReportingGroups>
<d2p1:UnitCount>5</d2p1:UnitCount>
</d2p1:Project>
</Projects>
<RequiresPasswordUpdate>true</RequiresPasswordUpdate>
<RequiresSecurePassword>true</RequiresSecurePassword>
<Tasks xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Tasks>
<UnauthorizedProjects xmlns:d2p1="http://schemas.datacontract.org/2004/07/Smg.RestApi.Model">
<d2p1:Project>
<d2p1:AccessLevel>sample string 4</d2p1:AccessLevel>
<d2p1:Id>1</d2p1:Id>
<d2p1:Languages>
<d2p1:Language>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:ISOCode>sample string 5</d2p1:ISOCode>
<d2p1:IsLTR>true</d2p1:IsLTR>
<d2p1:LanguageId>1</d2p1:LanguageId>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:Language>
<d2p1:Language>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:ISOCode>sample string 5</d2p1:ISOCode>
<d2p1:IsLTR>true</d2p1:IsLTR>
<d2p1:LanguageId>1</d2p1:LanguageId>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:Language>
</d2p1:Languages>
<d2p1:ProjectDefinedId>sample string 2</d2p1:ProjectDefinedId>
<d2p1:ProjectName>sample string 3</d2p1:ProjectName>
<d2p1:ReportingGroups>
<d2p1:ReportingGroup>
<d2p1:GroupName>sample string 1</d2p1:GroupName>
<d2p1:HasQuickscores>true</d2p1:HasQuickscores>
<d2p1:QuickscoreCount>2</d2p1:QuickscoreCount>
</d2p1:ReportingGroup>
<d2p1:ReportingGroup>
<d2p1:GroupName>sample string 1</d2p1:GroupName>
<d2p1:HasQuickscores>true</d2p1:HasQuickscores>
<d2p1:QuickscoreCount>2</d2p1:QuickscoreCount>
</d2p1:ReportingGroup>
</d2p1:ReportingGroups>
<d2p1:UnitCount>5</d2p1:UnitCount>
</d2p1:Project>
<d2p1:Project>
<d2p1:AccessLevel>sample string 4</d2p1:AccessLevel>
<d2p1:Id>1</d2p1:Id>
<d2p1:Languages>
<d2p1:Language>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:ISOCode>sample string 5</d2p1:ISOCode>
<d2p1:IsLTR>true</d2p1:IsLTR>
<d2p1:LanguageId>1</d2p1:LanguageId>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:Language>
<d2p1:Language>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:ISOCode>sample string 5</d2p1:ISOCode>
<d2p1:IsLTR>true</d2p1:IsLTR>
<d2p1:LanguageId>1</d2p1:LanguageId>
<d2p1:Name>sample string 2</d2p1:Name>
</d2p1:Language>
</d2p1:Languages>
<d2p1:ProjectDefinedId>sample string 2</d2p1:ProjectDefinedId>
<d2p1:ProjectName>sample string 3</d2p1:ProjectName>
<d2p1:ReportingGroups>
<d2p1:ReportingGroup>
<d2p1:GroupName>sample string 1</d2p1:GroupName>
<d2p1:HasQuickscores>true</d2p1:HasQuickscores>
<d2p1:QuickscoreCount>2</d2p1:QuickscoreCount>
</d2p1:ReportingGroup>
<d2p1:ReportingGroup>
<d2p1:GroupName>sample string 1</d2p1:GroupName>
<d2p1:HasQuickscores>true</d2p1:HasQuickscores>
<d2p1:QuickscoreCount>2</d2p1:QuickscoreCount>
</d2p1:ReportingGroup>
</d2p1:ReportingGroups>
<d2p1:UnitCount>5</d2p1:UnitCount>
</d2p1:Project>
</UnauthorizedProjects>
<Username>sample string 5</Username>
<AuthenticationToken>sample string 1</AuthenticationToken>
<AuthenticationTokenCreated>2024-04-23T23:08:37.61335-05:00</AuthenticationTokenCreated>
<AuthenticationTokenExpires>2024-04-23T23:08:37.6234435-05:00</AuthenticationTokenExpires>
</AuthenticatedUser>