json icon

Authenticate Customer

v1.0.0commands

Command to authenticate a customer with their credentials.

1{
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "AuthenticateCustomer",
4  "description": "Command to authenticate a customer with their credentials, and the token returned",
5  "type": "object",
6  "properties": {
7    "request": {
8      "description": "The credentials to authenticate",
9      "type": "object",
10      "properties": {
11        "email": {
12          "type": "string",
13          "format": "email"
14        },
15        "password": {
16          "type": "string"
17        }
18      },
19      "required": ["email", "password"]
20    },
21    "response": {
22      "description": "The access token issued on a successful sign-in",
23      "type": "object",
24      "properties": {
25        "accessToken": {
26          "type": "string"
27        },
28        "tokenType": {
29          "type": "string",
30          "enum": ["Bearer"]
31        },
32        "expiresIn": {
33          "description": "Token lifetime in seconds",
34          "type": "integer"
35        }
36      },
37      "required": ["accessToken", "tokenType", "expiresIn"]
38    }
39  },
40  "required": ["request", "response"]
41}
42

Details

Format
JSON Schema
Resource
commands
Filename
schema.json

Versions