diff --git a/package-lock.json b/package-lock.json index d30f8ced5..70ba3066b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -19,7 +19,7 @@ "got": "^14.6.3", "http-z": "^7.0.0", "jws": "^4.0.0", - "mongodb": "^6.20.0", + "mongodb": "^7.0.0", "mqtt": "^5.14.1", "node-forge": "^1.3.1", "pg": "^8.16.3", @@ -2250,9 +2250,9 @@ "license": "MIT" }, "node_modules/@types/whatwg-url": { - "version": "11.0.5", - "resolved": "https://registry.npmjs.org/@types/whatwg-url/-/whatwg-url-11.0.5.tgz", - "integrity": "sha512-coYR071JRaHa+xoEvvYqvnIHaVqaYrLPbsufM9BF63HkwI5Lgmy2QR8Q5K/lYDYo5AK82wOvSOS0UsLTpTG7uQ==", + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/@types/whatwg-url/-/whatwg-url-13.0.0.tgz", + "integrity": "sha512-N8WXpbE6Wgri7KUSvrmQcqrMllKZ9uxkYWMt+mCSGwNc0Hsw9VQTW7ApqI4XNrx6/SaM2QQJCzMPDEXE058s+Q==", "license": "MIT", "dependencies": { "@types/webidl-conversions": "*" @@ -3021,12 +3021,12 @@ } }, "node_modules/bson": { - "version": "6.10.4", - "resolved": "https://registry.npmjs.org/bson/-/bson-6.10.4.tgz", - "integrity": "sha512-WIsKqkSC0ABoBJuT1LEX+2HEvNmNKKgnTAyd0fL8qzK4SH2i9NXg+t08YtdZp/V9IZ33cxe3iV4yM0qg8lMQng==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/bson/-/bson-7.0.0.tgz", + "integrity": "sha512-Kwc6Wh4lQ5OmkqqKhYGKIuELXl+EPYSCObVE6bWsp1T/cGkOCBN0I8wF/T44BiuhHyNi1mmKVPXk60d41xZ7kw==", "license": "Apache-2.0", "engines": { - "node": ">=16.20.1" + "node": ">=20.19.0" } }, "node_modules/buffer": { @@ -6340,26 +6340,26 @@ } }, "node_modules/mongodb": { - "version": "6.20.0", - "resolved": "https://registry.npmjs.org/mongodb/-/mongodb-6.20.0.tgz", - "integrity": "sha512-Tl6MEIU3K4Rq3TSHd+sZQqRBoGlFsOgNrH5ltAcFBV62Re3Fd+FcaVf8uSEQFOJ51SDowDVttBTONMfoYWrWlQ==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/mongodb/-/mongodb-7.0.0.tgz", + "integrity": "sha512-vG/A5cQrvGGvZm2mTnCSz1LUcbOPl83hfB6bxULKQ8oFZauyox/2xbZOoGNl+64m8VBrETkdGCDBdOsCr3F3jg==", "license": "Apache-2.0", "dependencies": { "@mongodb-js/saslprep": "^1.3.0", - "bson": "^6.10.4", - "mongodb-connection-string-url": "^3.0.2" + "bson": "^7.0.0", + "mongodb-connection-string-url": "^7.0.0" }, "engines": { - "node": ">=16.20.1" + "node": ">=20.19.0" }, "peerDependencies": { - "@aws-sdk/credential-providers": "^3.188.0", - "@mongodb-js/zstd": "^1.1.0 || ^2.0.0", - "gcp-metadata": "^5.2.0", - "kerberos": "^2.0.1", - "mongodb-client-encryption": ">=6.0.0 <7", + "@aws-sdk/credential-providers": "^3.806.0", + "@mongodb-js/zstd": "^7.0.0", + "gcp-metadata": "^7.0.1", + "kerberos": "^7.0.0", + "mongodb-client-encryption": ">=7.0.0 <7.1.0", "snappy": "^7.3.2", - "socks": "^2.7.1" + "socks": "^2.8.6" }, "peerDependenciesMeta": { "@aws-sdk/credential-providers": { @@ -6386,13 +6386,16 @@ } }, "node_modules/mongodb-connection-string-url": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/mongodb-connection-string-url/-/mongodb-connection-string-url-3.0.2.tgz", - "integrity": "sha512-rMO7CGo/9BFwyZABcKAWL8UJwH/Kc2x0g72uhDWzG48URRax5TCIcJ7Rc3RZqffZzO/Gwff/jyKwCU9TN8gehA==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/mongodb-connection-string-url/-/mongodb-connection-string-url-7.0.0.tgz", + "integrity": "sha512-irhhjRVLE20hbkRl4zpAYLnDMM+zIZnp0IDB9akAFFUZp/3XdOfwwddc7y6cNvF2WCEtfTYRwYbIfYa2kVY0og==", "license": "Apache-2.0", "dependencies": { - "@types/whatwg-url": "^11.0.2", - "whatwg-url": "^14.1.0 || ^13.0.0" + "@types/whatwg-url": "^13.0.0", + "whatwg-url": "^14.1.0" + }, + "engines": { + "node": ">=20.19.0" } }, "node_modules/mqtt": { diff --git a/package.json b/package.json index 3e1876083..6bf6a16b6 100644 --- a/package.json +++ b/package.json @@ -49,7 +49,7 @@ "got": "^14.6.3", "http-z": "^7.0.0", "jws": "^4.0.0", - "mongodb": "^6.20.0", + "mongodb": "^7.0.0", "mqtt": "^5.14.1", "node-forge": "^1.3.1", "pg": "^8.16.3", diff --git a/src/data/mongo/collections/device.ts b/src/data/mongo/collections/device.ts index 04a837622..2bda4103a 100644 --- a/src/data/mongo/collections/device.ts +++ b/src/data/mongo/collections/device.ts @@ -55,8 +55,23 @@ export class MongoDeviceTable implements IDeviceTable { } async update(item: Device): Promise> { + if (!(item as any)._id) { + throw new Error('Device must have an _id for update operation') + } + + const itemId = (item as any)._id + let objectId: ObjectId + + if (ObjectId.isValid(itemId)) { + objectId = new ObjectId(itemId) + } else if (typeof itemId === 'number') { + objectId = new ObjectId(itemId.toString().padStart(24, '0')) + } else { + throw new Error(`Invalid _id format: ${itemId}`) + } + const result = await this.collection.findOneAndUpdate( - { _id: new ObjectId((item as any)._id as number), tenantId: item.tenantId }, + { _id: objectId, tenantId: item.tenantId }, { $set: item }, { returnDocument: 'after', includeResultMetadata: false } ) diff --git a/src/routes/devices/index.ts b/src/routes/devices/index.ts index b01f8a4df..e6077aeba 100644 --- a/src/routes/devices/index.ts +++ b/src/routes/devices/index.ts @@ -25,7 +25,13 @@ deviceRouter.get('/', odataValidator(), metadataQueryValidator(), validateMiddle deviceRouter.get('/stats', stats) deviceRouter.get('/tags', getDistinctTags) deviceRouter.get('/:guid', param('guid').isUUID('loose'), validateMiddleware, getDevice) -deviceRouter.get('/redirectstatus/:guid', param('guid').isUUID('loose'), validateMiddleware, ciraMiddleware, getRedirStatus) +deviceRouter.get( + '/redirectstatus/:guid', + param('guid').isUUID('loose'), + validateMiddleware, + ciraMiddleware, + getRedirStatus +) deviceRouter.post('/', validator(), validateMiddleware, insertDevice) deviceRouter.patch('/', validator(), validateMiddleware, updateDevice) deviceRouter.delete('/refresh/:guid', validator(), validateMiddleware, refreshDevice) diff --git a/swagger.yaml b/swagger.yaml index 788de350b..9633817e4 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -7,7 +7,7 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html description: | Open AMT Cloud Toolkit supports MPS API methods for authorization, user authentication, device-specific actions, such as power actions, and general device information. - + For direct connection to MPS: * MPS Format of URI: `{{protocol}}://{{host}}:{{port}}/api/v1/{{MPS API}}` @@ -15,14 +15,14 @@ info: When running behind the Kong API proxy, prepend the following prefixes to the URI: - + Kong prefixes: * `/mps/login` for POST authorize method, `/mps` for GET authorize redirection method * `/mps/ws` for websocket routes * `/mps` for all other routes, including GET authorize/redirection method - + For connection through Kong: - + * MPS Format of URI: `{{protocol}}://{{host}}/{{Kong Prefix}}/api/v1/{{MPS API}}` * Example URI for Authorize: [https://example.site.com/mps/login/api/v1/authorize]() @@ -46,19 +46,19 @@ paths: summary: Generate JWT Token for Authentication description: | Generates a JWT token that can be used for authentication to both MPS and RPS APIs. [Learn more about JWT](https://jwt.io/introduction). - + **If using Kong**, make sure to use the prefix `/mps/login` tags: - Auth requestBody: description: Payload with username and password - required: true + required: true content: application/json: schema: required: - - username - - password + - username + - password properties: username: type: string @@ -80,18 +80,18 @@ paths: summary: Issue Short-lived Bearer Token for Redirection Sessions description: | Authenticate Redirection (KVM or SOL) sessions between the management console and MPS to allow only authenticated and authorized users to initiate. - + **If using Kong**, make sure to use the prefix `/mps`, **NOT** `/mps/login`. Authorize Redirection does not use the login route. tags: - Auth parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Success' @@ -108,22 +108,22 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string - - name: startIndex - in: query - description: number of items to skip - example: "startIndex=0" - required: false - schema: - type: integer - minimum: 0 - default: 0 + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string + - name: startIndex + in: query + description: number of items to skip + example: 'startIndex=0' + required: false + schema: + type: integer + minimum: 0 + default: 0 responses: 200: description: 'Successful operation' @@ -138,13 +138,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string # - name: startDate # in: query # description: Start date of log to retrieve @@ -187,13 +187,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -208,13 +208,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -229,13 +229,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -250,13 +250,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string requestBody: description: Payload to set AMT Features required: true @@ -275,9 +275,9 @@ paths: summary: Return Intel® AMT Features description: | Retrieves the current Intel® AMT Enable/Disable state for User Consent, Redirection, KVM, SOL, IDE-R and One Click Recovery (OCR). - + `optInState` refers to the current Opt In State if the device has User Consent enabled. Valid values: - + - 0 (Not Started) - No sessions in progress or user consent requested - 1 (Requested) - Request to AMT device for user consent code successful - 2 (Displayed) - AMT device displaying user consent code for 300 seconds (5 minutes) before timeout by default @@ -286,12 +286,12 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -306,13 +306,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string requestBody: description: Payload to set new Alarm Clock required: true @@ -333,12 +333,12 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -350,31 +350,31 @@ paths: summary: Delete Alarm Clock Occurence description: | Delete named Alarm Clock occurence from the device. - + **IMPORTANT**
**The DELETE method DOES REQUIRE a Request Body:**

**{
 "Name": "string"
}**
- + Note: Unfortunately, SwaggerHub and OpenAPI 3.0 spec does not allow DELETE requests to have a Request Body for documentation. This has changed for OpenAPI 3.1 although SwaggerHub has not completed their migration from 3.0 -> 3.1 . We apologize for this deviation from the other documentation, please bear with us as we eagerly await the SwaggerHub update. Thank you! tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' content: - application/json: - schema: - $ref: '#/components/schemas/DeactivateResponse' + application/json: + schema: + $ref: '#/components/schemas/DeactivateResponse' 404: description: 'Alarm Instance does not exist' content: @@ -397,7 +397,7 @@ paths: * 8 = Off - Soft, corresponding to ACPI state G2, S5, or D3 * 9 = Power Cycle (Off-Hard), corresponds to the managed element reaching the ACPI state G3 followed by ACPI state S0 * 13 = Off - Hard Graceful, equivalent to Off Hard but preceded by a request to the managed element to perform an orderly shutdown - + OSPowerSavingState values mapping: * 0 = UNKNOWN * 1 = UNSUPPORTED @@ -406,13 +406,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -427,13 +427,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -449,13 +449,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string requestBody: description: | **Standard Power Actions:** @@ -465,7 +465,7 @@ paths: * 10 = Reset * 500 = OS to full power * 501 = OS to power saving - + **Power Actions Requiring Intel LMS:** * 4 = Sleep * 7 = Hibernate @@ -480,9 +480,9 @@ paths: 200: description: 'Successful operation' content: - application/json: - schema: - $ref: '#/components/schemas/PowerActionResponse' + application/json: + schema: + $ref: '#/components/schemas/PowerActionResponse' /api/v1/amt/power/bootOptions/{guid}: post: summary: Perform OOB Power Action (100+) @@ -491,13 +491,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string requestBody: description: | Possible Power Actions: @@ -522,9 +522,9 @@ paths: 200: description: 'Successful operation' content: - application/json: - schema: - $ref: '#/components/schemas/PowerActionResponse' + application/json: + schema: + $ref: '#/components/schemas/PowerActionResponse' /api/v1/amt/power/bootSources/{guid}: get: summary: Request for boot source settings information @@ -532,13 +532,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -553,13 +553,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -568,18 +568,18 @@ paths: schema: $ref: '#/components/schemas/UserConsentResponse' post: - summary: Send user consent code + summary: Send user consent code description: Send the user consent code displayed on the client device tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string requestBody: description: '' required: true @@ -601,13 +601,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -622,20 +622,20 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' content: - application/json: - schema: - $ref: '#/components/schemas/DeactivateResponse' + application/json: + schema: + $ref: '#/components/schemas/DeactivateResponse' 404: description: 'Device does not exist' content: @@ -651,13 +651,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -666,7 +666,7 @@ paths: schema: $ref: '#/components/schemas/GetCertificatesResponse' 404: - description: 'Device not found' + description: 'Device not found' content: application/json: schema: @@ -717,13 +717,13 @@ paths: tags: - AMT parameters: - - name: guid - in: path - description: GUID of device - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 200: description: 'Successful operation' @@ -732,7 +732,7 @@ paths: schema: $ref: '#/components/schemas/GetDisplaysResponse' 404: - description: 'Device not found' + description: 'Device not found' content: application/json: schema: @@ -841,15 +841,15 @@ paths: application/json: schema: oneOf: - - type: array - items: - $ref: '#/components/schemas/Device' - - $ref: '#/components/schemas/CountDevicesResponse' + - type: array + items: + $ref: '#/components/schemas/Device' + - $ref: '#/components/schemas/CountDevicesResponse' 500: description: 'Internal server error' post: summary: Add New Device to MPS - description: Adds a new device to MPS. This call does not add the device credentials. In order for MPS to manage the device, a separate call to Vault must be made to add the credentials. For example, the Remote Provision Server (RPS) makes the call to Vault to add the AMT device credentials during activation of the AMT device. + description: Adds a new device to MPS. This call does not add the device credentials. In order for MPS to manage the device, a separate call to Vault must be made to add the credentials. For example, the Remote Provision Server (RPS) makes the call to Vault to add the AMT device credentials during activation of the AMT device. tags: - Devices requestBody: @@ -900,13 +900,13 @@ paths: tags: - Devices parameters: - - name: guid - in: path - description: GUID of device to return - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device to return + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 400: description: 'Error in request. A list of errors will be returned' @@ -940,13 +940,13 @@ paths: tags: - Devices parameters: - - name: guid - in: path - description: GUID of device to return - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device to return + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 400: description: 'Error in request. A list of errors will be returned' @@ -966,19 +966,19 @@ paths: tags: - Devices parameters: - - name: guid - in: path - description: GUID of device to return - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string - - name: isSecretToBeDeleted - in: query - description: "Delete device information from both the Database **AND Secret Storage**. Caution: This will delete the stored device passwords in Secret Storage." - example: isSecretToBeDeleted=true - schema: - type: boolean + - name: guid + in: path + description: GUID of device to return + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string + - name: isSecretToBeDeleted + in: query + description: 'Delete device information from both the Database **AND Secret Storage**. Caution: This will delete the stored device passwords in Secret Storage.' + example: isSecretToBeDeleted=true + schema: + type: boolean responses: 404: description: 'Device does not exist' @@ -1001,13 +1001,13 @@ paths: tags: - Devices parameters: - - name: guid - in: path - description: GUID of device to return - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device to return + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 404: description: 'Device does not exist' @@ -1023,23 +1023,23 @@ paths: $ref: '#/components/schemas/DisconnectResponse' 500: description: 'Request failed while disconnecting device.' - /api/v1/devices/refresh/{guid}: + /api/v1/devices/refresh/{guid}: delete: summary: Refresh Stored AMT Password description: | Delete the device's existing cached AMT password and refresh the cache from the secret store. - + Internal API. After running the RPC [changePassword](https://device-management-toolkit.github.io/docs/2.27/Reference/RPC/commandsRPC/#changepassword) maintenance command, RPS must call this MPS endpoint to update the stored password secrets. Otherwise, all MPS API calls that require device credentials (e.g. Power Actions) will fail due to MPS using the old AMT password. tags: - Devices parameters: - - name: guid - in: path - description: GUID of device to return - example: 123e4567-e89b-12d3-a456-426614174000 - required: true - schema: - type: string + - name: guid + in: path + description: GUID of device to return + example: 123e4567-e89b-12d3-a456-426614174000 + required: true + schema: + type: string responses: 404: description: 'Device does not exist or cannot be found' @@ -1067,7 +1067,7 @@ paths: /api/v1/health: get: summary: Return Status of DB and Secret Store - description: Returns statuses for the database and secret store that MPS is attempting to connect to. + description: Returns statuses for the database and secret store that MPS is attempting to connect to. tags: - Misc responses: @@ -1080,7 +1080,7 @@ paths: /api/v1/version: get: tags: - - Misc + - Misc summary: Get Version operationId: GetVersion description: Returns the version of the service and the supported protocol version. The protocol version is used to check compatibility with RPC @@ -1115,28 +1115,28 @@ components: example: totalCnt: 2 records: - - AuditAppID: 18 - EventID: 10 - InitiatorType: 0 - AuditApp: "Redirection Manager" - Event: "KVM Enabled" - Initiator: "admin" - Time: "2003-12-29T05:46:37.000Z" - MCLocationType: 0 - NetAddress: "1.2.3.4" - Ex: "" - ExStr: null - - AuditAppID: 16 - EventID: 19 - InitiatorType: 0 - AuditApp: "Security Admin" - Event: "Unprovisioning Started" - Initiator: "admin" - Time: "2017-12-21T17:30:39.000Z" - MCLocationType: 1 - NetAddress: "::1" - Ex: "" - ExStr: "Remote WSMAN" + - AuditAppID: 18 + EventID: 10 + InitiatorType: 0 + AuditApp: 'Redirection Manager' + Event: 'KVM Enabled' + Initiator: 'admin' + Time: '2003-12-29T05:46:37.000Z' + MCLocationType: 0 + NetAddress: '1.2.3.4' + Ex: '' + ExStr: null + - AuditAppID: 16 + EventID: 19 + InitiatorType: 0 + AuditApp: 'Security Admin' + Event: 'Unprovisioning Started' + Initiator: 'admin' + Time: '2017-12-21T17:30:39.000Z' + MCLocationType: 1 + NetAddress: '::1' + Ex: '' + ExStr: 'Remote WSMAN' AuditLogRecord: title: AuditLogRecord @@ -1183,8 +1183,8 @@ components: EntityInstance: 0 EventData: [64, 6, 0, 0, 0, 0, 0, 0] TimeStamp: '2019-04-11T17:57:40.000Z' - EntityStr: "BIOS" - Desc: "USB resource configuration" + EntityStr: 'BIOS' + Desc: 'USB resource configuration' - DeviceAddress: 255 EventSensorType: 6 EventType: 111 @@ -1196,8 +1196,8 @@ components: EntityInstance: 0 EventData: [32, 3, 0, 0, 0, 0, 0, 0] TimeStamp: '2019-04-11T17:58:15.000Z' - EntityStr: "BIOS" - Desc: "Authentication failed 3 times. The system may be under attack." + EntityStr: 'BIOS' + Desc: 'Authentication failed 3 times. The system may be under attack.' EventLogRecord: title: EventLogRecord @@ -1225,7 +1225,7 @@ components: type: array items: type: integer - TimeStamp: + TimeStamp: type: string EntityStr: type: string @@ -1330,39 +1330,39 @@ components: example: CIM_SoftwareIdentity: responses: - - InstanceID: Flash - IsEntity: true - VersionString: 11.8.50 - - InstanceID: Netstack - IsEntity: true - VersionString: 11.8.50 - - InstanceID: AMTApps - IsEntity: true - VersionString: 11.8.50 - - InstanceID: AMT - IsEntity: true - VersionString: 11.8.50 - - InstanceID: Sku - IsEntity: true - VersionString: 16392 - - InstanceID: VendorID - IsEntity: true - VersionString: 8086 - - InstanceID: Build Number - IsEntity: true - VersionString: 3425 - - InstanceID: Recovery Version - IsEntity: true - VersionString: 11.8.50 - - InstanceID: Recovery Build Num - IsEntity: true - VersionString: 3425 - - InstanceID: Legacy Mode - IsEntity: true - VersionString: 'False' - - InstanceID: AMT FW Core Version - IsEntity: true - VersionString: 11.8.50 + - InstanceID: Flash + IsEntity: true + VersionString: 11.8.50 + - InstanceID: Netstack + IsEntity: true + VersionString: 11.8.50 + - InstanceID: AMTApps + IsEntity: true + VersionString: 11.8.50 + - InstanceID: AMT + IsEntity: true + VersionString: 11.8.50 + - InstanceID: Sku + IsEntity: true + VersionString: 16392 + - InstanceID: VendorID + IsEntity: true + VersionString: 8086 + - InstanceID: Build Number + IsEntity: true + VersionString: 3425 + - InstanceID: Recovery Version + IsEntity: true + VersionString: 11.8.50 + - InstanceID: Recovery Build Num + IsEntity: true + VersionString: 3425 + - InstanceID: Legacy Mode + IsEntity: true + VersionString: 'False' + - InstanceID: AMT FW Core Version + IsEntity: true + VersionString: 11.8.50 status: 200 AMT_SetupAndConfigurationService: response: @@ -1380,32 +1380,32 @@ components: ZeroTouchConfigurationEnabled: true responses: Header: - To: http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous - RelatesTo: 3 - Action: http://schemas.xmlsoap.org/ws/2004/09/transfer/GetResponse - MessageID: uuid:00000000-8086-8086-8086-0000000006A4 - ResourceURI: http://intel.com/wbem/wscim/1/amt-schema/1/AMT_SetupAndConfigurationService - Method: AMT_SetupAndConfigurationService + To: http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous + RelatesTo: 3 + Action: http://schemas.xmlsoap.org/ws/2004/09/transfer/GetResponse + MessageID: uuid:00000000-8086-8086-8086-0000000006A4 + ResourceURI: http://intel.com/wbem/wscim/1/amt-schema/1/AMT_SetupAndConfigurationService + Method: AMT_SetupAndConfigurationService Body: - CreationClassName: AMT_SetupAndConfigurationService - ElementName: Intel(r) AMT Setup and Configuration Service - EnabledState: 5 - Name: Intel(r) AMT Setup and Configuration Service - PasswordModel: 1 - ProvisioningMode: 1 - ProvisioningServerOTP: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA= - ProvisioningState: 2 - RequestedState: 12 - SystemCreationClassName: CIM_ComputerSystem - SystemName: Intel(r) AMT - ZeroTouchConfigurationEnabled: true - status: 200 + CreationClassName: AMT_SetupAndConfigurationService + ElementName: Intel(r) AMT Setup and Configuration Service + EnabledState: 5 + Name: Intel(r) AMT Setup and Configuration Service + PasswordModel: 1 + ProvisioningMode: 1 + ProvisioningServerOTP: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA= + ProvisioningState: 2 + RequestedState: 12 + SystemCreationClassName: CIM_ComputerSystem + SystemName: Intel(r) AMT + ZeroTouchConfigurationEnabled: true + status: 200 GeneralSettingsResponse: title: GeneralSettingsResponse example: Header: To: http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous - RelatesTo: "1" + RelatesTo: '1' Action: http://schemas.xmlsoap.org/ws/2004/09/transfer/GetResponse MessageID: uuid:00000000-8086-8086-8086-000000000699 ResourceURI: http://intel.com/wbem/wscim/1/amt-schema/1/AMT_GeneralSettings @@ -1460,7 +1460,7 @@ components: type: integer DDNSUpdateByDHCPServerEnabled: type: boolean - DDNSUpdateEnabled: + DDNSUpdateEnabled: type: boolean DHCPv6ConfigurationTimeout: type: integer @@ -1482,7 +1482,7 @@ components: type: boolean PingResponseEnabled: type: boolean - PowerSource: + PowerSource: type: integer PreferredAddressFamily: type: integer @@ -1523,7 +1523,7 @@ components: properties: value: type: string - '@name': + '@name': type: string Dependent: type: object @@ -1543,7 +1543,7 @@ components: properties: value: type: string - "@name": + '@name': type: string PlatformGUID: type: string @@ -1573,7 +1573,7 @@ components: properties: value: type: string - "@name": + '@name': type: string dependent: type: object @@ -1593,7 +1593,7 @@ components: properties: value: type: string - "@name": + '@name': type: string PlatformGUID: type: string @@ -1690,7 +1690,7 @@ components: type: string Version: type: string - BankLabel: + BankLabel: type: string Capacity: type: integer @@ -1716,19 +1716,19 @@ components: type: boolean CreationClassName: type: string - ElementName: + ElementName: type: string - Manufacturer: + Manufacturer: type: string - Model: + Model: type: string OperationalStatus: type: integer PackageType: type: integer - SerialNumber: + SerialNumber: type: string - Tag: + Tag: type: string Version: type: string @@ -1757,19 +1757,19 @@ components: type: boolean CreationClassName: type: string - ElementName: + ElementName: type: string - Manufacturer: + Manufacturer: type: string - Model: + Model: type: string OperationalStatus: type: integer PackageType: type: integer - SerialNumber: + SerialNumber: type: string - Tag: + Tag: type: string Version: type: string @@ -1796,13 +1796,13 @@ components: properties: Datetime: type: string - SoftwareElementID: + SoftwareElementID: type: string SoftwareElementState: type: integer TargetOperatingSystem: type: integer - Version: + Version: type: string responses: type: object @@ -1840,13 +1840,13 @@ components: properties: Datetime: type: string - SoftwareElementID: + SoftwareElementID: type: string SoftwareElementState: type: integer TargetOperatingSystem: type: integer - Version: + Version: type: string status: type: integer @@ -1937,7 +1937,7 @@ components: Capabilities: type: array items: - type: integer + type: integer CreationClassName: type: string DeviceID: @@ -1993,7 +1993,7 @@ components: ChassisPackageType: type: integer status: - type: integer + type: integer example: CIM_ComputerSystemPackage: response: @@ -2003,45 +2003,45 @@ components: ResourceURI: http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/ CIM_Chassis SelectorSet: Selector: - - value: CIM_Chassis - "@name": CreationClassName - - value: CIM_Chassis - "@name": Tag + - value: CIM_Chassis + '@name': CreationClassName + - value: CIM_Chassis + '@name': Tag Dependent: Address: http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous ReferenceParameters: ResourceURI: http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/ CIM_ComputerSystem SelectorSet: Selector: - - value: CIM_ComputerSystem - "@name": CreationClassName - - value: ManagedSystem - "@name": Name + - value: CIM_ComputerSystem + '@name': CreationClassName + - value: ManagedSystem + '@name': Name PlatformGUID: 1095AC4BA6042143BAE2D45DDF07B684 status: 200 CIM_SystemPackaging: responses: - - Antecedent: - Address: http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous - ReferenceParameters: - ResourceURI: http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/ CIM_Chassis - SelectorSet: - Selector: - - value: CIM_Chassis - "@name": CreationClassName - - value: CIM_Chassis - "@name": Tag - Dependent: - Address: http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous - ReferenceParameters: - ResourceURI: http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/ CIM_ComputerSystem - SelectorSet: - Selector: - - value: CIM_ComputerSystem - "@name": CreationClassName - - value: ManagedSystem - "@name": Name - PlatformGUID: 1095AC4BA6042143BAE2D45DDF07B684 + - Antecedent: + Address: http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous + ReferenceParameters: + ResourceURI: http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/ CIM_Chassis + SelectorSet: + Selector: + - value: CIM_Chassis + '@name': CreationClassName + - value: CIM_Chassis + '@name': Tag + Dependent: + Address: http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous + ReferenceParameters: + ResourceURI: http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/ CIM_ComputerSystem + SelectorSet: + Selector: + - value: CIM_ComputerSystem + '@name': CreationClassName + - value: ManagedSystem + '@name': Name + PlatformGUID: 1095AC4BA6042143BAE2D45DDF07B684 status: 200 CIM_Chassis: response: @@ -2058,35 +2058,35 @@ components: status: 200 CIM_Chip: responses: - - CanBeFRUed: true - CreationClassName: CIM_Chip - ElementName: Managed System Processor Chip - Manufacturer: Intel(R) Corporation - OperationalStatus: 0 - Tag: CPU 0 - Version: Intel(R) Core(TM) i5-7300U CPU @ 2.60GHz - - BankLabel: BANK 0 - Capacity: 4294967296 - CreationClassName: CIM_PhysicalMemory - ElementName: Managed System Memory Chip - FormFactor: 13 - Manufacturer: 04EF - MemoryType: 26 - PartNumber: 'TEAMGROUP-SD4-2133 ' - SerialNumber: 020300C5 - Speed: 0 - Tag: 9876543210 - - BankLabel: BANK 2 - Capacity: 4294967296 - CreationClassName: CIM_PhysicalMemory - ElementName: Managed System Memory Chip - FormFactor: 13 - Manufacturer: 04EF - MemoryType: 26 - PartNumber: 'TEAMGROUP-SD4-2133 ' - SerialNumber: 020300BD - Speed: 0 - Tag: 9876543210 (#2) + - CanBeFRUed: true + CreationClassName: CIM_Chip + ElementName: Managed System Processor Chip + Manufacturer: Intel(R) Corporation + OperationalStatus: 0 + Tag: CPU 0 + Version: Intel(R) Core(TM) i5-7300U CPU @ 2.60GHz + - BankLabel: BANK 0 + Capacity: 4294967296 + CreationClassName: CIM_PhysicalMemory + ElementName: Managed System Memory Chip + FormFactor: 13 + Manufacturer: 04EF + MemoryType: 26 + PartNumber: 'TEAMGROUP-SD4-2133 ' + SerialNumber: 020300C5 + Speed: 0 + Tag: 9876543210 + - BankLabel: BANK 2 + Capacity: 4294967296 + CreationClassName: CIM_PhysicalMemory + ElementName: Managed System Memory Chip + FormFactor: 13 + Manufacturer: 04EF + MemoryType: 26 + PartNumber: 'TEAMGROUP-SD4-2133 ' + SerialNumber: 020300BD + Speed: 0 + Tag: 9876543210 (#2) status: 200 CIM_Card: response: @@ -2117,107 +2117,107 @@ components: status: 200 CIM_Processor: responses: - - CPUStatus: 1 - CreationClassName: CIM_Processor - CurrentClockSpeed: 2500 - DeviceID: CPU 0 - ElementName: Managed System CPU - EnabledState: 2 - ExternalBusClockSpeed: 100 - Family: 205 - HealthState: 0 - MaxClockSpeed: 8300 - OperationalStatus: 0 - RequestedState: 12 - Role: Central - Stepping: 9 - SystemCreationClassName: CIM_ComputerSystem - SystemName: ManagedSystem - UpgradeMethod: 2 + - CPUStatus: 1 + CreationClassName: CIM_Processor + CurrentClockSpeed: 2500 + DeviceID: CPU 0 + ElementName: Managed System CPU + EnabledState: 2 + ExternalBusClockSpeed: 100 + Family: 205 + HealthState: 0 + MaxClockSpeed: 8300 + OperationalStatus: 0 + RequestedState: 12 + Role: Central + Stepping: 9 + SystemCreationClassName: CIM_ComputerSystem + SystemName: ManagedSystem + UpgradeMethod: 2 status: 200 CIM_PhysicalMemory: responses: - - BankLabel: BANK 0 - Capacity: 4294967296 - CreationClassName: CIM_PhysicalMemory - ElementName: Managed System Memory Chip - FormFactor: 13 - Manufacturer: 04EF - MemoryType: 26 - PartNumber: 'TEAMGROUP-SD4-2133 ' - SerialNumber: 020300C5 - Speed: 0 - Tag: 9876543210 - - BankLabel: BANK 2 - Capacity: 4294967296 - CreationClassName: CIM_PhysicalMemory - ElementName: Managed System Memory Chip - FormFactor: 13 - Manufacturer: 04EF - MemoryType: 26 - PartNumber: 'TEAMGROUP-SD4-2133 ' - SerialNumber: 020300BD - Speed: 0 - Tag: 9876543210 (#2) + - BankLabel: BANK 0 + Capacity: 4294967296 + CreationClassName: CIM_PhysicalMemory + ElementName: Managed System Memory Chip + FormFactor: 13 + Manufacturer: 04EF + MemoryType: 26 + PartNumber: 'TEAMGROUP-SD4-2133 ' + SerialNumber: 020300C5 + Speed: 0 + Tag: 9876543210 + - BankLabel: BANK 2 + Capacity: 4294967296 + CreationClassName: CIM_PhysicalMemory + ElementName: Managed System Memory Chip + FormFactor: 13 + Manufacturer: 04EF + MemoryType: 26 + PartNumber: 'TEAMGROUP-SD4-2133 ' + SerialNumber: 020300BD + Speed: 0 + Tag: 9876543210 (#2) status: 200 CIM_MediaAccessDevice: responses: - - Capabilities: - - 4 - - 10 - CreationClassName: CIM_MediaAccessDevice - DeviceID: MEDIA DEV 0 - ElementName: Managed System Media Access Device - EnabledDefault: 2 - EnabledState: 0 - MaxMediaSize: 250059350 - OperationalStatus: 0 - RequestedState: 12 - Security: 2 - SystemCreationClassName: CIM_ComputerSystem - SystemName: ManagedSystem + - Capabilities: + - 4 + - 10 + CreationClassName: CIM_MediaAccessDevice + DeviceID: MEDIA DEV 0 + ElementName: Managed System Media Access Device + EnabledDefault: 2 + EnabledState: 0 + MaxMediaSize: 250059350 + OperationalStatus: 0 + RequestedState: 12 + Security: 2 + SystemCreationClassName: CIM_ComputerSystem + SystemName: ManagedSystem status: 200 CIM_PhysicalPackage: responses: - - CanBeFRUed: true - CreationClassName: CIM_Card - ElementName: Managed System Base Board - Manufacturer: Intel Corporation - Model: NUC7i5DNB - OperationalStatus: 0 - PackageType: 9 - SerialNumber: BTDN7490016E - Tag: CIM_Card - Version: J57626-503 - - CreationClassName: CIM_PhysicalPackage - ElementName: Managed System Storage Media Package - Model: 'Samsung SSD 850 EVO M.2 250GB ' - OperationalStatus: 0 - PackageType: 15 - SerialNumber: 'S33CNX0JC36654D ' - Tag: Storage Media Package 0 - - ChassisPackageType: 0 - CreationClassName: CIM_Chassis - ElementName: Managed System Chassis - Manufacturer: Intel Corporation - Model: NUC7i5DNHE - OperationalStatus: 0 - PackageType: 3 - SerialNumber: DW1646647500075 - Tag: CIM_Chassis - Version: J57828-503 + - CanBeFRUed: true + CreationClassName: CIM_Card + ElementName: Managed System Base Board + Manufacturer: Intel Corporation + Model: NUC7i5DNB + OperationalStatus: 0 + PackageType: 9 + SerialNumber: BTDN7490016E + Tag: CIM_Card + Version: J57626-503 + - CreationClassName: CIM_PhysicalPackage + ElementName: Managed System Storage Media Package + Model: 'Samsung SSD 850 EVO M.2 250GB ' + OperationalStatus: 0 + PackageType: 15 + SerialNumber: 'S33CNX0JC36654D ' + Tag: Storage Media Package 0 + - ChassisPackageType: 0 + CreationClassName: CIM_Chassis + ElementName: Managed System Chassis + Manufacturer: Intel Corporation + Model: NUC7i5DNHE + OperationalStatus: 0 + PackageType: 3 + SerialNumber: DW1646647500075 + Tag: CIM_Chassis + Version: J57828-503 status: 200 SetAMTFeaturesRequest: title: SetAMTFeaturesRequest required: - - userConsent - - enableSOL - - enableIDER - - enableKVM + - userConsent + - enableSOL + - enableIDER + - enableKVM properties: userConsent: type: string - enum: + enum: - kvm - all - none @@ -2231,12 +2231,12 @@ components: type: boolean enableAll: type: boolean - ocr: + ocr: type: boolean SetAMTFeaturesResponse: type: string - example: - status: 'Updated AMT Features' + example: + status: 'Updated AMT Features' properties: status: type: string @@ -2249,9 +2249,9 @@ components: type: boolean KVM: type: boolean - SOL: + SOL: type: boolean - IDER: + IDER: type: boolean optInState: type: integer @@ -2272,7 +2272,7 @@ components: type: boolean remoteErase: type: boolean - example: + example: userConsent: kvm redirection: false KVM: false @@ -2284,14 +2284,14 @@ components: winREBootSupported: true localPBABootSupported: true remoteErase: false - + SetAlarmClockRequest: title: SetAlarmClockRequest required: - - ElementName - - StartTime - - Interval - - DeleteOnCompletion + - ElementName + - StartTime + - Interval + - DeleteOnCompletion properties: ElementName: type: string @@ -2304,13 +2304,13 @@ components: type: boolean SetAlarmClockResponse: type: string - example: + example: status: 'SUCCESS' ReturnValue: 0 properties: status: type: string - ReturnValue: + ReturnValue: type: integer GetAlarmClockResponse: title: GetAlarmClockResponse @@ -2332,19 +2332,19 @@ components: type: string DeleteOnCompletion: type: boolean - example: + example: DeleteOnCompletion: false ElementName: testAlarm InstanceID: testAlarm - Interval: + Interval: Interval: PT10M StartTime: DateTime: 2024-12-31T23:59:00Z DeleteAlarmErrorResponse: title: DeleteAlarmErrorResponse example: - error: "Alarm instance not found" - errorDescription: "Alarm occurrence delete request failed for guid : 4c4c4544-005a-3510-8047-b4c04f564433." + error: 'Alarm instance not found' + errorDescription: 'Alarm occurrence delete request failed for guid : 4c4c4544-005a-3510-8047-b4c04f564433.' properties: success: description: HTTP returncode @@ -2402,7 +2402,7 @@ components: type: integer powerOnToPXE: type: integer - example: + example: Power up: 2 Power cycle: 5 Power down: 8 @@ -2423,15 +2423,15 @@ components: PowerActionRequest: title: PowerActionRequest required: - - action - - useSOL + - action + - useSOL example: action: 8 useSOL: false properties: action: type: integer - enum: + enum: - 2 - 5 - 8 @@ -2464,27 +2464,27 @@ components: bootDetails: type: object properties: - url: + url: + type: string + username: + type: string + password: type: string - username: - type: string - password: - type: string - description: Password for authentication - bootPath: - type: string - description: Boot path for PBA and WinRE boot scenarios - enforceSecureBoot: - type: boolean + description: Password for authentication + bootPath: + type: string + description: Boot path for PBA and WinRE boot scenarios + enforceSecureBoot: + type: boolean PowerActionResponse: title: PowerActionResponse example: Header: - To: "http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous" + To: 'http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous' RelatesTo: 0 - Action: "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService/RequestPowerStateChangeResponse" - MessageID: "uuid:00000000-8086-8086-8086-0000000450A6" - ResourceURI: "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService" + Action: 'http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService/RequestPowerStateChangeResponse' + MessageID: 'uuid:00000000-8086-8086-8086-0000000450A6' + ResourceURI: 'http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService' Body: ReturnValue: 0 ReturnValueStr: SUCCESS @@ -2497,8 +2497,8 @@ components: ReturnValueStr: type: string UserConsentRequest: - required: - - consentCode + required: + - consentCode example: consentCode: 123456 properties: @@ -2507,16 +2507,16 @@ components: UserConsentResponse: type: object example: - Header: - Action: "http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService/StartOptInResponse" - MessageID: "uuid:00000000-8086-8086-8086-000000001ACD" - Method: "StartOptIn" - RelatesTo: "1" - ResourceURI: "http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService" - To: "http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous" - Body: + Header: + Action: 'http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService/StartOptInResponse' + MessageID: 'uuid:00000000-8086-8086-8086-000000001ACD' + Method: 'StartOptIn' + RelatesTo: '1' + ResourceURI: 'http://intel.com/wbem/wscim/1/ips-schema/1/IPS_OptInService' + To: 'http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous' + Body: ReturnValue: 0 - ReturnValueStr: "SUCCESS" + ReturnValueStr: 'SUCCESS' properties: Header: type: object @@ -2536,10 +2536,10 @@ components: Body: type: object properties: - ReturnValue: + ReturnValue: type: integer - ReturnValueStr: - type: string + ReturnValueStr: + type: string DeactivateResponse: title: DeactivateResponse example: @@ -2552,14 +2552,23 @@ components: example: guid: '123e4567-e89b-12d3-a456-426614174000' hostname: 'AMTDEVICENUC1' - tags: ['Texas','NUC','Store #123'] + tags: ['Texas', 'NUC', 'Store #123'] mpsInstance: 'test.mystack.com' connectionStatus: true mpsusername: 'admin' tenantId: '' friendlyName: '' dnsSuffix: '' - deviceInfo: {'fwVersion':'16.1', 'fwBuild':'1111', 'fwSku':'16392', 'currentMode':'0', 'features':'AMT Pro Corporate', 'ipAddress':'', 'lastUpdate':'2023-11-13T17:20:59.043Z'} + deviceInfo: + { + 'fwVersion': '16.1', + 'fwBuild': '1111', + 'fwSku': '16392', + 'currentMode': '0', + 'features': 'AMT Pro Corporate', + 'ipAddress': '', + 'lastUpdate': '2023-11-13T17:20:59.043Z' + } lastConnected: '2023-11-13T17:21:57.885Z' lastSeen: '2023-11-13T17:33:57.915Z' lastDisconnected: '2023-11-13T17:22:57.885Z' @@ -2596,42 +2605,42 @@ components: deviceInfo: type: object properties: - fwVersion: + fwVersion: type: string - fwBuild: + fwBuild: type: string - fwSku: + fwSku: type: string - currentMode: + currentMode: type: string features: type: string - ipAddress: + ipAddress: type: string lastUpdated: type: string format: date-time CountDevicesResponse: title: CountDevicesResponse - type: object + type: object properties: data: type: array items: - $ref: '#/components/schemas/Device' + $ref: '#/components/schemas/Device' totalCount: type: integer AddDevice: title: AddDevice required: - - guid - - hostname - - tags + - guid + - hostname + - tags example: guid: '123e4567-e89b-12d3-a456-426614174000' hostname: 'AMTDEVICENUC1' friendlyName: 'store12pos2' - tags: ['Texas','NUC','Store #123'] + tags: ['Texas', 'NUC', 'Store #123'] properties: guid: type: string @@ -2644,39 +2653,48 @@ components: deviceInfo: type: object properties: - fwVersion: + fwVersion: type: string - fwBuild: + fwBuild: type: string - fwSku: + fwSku: type: string - currentMode: + currentMode: type: string - ipAddress: + ipAddress: type: string - AddDeviceResponse: - title: DeviceResponse + AddDeviceResponse: + title: DeviceResponse required: - - guid - - hostname - - tags - - mpsInstance - - connectionStatus - - mpsusername - - tenantID - - friendlyName - - dnsSuffix - example: + - guid + - hostname + - tags + - mpsInstance + - connectionStatus + - mpsusername + - tenantID + - friendlyName + - dnsSuffix + example: guid: '123e4567-e89b-12d3-a456-426614174000' hostname: 'AMTDEVICENUC1' tags: ['Texas', 'NUC', 'Store #123'] mpsInstance: null - connectionStatus: false + connectionStatus: false mpsusername: null tenantID: '' friendlyName: 'store12pos2' dnsSuffix: null - deviceInfo: {'fwVersion':'16.1', 'fwBuild':'1111', 'fwSku':'16392', 'currentMode':'0', 'features':'AMT Pro Corporate', 'ipAddress':'', 'lastUpdated':'2023-11-13T17:20:59.043Z'} + deviceInfo: + { + 'fwVersion': '16.1', + 'fwBuild': '1111', + 'fwSku': '16392', + 'currentMode': '0', + 'features': 'AMT Pro Corporate', + 'ipAddress': '', + 'lastUpdated': '2023-11-13T17:20:59.043Z' + } lastConnected: '2023-11-13T17:21:57.885Z' lastSeen: '2023-11-13T17:33:57.915Z' lastDisconnected: '2023-11-13T17:22:57.885Z' @@ -2691,15 +2709,15 @@ components: type: array items: type: string - mpsInstance: + mpsInstance: type: string - connectionStatus: + connectionStatus: type: boolean - mpsusername: + mpsusername: type: string tenantID: type: string - friendlyName: + friendlyName: type: string lastConnected: type: string @@ -2713,31 +2731,31 @@ components: deviceInfo: type: object properties: - fwVersion: + fwVersion: type: string - fwBuild: + fwBuild: type: string - fwSku: + fwSku: type: string - currentMode: + currentMode: type: string features: type: string - ipAddress: + ipAddress: type: string lastUpdated: type: string format: date-time - EditDevice: - title: EditDevice + EditDevice: + title: EditDevice required: - - guid + - guid example: guid: '123e4567-e89b-12d3-a456-426614174000' hostname: 'AMTDEVICENUC1' dnsSuffix: 'os.suffix.com' friendlyName: 'store12pos2' - tags: ['Texas','NUC','Store #123'] + tags: ['Texas', 'NUC', 'Store #123'] properties: guid: type: string @@ -2754,39 +2772,48 @@ components: deviceInfo: type: object properties: - fwVersion: + fwVersion: type: string - fwBuild: + fwBuild: type: string - fwSku: + fwSku: type: string - currentMode: + currentMode: type: string - ipAddress: + ipAddress: type: string EditDeviceResponse: - title: DeviceResponse + title: DeviceResponse required: - - guid - - hostname - - tags - - mpsInstance - - connectionStatus - - mpsusername - - tenantID - - friendlyName - - dnsSuffix - example: + - guid + - hostname + - tags + - mpsInstance + - connectionStatus + - mpsusername + - tenantID + - friendlyName + - dnsSuffix + example: guid: '123e4567-e89b-12d3-a456-426614174000' hostname: 'AMTDEVICENUC1' tags: ['Texas', 'NUC', 'Store #123'] mpsInstance: null - connectionStatus: false + connectionStatus: false mpsusername: 'admin' tenantID: '' friendlyName: 'store12pos2' dnsSuffix: 'os.suffix.com' - deviceInfo: {'fwVersion':'16.1', 'fwBuild':'1111', 'fwSku':'16392', 'currentMode':'0', 'features':'AMT Pro Corporate', 'ipAddress':'', 'lastUpdated':'2023-11-13T17:20:59.043Z'} + deviceInfo: + { + 'fwVersion': '16.1', + 'fwBuild': '1111', + 'fwSku': '16392', + 'currentMode': '0', + 'features': 'AMT Pro Corporate', + 'ipAddress': '', + 'lastUpdated': '2023-11-13T17:20:59.043Z' + } lastConnected: '2023-11-13T17:21:57.885Z' lastSeen: '2023-11-13T17:33:57.915Z' lastDisconnected: '2023-11-13T17:22:57.885Z' @@ -2801,15 +2828,15 @@ components: type: array items: type: string - mpsInstance: + mpsInstance: type: string - connectionStatus: + connectionStatus: type: boolean - mpsusername: + mpsusername: type: string tenantID: type: string - friendlyName: + friendlyName: type: string lastConnected: type: string @@ -2823,17 +2850,17 @@ components: deviceInfo: type: object properties: - fwVersion: + fwVersion: type: string - fwBuild: + fwBuild: type: string - fwSku: + fwSku: type: string - currentMode: + currentMode: type: string features: type: string - ipAddress: + ipAddress: type: string lastUpdated: type: string @@ -2875,8 +2902,8 @@ components: DeleteErrorResponse: title: DeleteErrorResponse example: - error: "Device not found/connected. Please connect again using CIRA." - errorDescription: "guid : 038d0240-045c-05f4-7706-980700080009" + error: 'Device not found/connected. Please connect again using CIRA.' + errorDescription: 'guid : 038d0240-045c-05f4-7706-980700080009' properties: success: description: HTTP returncode @@ -2890,7 +2917,7 @@ components: DisconnectResponse: title: DisconnectResponse example: - description: "CIRA connection disconnected : 038d0240-045c-05f4-7706-980700080009" + description: 'CIRA connection disconnected : 038d0240-045c-05f4-7706-980700080009' properties: success: description: HTTP returncode @@ -2901,8 +2928,8 @@ components: DisconnectErrorResponse: title: DisconnectErrorResponse example: - error: "Device not found/connected. Please connect again using CIRA." - errorDescription: "guid : 038d0240-045c-05f4-7706-980700080009" + error: 'Device not found/connected. Please connect again using CIRA.' + errorDescription: 'guid : 038d0240-045c-05f4-7706-980700080009' properties: success: description: HTTP returncode @@ -2917,7 +2944,7 @@ components: title: DeleteResponse example: success: 200 - description: "Device info refreshed : 4c4c4544-004c-4d10-8050-c2c04f325133" + description: 'Device info refreshed : 4c4c4544-004c-4d10-8050-c2c04f325133' properties: success: description: HTTP returncode @@ -2929,58 +2956,58 @@ components: HealthcheckResponse: title: HealthcheckResponse example: - db: - name: "POSTGRES" - status: "OK" - secretStore: - name: "VAULT" - status: - initialized: true - sealed: false - standby: false - performance_standby: false - replication_performance_mode: "disabled" - replication_dr_mode: "disabled" - server_time_utc: 1646337196 - version: "1.9.3" - cluster_name: "vault-cluster-3dc0c596" - cluster_id: "469ada72-d74b-4d1e-6e77-476bf9902b72" + db: + name: 'POSTGRES' + status: 'OK' + secretStore: + name: 'VAULT' + status: + initialized: true + sealed: false + standby: false + performance_standby: false + replication_performance_mode: 'disabled' + replication_dr_mode: 'disabled' + server_time_utc: 1646337196 + version: '1.9.3' + cluster_name: 'vault-cluster-3dc0c596' + cluster_id: '469ada72-d74b-4d1e-6e77-476bf9902b72' properties: - db: - type: object - properties: - name: - type: string - status: - type: string - secretStore: - type: object - properties: - name: - type: string - status: - type: object - properties: - initialized: - type: boolean - sealed: - type: boolean - standby: - type: boolean - performance_standby: - type: boolean - replication_performance_mode: - type: string - replication_dr_mode: - type: string - server_time_utc: - type: integer - version: - type: string - cluster_name: - type: string - cluster_id: - type: string + db: + type: object + properties: + name: + type: string + status: + type: string + secretStore: + type: object + properties: + name: + type: string + status: + type: object + properties: + initialized: + type: boolean + sealed: + type: boolean + standby: + type: boolean + performance_standby: + type: boolean + replication_performance_mode: + type: string + replication_dr_mode: + type: string + server_time_utc: + type: integer + version: + type: string + cluster_name: + type: string + cluster_id: + type: string VersionResponse: title: VersionResponse required: @@ -2996,124 +3023,124 @@ components: type: object properties: certificates: - type: object - properties: - keyManagementItems: - type: array - items: - type: object - description: Array of key management items - publicKeyCertificateItems: - type: array - items: - type: object - properties: - elementName: - type: string - description: Name of the certificate element - instanceID: - type: string - description: Unique instance identifier for the certificate - x509Certificate: - type: string - description: Base64 encoded X.509 certificate - trustedRootCertificate: - type: boolean - description: Whether this is a trusted root certificate - issuer: - type: string - description: Certificate issuer distinguished name - subject: - type: string - description: Certificate subject distinguished name - readOnlyCertificate: - type: boolean - description: Whether the certificate is read-only - publicKeyHandle: - type: string - description: Handle to the associated public key - associatedProfiles: - type: array - items: - type: string - description: List of profiles associated with this certificate - displayName: + type: object + properties: + keyManagementItems: + type: array + items: + type: object + description: Array of key management items + publicKeyCertificateItems: + type: array + items: + type: object + properties: + elementName: + type: string + description: Name of the certificate element + instanceID: + type: string + description: Unique instance identifier for the certificate + x509Certificate: + type: string + description: Base64 encoded X.509 certificate + trustedRootCertificate: + type: boolean + description: Whether this is a trusted root certificate + issuer: + type: string + description: Certificate issuer distinguished name + subject: + type: string + description: Certificate subject distinguished name + readOnlyCertificate: + type: boolean + description: Whether the certificate is read-only + publicKeyHandle: + type: string + description: Handle to the associated public key + associatedProfiles: + type: array + items: type: string - description: Human-readable display name for the certificate - required: - - elementName - - instanceID - - x509Certificate - - trustedRootCertificate - - issuer - - subject - - readOnlyCertificate - - associatedProfiles - - displayName + description: List of profiles associated with this certificate + displayName: + type: string + description: Human-readable display name for the certificate + required: + - elementName + - instanceID + - x509Certificate + - trustedRootCertificate + - issuer + - subject + - readOnlyCertificate + - associatedProfiles + - displayName publicKeys: + type: object + properties: + publicPrivateKeyPairItems: + type: array + items: + type: object + properties: + elementName: + type: string + description: Name of the key element + instanceID: + type: string + description: Unique instance identifier for the key pair + derKey: + type: string + description: DER-encoded public key + required: + - elementName + - instanceID + - derKey + profileAssociation: + type: array + items: type: object properties: - publicPrivateKeyPairItems: - type: array - items: - type: object - properties: - elementName: - type: string - description: Name of the key element - instanceID: - type: string - description: Unique instance identifier for the key pair - derKey: - type: string - description: DER-encoded public key - required: - - elementName - - instanceID - - derKey - profileAssociation: - type: array - items: - type: object - properties: - type: - type: string - description: Type of profile association - enum: - - TLS - profileID: - type: string - description: Identifier of the associated profile - clientCertificate: - type: object - properties: - elementName: - type: string - instanceID: - type: string - x509Certificate: - type: string - trustedRootCertificate: - type: boolean - issuer: - type: string - subject: - type: string - readOnlyCertificate: - type: boolean - publicKeyHandle: - type: string - associatedProfiles: - type: array - items: - type: string - displayName: + type: + type: string + description: Type of profile association + enum: + - TLS + profileID: + type: string + description: Identifier of the associated profile + clientCertificate: + type: object + properties: + elementName: + type: string + instanceID: + type: string + x509Certificate: + type: string + trustedRootCertificate: + type: boolean + issuer: + type: string + subject: + type: string + readOnlyCertificate: + type: boolean + publicKeyHandle: + type: string + associatedProfiles: + type: array + items: type: string - description: Client certificate used for this profile association - required: - - type - - profileID - - clientCertificate + displayName: + type: string + description: Client certificate used for this profile association + required: + - type + - profileID + - clientCertificate required: - certificates - publicKeys @@ -3122,35 +3149,35 @@ components: certificates: keyManagementItems: [] publicKeyCertificateItems: - - elementName: "Intel(r) AMT Certificate" - instanceID: "Intel(r) AMT Certificate: Handle: 0" - x509Certificate: "base64_encoded_certificate" + - elementName: 'Intel(r) AMT Certificate' + instanceID: 'Intel(r) AMT Certificate: Handle: 0' + x509Certificate: 'base64_encoded_certificate' trustedRootCertificate: false - issuer: "C=US,S=California,L=Santa Clara,O=Intel Corporation,CN=Intel® AMT self-signed certificate" - subject: "C=US,S=California,L=Santa Clara,O=Intel Corporation,CN=Intel® AMT self-signed certificate" + issuer: 'C=US,S=California,L=Santa Clara,O=Intel Corporation,CN=Intel® AMT self-signed certificate' + subject: 'C=US,S=California,L=Santa Clara,O=Intel Corporation,CN=Intel® AMT self-signed certificate' readOnlyCertificate: true - publicKeyHandle: "" - associatedProfiles: ["TLS"] - displayName: "Intel® AMT self-signed certificate" + publicKeyHandle: '' + associatedProfiles: ['TLS'] + displayName: 'Intel® AMT self-signed certificate' publicKeys: publicPrivateKeyPairItems: - - elementName: "Intel(r) AMT Key" - instanceID: "Intel(r) AMT Key: Handle: 0" - derKey: "base64_encoded_public_key" + - elementName: 'Intel(r) AMT Key' + instanceID: 'Intel(r) AMT Key: Handle: 0' + derKey: 'base64_encoded_public_key' profileAssociation: - - type: "TLS" - profileID: "TLSProtocolEndpoint Instances Collection" + - type: 'TLS' + profileID: 'TLSProtocolEndpoint Instances Collection' clientCertificate: - elementName: "Intel(r) AMT Certificate" - instanceID: "Intel(r) AMT Certificate: Handle: 0" - x509Certificate: "base64_encoded_certificate" + elementName: 'Intel(r) AMT Certificate' + instanceID: 'Intel(r) AMT Certificate: Handle: 0' + x509Certificate: 'base64_encoded_certificate' trustedRootCertificate: false - issuer: "C=US,S=California,L=Santa Clara,O=Intel Corporation,CN=Intel® AMT self-signed certificate" - subject: "C=US,S=California,L=Santa Clara,O=Intel Corporation,CN=Intel® AMT self-signed certificate" + issuer: 'C=US,S=California,L=Santa Clara,O=Intel Corporation,CN=Intel® AMT self-signed certificate' + subject: 'C=US,S=California,L=Santa Clara,O=Intel Corporation,CN=Intel® AMT self-signed certificate' readOnlyCertificate: true - publicKeyHandle: "" - associatedProfiles: ["TLS"] - displayName: "Intel® AMT self-signed certificate" + publicKeyHandle: '' + associatedProfiles: ['TLS'] + displayName: 'Intel® AMT self-signed certificate' AddCertificatesRequest: title: AddCertificateRequest type: object @@ -3165,7 +3192,7 @@ components: - cert - isTrusted example: - cert: "base64_encoded_certificate" + cert: 'base64_encoded_certificate' isTrusted: true AddCertificatesResponse: type: object @@ -3176,7 +3203,7 @@ components: required: - handle example: - handle: "Intel(r) AMT Certificate: Handle: 2" + handle: 'Intel(r) AMT Certificate: Handle: 2' GetDisplaysResponse: type: object properties: @@ -3244,7 +3271,7 @@ components: properties: IPS_KVMRedirectionSettingData: $ref: '#/components/schemas/KVMRedirectionSettingData' - + KVMRedirectionSettingData: type: object properties: @@ -3262,7 +3289,7 @@ components: example: true ElementName: type: string - example: "Intel(r) KVM Redirection Settings" + example: 'Intel(r) KVM Redirection Settings' EnabledByMEBx: type: boolean example: true @@ -3274,7 +3301,7 @@ components: example: 2 InstanceID: type: string - example: "Intel(r) KVM Redirection Settings" + example: 'Intel(r) KVM Redirection Settings' Is5900PortEnabled: type: boolean example: false @@ -3283,7 +3310,7 @@ components: example: false RFBPassword: type: string - example: "" + example: '' SessionTimeout: type: integer example: 3 @@ -3294,25 +3321,25 @@ components: type: array items: $ref: '#/components/schemas/BootSource' - + BootSource: type: object properties: biosBootString: type: string - example: "" + example: '' bootString: type: string - example: "" + example: '' elementName: type: string - example: "" + example: '' failThroughSupported: type: integer example: 0 instanceID: type: string - example: "" + example: '' structuredBiosBootString: type: string - example: "" + example: ''