-
Notifications
You must be signed in to change notification settings - Fork 29
/
UserInfoResURI.swagger.json
131 lines (131 loc) · 4.05 KB
/
UserInfoResURI.swagger.json
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
{
"swagger": "2.0",
"info": {
"title": "User Info for Application Layer",
"version": "2018-12-12",
"license": {
"name": "OCF Data Model License",
"url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
"x-copyright": "copyright 2018-2019 Open Connectivity Foundation, Inc. All rights reserved."
},
"termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
},
"schemes": ["http"],
"consumes": ["application/json"],
"produces": ["application/json"],
"paths": {
"/UserInfoResURI" : {
"get": {
"description": "This Resource defines credentials for user to application layer login. This does not relate to OCF Device to Device or Device to Cloud authentication. The username, password and token are strings.",
"parameters": [
{"$ref": "#/parameters/interface"}
],
"responses": {
"200": {
"description" : "Success path response for the Resource, note that the info supplied is NOT returned on RETRIEVE",
"x-example":
{
"rt": ["oic.r.userinfo"],
"if": ["oic.if.rw", "oic.if.baseline"]
},
"schema": { "$ref": "#/definitions/UserInfo-retrieve" }
}
}
},
"post": {
"description": "This Resource defines credentials for user to application layer login. This does not relate to OCF Device to Device or Device to Cloud authentication. The username, password and token are strings.",
"parameters": [
{"$ref": "#/parameters/interface"},
{
"name": "body",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/UserInfo-update" },
"x-example":
{
"username": "username",
"password": "password",
"token": "A1A1"
}
}
],
"responses": {
"200": {
"description" : "The success path response for the Resource.",
"x-example":
{
"username": "username",
"password": "password",
"token": "A1A1"
},
"schema": { "$ref": "#/definitions/UserInfo-update" }
}
}
}
}
},
"parameters": {
"interface" : {
"in": "query",
"name": "if",
"type": "string",
"enum": ["oic.if.rw", "oic.if.baseline"]
}
},
"definitions": {
"UserInfo-retrieve": {
"properties": {
"rt": {
"description": "The Resource Type.",
"items": {
"maxLength": 64,
"type": "string",
"enum": ["oic.r.userinfo"]
},
"minItems": 1,
"uniqueItems": true,
"readOnly": true,
"type": "array"
},
"n": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
},
"id": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
},
"if": {
"description": "The OCF Interface set supported by this Resource.",
"items": {
"enum": [
"oic.if.rw",
"oic.if.baseline"
],
"type": "string"
},
"minItems": 2,
"uniqueItems": true,
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"UserInfo-update": {
"properties": {
"username": {
"type": "string",
"description": "Login name."
},
"password": {
"type": "string",
"description": "Login password."
},
"token": {
"type": "string",
"description": "Authentication token."
}
},
"type": "object"
}
}
}