v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Authentication Service

validate-user

Validate user access to a franchisee site using a username and password.

post/ces-auth/validate-user

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Request body

object required

Response

Pass

result'"Fail"' | '"Pass"' required

Result of CES authentication

Example response

{
  "result": "Pass"
}