CRcrunchtime
Authentication Service

validate-user

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

post/ces-auth/validate-user

Request

  • Base URL
    //webservices-test.net-chef.com (relative, and the document’s source URL is not known)
  • URL
    //webservices-test.net-chef.com/ces-auth/validate-user
  • Auth
    none declared. Required headers: authenticationtoken, sitename

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"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.