aboutsummaryrefslogtreecommitdiff
path: root/doc/schema/1.0/get_token.json
blob: 5e5bc0059d1fad39202040b4772c48f8acd7e693 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
{
    "$schema": "http://api.kernelci.org/json-schema/1.0/get_token.json",
    "id": "http://api.kernelci.org/json-schema/1.0/get_token.json",
    "title": "token",
    "description": "A token used to interact with the API",
    "type": "object",
    "properties": {
        "version": {
            "type": "string",
            "description": "The version number of this JSON schema",
            "enum": ["1.0"]
        },
        "_id": {
            "type": "string",
            "description": "The ID associated with this object"
        },
        "name": {
            "type": "string",
            "description": "The name associated with this token"
        },
        "created_on": {
            "type": "object",
            "description": "Creation date of the object",
            "properties": {
                "$date": {
                    "type": "number",
                    "description": "Milliseconds from epoch time"
                }
            }
        },
        "token": {
            "type": "string",
            "description": "The token that will be used to interact with the API"
        },
        "expires_on": {
            "type": "object",
            "description": "The date when the token is supposed to expire",
            "properties": {
                "$date": {
                    "type": "number",
                    "description": "Milliseconds from epoch time"
                }
            }
        },
        "expired": {
            "type": "boolean",
            "description": "If the token has expired"
        },
        "username": {
            "type": "string",
            "description": "The user name associated with the token"
        },
        "email": {
            "type": "string",
            "description": "The email address associated with the token"
        },
        "ip_address": {
            "type": "array",
            "description": "List of IP addresses the token is restricted to"
        },
        "properties": {
            "type": "array",
            "description": "An array of length 16 of integer values; each value defines a properties of the token"
        }
    }
}