Signs a client user in and returns a bearer access token.
/api/{version}/Authenticate/ClientLoginBad credentials are reported as 401 Unauthorized, a deactivated account as 403 Forbidden and a locked-out account as 423 Locked. The failure body keeps the pnErrorHandle shape, so existing callers can still read the reason from the payload.
Request body
application/json
The username and password to authenticate.
- usernamestring · nullable
The username provided by your account manager.
- passwordstring · nullable
The password provided by your account manager.
Responses
- 200OKobject
Success
2 fields
- accessTokenstring · nullable
Bearer access token for the other endpoints. Valid for 4 hours.
- pnErrorHandleobject · nullable
2 fields
- isSuccessboolean
- errorMessagestring · nullable
- 400Bad Requestobject
Bad Request
6 fields
- typestring · nullable
- titlestring · nullable
- statusinteger (int32) · nullable
- detailstring · nullable
- instancestring · nullable
- errorsmap of array of string · nullable · read-only
- 401Unauthorizedobject
Unauthorized
2 fields
- accessTokenstring · nullable
Bearer access token for the other endpoints. Valid for 4 hours.
- pnErrorHandleobject · nullable
2 fields
- isSuccessboolean
- errorMessagestring · nullable
- 403Forbiddenobject
Forbidden
2 fields
- accessTokenstring · nullable
Bearer access token for the other endpoints. Valid for 4 hours.
- pnErrorHandleobject · nullable
2 fields
- isSuccessboolean
- errorMessagestring · nullable
- 423Lockedobject
Client Error
2 fields
- accessTokenstring · nullable
Bearer access token for the other endpoints. Valid for 4 hours.
- pnErrorHandleobject · nullable
2 fields
- isSuccessboolean
- errorMessagestring · nullable
- 500Internal Server Errorobject
Server Error
5 fields
- typestring · nullable
- titlestring · nullable
- statusinteger (int32) · nullable
- detailstring · nullable
- instancestring · nullable
Generated from openapi/v1/openapi.yaml at commit 21510e0.