REST API
SOAP API
FAQ
Changelog
Terms & Conditions
Help Center
REST API
SOAP API
FAQ
Changelog
Terms & Conditions
Help Center
  • Common Datatypes
  • AccountService Datatypes
  • AttachmentService Datatypes
  • AuthenticateService Datatypes
  • BudgetService Datatypes
  • ClientService Datatypes
  • CompanyService Datatypes
  • FileService Datatypes
  • InvoiceService Datatypes
  • PaymentService Datatypes
  • PersonService Datatypes
  • ProductService Datatypes
  • ProjectService Datatypes
  • SalesOppService DataTypes
  • TemplateService DataTypes
  • TimeService Datatypes
  • TransactionService DataTypes

AuthenticateService Datatypes

Back to AuthenticationService

Credential

PropertyTypeDescription
UsernameStringUser Name
PasswordStringPassword
ApplicationIdGuidRequired
IdentityIdGuidIf set, the login will automatically pick the client which the identity Id is connected to,else it will pick the default

Identity

PropertyTypeDescription
ClientClientClient
IdGuidThe Identity ID
UserUser
IsCurrentBoolean
IsDefaultBoolean
IsProtectedBooleanDeprecated. This is a legacy property.
ServersServer[]

User

PropertyTypeDescription
ContactIdIntContact Id
IdGuidGuid
NameString
EmployeeIdInt

Client

PropertyTypeDescription
IdLongClient Id
NameString

Token

PropertyTypeDescription
IdGuidThe actual token id
ApplicationIdGuid

Passport

PropertyTypeDescription
IdGuid
EmailString
SessionIdStringThe current session’s id
IdentitiesIdentity[]A list of all identities

Back to AuthenticationService

Last Updated: 1/24/24, 8:37 AM
Prev
AttachmentService Datatypes
Next
BudgetService Datatypes