github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/openapis/device.openapi.yml (about) 1 openapi: '3.0.3' 2 info: 3 version: 1.0.0 4 title: Cios Device Openapi 5 6 paths: 7 '/v2/devices': 8 get: 9 tags: 10 - device 11 summary: デバイスの一覧を取得する 12 description: |- 13 SUPPORTED APPLICATION TYPE: Web, ネイティブ, クライアント 14 REQUIRED SCOPES: device.read 15 operationId: getDevices 16 parameters: 17 - $ref: '../components/parameters.yml#/components/parameters/offset' 18 - $ref: '../components/parameters.yml#/components/parameters/limit' 19 - $ref: '../components/parameters.yml#/components/parameters/order' 20 - $ref: '../components/parameters.yml#/components/parameters/order_by' 21 - $ref: '../components/parameters.yml#/components/parameters/lang' 22 - $ref: '../components/parameters.yml#/components/parameters/is_dev' 23 - $ref: '../components/parameters.yml#/components/parameters/is_public' 24 - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id' 25 - $ref: '../components/parameters.yml#/components/parameters/name_query' 26 - $ref: '../components/parameters.yml#/components/parameters/id_number' 27 - $ref: '../components/parameters.yml#/components/parameters/definition_id' 28 - $ref: '../components/parameters.yml#/components/parameters/definition_tag' 29 - $ref: '../components/parameters.yml#/components/parameters/inventory_key' 30 - $ref: '../components/parameters.yml#/components/parameters/inventory_value' 31 responses: 32 200: 33 description: '' 34 content: 35 application/json: 36 schema: 37 $ref: '../components/device-component.openapi.yml#/components/schemas/MultipleDevice' 38 security: 39 - bearerAuth: [] 40 post: 41 tags: 42 - device 43 summary: デバイスの登録 44 description: |- 45 SUPPORTED APPLICATION TYPE: Web, ネイティブ 46 REQUIRED SCOPES: user.profile 47 * is_managedが managed または full_managed の場合 48 * Request.body.client_id_listに設定されたID毎にアプリケーション種別がデバイスのOAuthClientが作成されます。(rsa_publickeyを指定する必要があります) 49 operationId: createDevice 50 requestBody: 51 required: true 52 content: 53 application/json: 54 schema: 55 $ref: '../components/device-component.openapi.yml#/components/schemas/DeviceInfo' 56 57 responses: 58 200: 59 description: '' 60 content: 61 application/json: 62 schema: 63 $ref: '../components/device-component.openapi.yml#/components/schemas/SingleDevice' 64 security: 65 - bearerAuth: [] 66 '/v2/devices/{device_id}': 67 get: 68 tags: 69 - device 70 summary: 指定したidのデバイスの情報を取得する 71 description: |- 72 SUPPORTED APPLICATION TYPE: Web, ネイティブ, クライアント 73 REQUIRED SCOPES: device.read 74 operationId: getDevice 75 parameters: 76 - $ref: '../components/parameters.yml#/components/parameters/lang' 77 - $ref: '../components/parameters.yml#/components/parameters/is_dev' 78 - $ref: '../components/parameters.yml#/components/parameters/device_id_required' 79 responses: 80 200: 81 description: '' 82 content: 83 application/json: 84 schema: 85 $ref: '../components/device-component.openapi.yml#/components/schemas/SingleDevice' 86 security: 87 - bearerAuth: [] 88 patch: 89 tags: 90 - device 91 summary: 指定したidのデバイス情報を更新する 92 description: |- 93 SUPPORTED APPLICATION TYPE: Web, ネイティブ, クライアント 94 REQUIRED SCOPES: device.write 95 * Request.body.client_id_listに設定されたアプリケーションクライアント毎にデバイスクライアントを作成します。 96 * is_managedをunmanagedに変更した場合は、device.client_listに登録されているデバイスクライアントをすべて削除します。(OAuthClient APIを利用してデバイスクライアントの削除を行います) 97 * is_managedがfull_managedのデバイス管理エージェント固有のデバイスクライアントに関しては、ディアクティベーションでのみ削除可能です。 98 operationId: updateDevice 99 parameters: 100 - $ref: '../components/parameters.yml#/components/parameters/device_id_required' 101 requestBody: 102 required: true 103 content: 104 application/json: 105 schema: 106 $ref: '../components/device-component.openapi.yml#/components/schemas/DeviceUpdateRequest' 107 responses: 108 200: 109 description: '' 110 content: 111 application/json: 112 schema: 113 $ref: '../components/device-component.openapi.yml#/components/schemas/SingleDevice' 114 security: 115 - bearerAuth: [] 116 delete: 117 tags: 118 - device 119 operationId: deleteDevice 120 parameters: 121 - $ref: '../components/parameters.yml#/components/parameters/device_id_required' 122 responses: 123 200: 124 description: '' 125 security: 126 - bearerAuth: [] 127 /v2/devices/{device_id}/device_clients: 128 post: 129 tags: 130 - device 131 description: |- 132 * 指定したデバイスにクライアントを作成します。 133 * 指定したデバイスIDが存在しない場合は、エラー(404 Not Found)となります。 134 * 指定したデバイスにクライアントが存在しない状態で作成した場合、デバイス管理区分を一部管理に変更します。 135 operationId: createDeviceClient 136 requestBody: 137 required: true 138 content: 139 application/json: 140 schema: 141 $ref: '../components/device-component.openapi.yml#/components/schemas/DeviceClientRequest' 142 parameters: 143 - $ref: '../components/parameters.yml#/components/parameters/device_id' 144 responses: 145 200: 146 description: OK 147 content: 148 application/json: 149 schema: 150 $ref: '../components/device-component.openapi.yml#/components/schemas/DeviceClientList' 151 /v2/devices/{device_id}/device_clients/{client_id}: 152 patch: 153 tags: 154 - device 155 description: -| 156 * 指定したアプリケーションクライアントIDに紐づくデバイスクライアントのRSA公開鍵を更新します。 157 * 指定したデバイスID、またはアプリケーションクライアントIDが存在しない場合は、エラー(404 Not Found)となります。 158 summary: device.write 159 requestBody: 160 required: true 161 content: 162 application/json: 163 schema: 164 $ref: '../components/device-component.openapi.yml#/components/schemas/RsaPublicKey' 165 operationId: updateDeviceClient 166 parameters: 167 - $ref: '../components/parameters.yml#/components/parameters/device_id' 168 - $ref: '../components/parameters.yml#/components/parameters/client_id' 169 responses: 170 200: 171 description: OK 172 content: 173 application/json: 174 schema: 175 $ref: '../components/device-component.openapi.yml#/components/schemas/SingleDeviceClientList' 176 delete: 177 tags: 178 - device 179 description: -| 180 * 指定したアプリケーションクライアントIDに紐づくデバイスクライアントを削除します。 181 * 指定したデバイスID、またはアプリケーションクライアントIDが存在しない場合は、エラー(404 Not Found)となります。 182 * 指定したデバイスクライアントを削除後、デバイスに紐づくデバイスクライアントが存在しない場合は、デバイス管理区分を管理外に変更します。 183 * デバイス管理区分が完全管理のデバイス管理エージェント固有のデバイスクライアントに関しては、ディアクティベーションでのみ削除可能です。 184 summary: device.write 185 operationId: deleteDeviceClient 186 parameters: 187 - $ref: '../components/parameters.yml#/components/parameters/device_id' 188 - $ref: '../components/parameters.yml#/components/parameters/client_id' 189 responses: 190 200: 191 description: OK 192 /v2/devices/profile: 193 get: 194 tags: 195 - device 196 summary: device.profile 197 operationId: getDeviceProfile 198 parameters: 199 - $ref: '../components/parameters.yml#/components/parameters/lang' 200 - $ref: '../components/parameters.yml#/components/parameters/is_dev' 201 responses: 202 200: 203 description: OK 204 content: 205 application/json: 206 schema: 207 $ref: '../components/device-component.openapi.yml#/components/schemas/SingleDevice' 208 209 210 '/v2/devices/{device_id}/inventory/latest': 211 get: 212 tags: 213 - device 214 security: 215 - bearerAuth: [] 216 operationId: getDeviceInventoryLatest 217 parameters: 218 - $ref: '../components/parameters.yml#/components/parameters/device_id' 219 responses: 220 200: 221 description: 'OK' 222 content: 223 application/json: 224 schema: 225 $ref: '../components/device-component.openapi.yml#/components/schemas/DeviceInventory' 226 '/v2/devices/{device_id}/monitoring/latest': 227 get: 228 tags: 229 - device 230 security: 231 - bearerAuth: [] 232 operationId: getDeviceMonitoringLatest 233 parameters: 234 - $ref: '../components/parameters.yml#/components/parameters/device_id' 235 responses: 236 200: 237 description: 'OK' 238 content: 239 application/json: 240 schema: 241 $ref: '../components/device-component.openapi.yml#/components/schemas/SingleDeviceMonitoring' 242 '/v2/devices/monitoring/latest': 243 post: 244 tags: 245 - device 246 security: 247 - bearerAuth: [] 248 operationId: getDeviceMonitoringsLatest 249 requestBody: 250 required: true 251 content: 252 application/json: 253 schema: 254 $ref: '../components/device-component.openapi.yml#/components/schemas/DeviceMonitoringIDsRequest' 255 responses: 256 200: 257 description: 'OK' 258 content: 259 application/json: 260 schema: 261 $ref: '../components/device-component.openapi.yml#/components/schemas/MultipleDeviceMonitoring' 262 '/v2/devices/group_policies': 263 get: 264 tags: 265 - device 266 security: 267 - bearerAuth: [] 268 operationId: getDevicePolicies 269 parameters: 270 - $ref: '../components/parameters.yml#/components/parameters/limit' 271 - $ref: '../components/parameters.yml#/components/parameters/offset' 272 - $ref: '../components/parameters.yml#/components/parameters/order' 273 - $ref: '../components/parameters.yml#/components/parameters/order_by' 274 - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id' 275 responses: 276 200: 277 description: 'OK' 278 content: 279 application/json: 280 schema: 281 $ref: '../components/device-component.openapi.yml#/components/schemas/MultipleDevicePolicy' 282 post: 283 tags: 284 - device 285 security: 286 - bearerAuth: [] 287 operationId: createDevicePolicy 288 requestBody: 289 required: true 290 content: 291 application/json: 292 schema: 293 $ref: '../components/device-component.openapi.yml#/components/schemas/DevicePolicyRequest' 294 responses: 295 200: 296 description: 'OK' 297 content: 298 application/json: 299 schema: 300 $ref: '../components/device-component.openapi.yml#/components/schemas/DevicePolicy' 301 '/v2/devices/group_policies/{policy_id}': 302 delete: 303 tags: 304 - device 305 security: 306 - bearerAuth: [] 307 operationId: deletePolicy 308 parameters: 309 - $ref: '../components/parameters.yml#/components/parameters/policy_id' 310 responses: 311 200: 312 description: 'OK' 313 314 components: 315 securitySchemes: 316 bearerAuth: 317 type: http 318 scheme: bearer 319 bearerFormat: JWT