POST api/Users/Authenticate

Request Information

URI Parameters

None.

Body Parameters

AuthenticateRequest
NameDescriptionTypeAdditional information
LoginID

string

Required
Password

string

Required

Data type: Password

Request Formats

application/json, text/json

Sample: 
{
  "LoginID": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

Sample: 
<AuthenticateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoldenSea.Entities.Admin">
  <LoginID>sample string 1</LoginID>
  <Password>sample string 2</Password>
</AuthenticateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuthenticateResponse
NameDescriptionTypeAdditional information
Success

boolean

None.
Message

string

None.
User

AdminUser

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Message": "sample string 2",
  "User": {
    "UserID": 1,
    "LoginID": "sample string 2",
    "FullName": "sample string 3",
    "EmailID": "sample string 4",
    "Role": "sample string 5",
    "IsActive": true,
    "MustChangePassword": true,
    "FailedLoginCount": 8,
    "LockedUntil": "2026-11-07T20:18:49.5840199-08:00",
    "LastLoginOn": "2026-11-07T20:18:49.5840199-08:00",
    "CreatedOn": "2026-11-07T20:18:49.5840199-08:00",
    "CreatedBy": "sample string 10",
    "ModifiedOn": "2026-11-07T20:18:49.5840199-08:00",
    "ModifiedBy": "sample string 11",
    "IsLocked": false
  }
}

application/xml, text/xml

Sample: 
<AuthenticateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoldenSea.Entities.Admin">
  <Message>sample string 2</Message>
  <Success>true</Success>
  <User>
    <CreatedBy>sample string 10</CreatedBy>
    <CreatedOn>2026-11-07T20:18:49.5840199-08:00</CreatedOn>
    <EmailID>sample string 4</EmailID>
    <FailedLoginCount>8</FailedLoginCount>
    <FullName>sample string 3</FullName>
    <IsActive>true</IsActive>
    <LastLoginOn>2026-11-07T20:18:49.5840199-08:00</LastLoginOn>
    <LockedUntil>2026-11-07T20:18:49.5840199-08:00</LockedUntil>
    <LoginID>sample string 2</LoginID>
    <ModifiedBy>sample string 11</ModifiedBy>
    <ModifiedOn>2026-11-07T20:18:49.5840199-08:00</ModifiedOn>
    <MustChangePassword>true</MustChangePassword>
    <Role>sample string 5</Role>
    <UserID>1</UserID>
  </User>
</AuthenticateResponse>