openapi: 3.0.2 info: description: 'IoTHub API-Gateway API ' title: IoTHub API-Gateway API version: ${project.version} servers: - description: Production Enviroment url: https://api.edgelock2go.com/iothubapigateway/v1 tags: - name: product - name: deviceGroup - name: service - name: claimCode paths: /products: get: description: Fetch product details. Use devBoard flags to filter only for development boards (aka. development kits) operationId: getProducts parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: The hardware type explode: true in: query name: hardwareType required: false schema: type: string style: form - description: The hardware variant explode: true in: query name: hardwareVariant required: false schema: type: string style: form - description: 'If the nc12 is set, the response is filtered for the product given by the 12NC. The returned list is either empty (12NC not found) or has only one entry. ' explode: true in: query name: nc12 required: false schema: $ref: '#/components/schemas/nc12Type' style: form - description: 'If the deviceId is set, the response is filtered for the product the device belongs to. The returned list is either empty (device not found) or has only one entry, as one device can only belong to one product. ' explode: true in: query name: deviceId required: false schema: $ref: '#/components/schemas/deviceIdDecHex' style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ProductWithBatches' type: array description: list of products '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed summary: Retrieve products tags: - product /hardware-types: get: description: Retrieve all hardware types operationId: getHardwareTypes parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/HardwareType' type: array description: List of product hardware types and unique products per hardware type '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type summary: Retrieve all hardware types tags: - product /dev-boards: get: description: Retrieve all development boards operationId: getDevBoards parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/DevBoard' type: array description: List of development boards including product information '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type summary: Retrieve all development boards tags: - product /products/{nc12}/device-groups: get: description: 'fetch a paginated list of device groups belonging to a nc12 product. Name parameter is available for additional filtering. ' operationId: getDeviceGroups parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: filter for device group by name explode: true in: query name: name required: false schema: $ref: '#/components/schemas/genericLongNameWithWildcards' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - explode: true in: query name: size required: false schema: $ref: '#/components/schemas/pageSize' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceGroupPage' description: Page of avaliable device groups '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: returns an array of customer device groups tags: - deviceGroup post: description: 'create a new device group for a specific nc12 product. ' operationId: addDeviceGroup parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/NewDeviceGroup' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceGroupDetails' description: Device group response '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: create a new device group tags: - deviceGroup /products/{nc12}/device-groups/{deviceGroupId}: delete: description: 'Delete a device group belonging to a specific nc12 product. Can only be deleted if no devices/services/claim codes/secure objects are assigned. ' operationId: deleteDeviceGroup parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Delete the device group. tags: - deviceGroup get: description: 'fetch a specific device group by id and nc12 product. ' operationId: getDeviceGroup parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceGroupDetails' description: Device group response '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: returns the device group identified by the unique id tags: - deviceGroup put: description: 'update a specific device group belonging to a specific nc12. ' operationId: updateDeviceGroup parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeviceGroup' required: true responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Update the device group. tags: - deviceGroup /products/{nc12}/device-groups/{deviceGroupId}/devices: get: description: 'fetch a paginated list of devices belonging to a specific device group and nc12. Response includes provisioning information for each device. ' operationId: getDevicesInDeviceGroup parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - explode: true in: query name: size required: false schema: $ref: '#/components/schemas/pageSize' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceServiceProvisioningPage' description: list of device '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: returns an array of devices denoted by device uid assigned to the device group tags: - deviceGroup post: description: 'assign a batch of devices from nxp generic device group to a specific customer device group. Minimum size of a batch is 1 and maximum is 500. If the device group is already assigned to the service then this device will also be provisioned. ' operationId: whitelistDevices parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/WhitelistDevicesRequest' description: 'A list of device ids that are to be whitelisted ' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceServiceProvisioningPage' description: All devices were whitelisted successfully '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: assign devices to a device group. tags: - deviceGroup /products/{nc12}/device-groups/{deviceGroupId}/devices/unclaim: post: description: 'Using this operation, the devices are moved from customer'' device group into the nxp'' generic device group. ' operationId: unclaimDevices parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceIdList' description: 'A list of device ids that are to be unclaimed ' required: true responses: '202': content: application/json: schema: $ref: '#/components/schemas/DeviceIdsProcessResult' description: 'Provides the list of succesfully and unsuccessfully processed devices ' '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Unclaim a list of devices. tags: - deviceGroup /products/{nc12}/device-groups/{deviceGroupId}/unclaim: post: description: 'Using this operation, all devices from the customer''s device group are moved into the nxp generic device group. ' operationId: unclaimGroupDevices parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '202': description: Request accepted '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Unclaim all devices in given group. tags: - deviceGroup /products/{nc12}/device-groups/{deviceGroupId}/claim-codes: get: description: 'fetch a paginated list of claim codes belonging to a specific device group of a specific nc12. It is possible to filter the results by status and usage status. Results do not include claim code secrets. ' operationId: getClaimCodesInDeviceGroup parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple - description: claim code name explode: true in: query name: name required: false schema: $ref: '#/components/schemas/genericLongNameWithWildcards' style: form - description: claim code max counter achieved explode: true in: query name: usageStatus required: false schema: $ref: '#/components/schemas/usageStatus' style: form - description: claim code status explode: true in: query name: status required: false schema: $ref: '#/components/schemas/claimStatus' style: form - description: sort by field explode: true in: query name: sort-by required: false schema: type: string style: form - description: sort by direction ASC or DESC explode: true in: query name: sort-by-direction required: false schema: $ref: '#/components/schemas/SortByDirection' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - explode: true in: query name: size required: false schema: $ref: '#/components/schemas/pageSize' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClaimCodePage' description: List of claim codes '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: returns an array of claim codes denoted by device uid assigned to the device group tags: - claimCode post: description: 'Create a claim code for a specific device group. Devices with this claim code (up to a limit) will be automatically whitelisted and assigned to the specified device group. When a new claim code is created, status will be automatically set to ACTIVE. If policy is UNRESTRICTED, behaviour must be ALLOWED and device limit must be zero. Otherwise device limit must be greater than zero and behaviour can be ALLOWED or DENY. Name of the claim code must be unique for a device group. ' operationId: createClaimCode parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimCode' description: 'The claim code body ' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClaimCode' description: Returns claim code '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: create a claim code for a device group. tags: - claimCode /products/{nc12}/device-groups/{deviceGroupId}/claim-codes/statistics: get: description: 'returns grouped by usage claim code statistics with amount of claim codes ' operationId: getClaimCodesStatistics parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClaimCodeStatistics' description: Claim code statistics '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: returns statistic for claim code in device group tags: - claimCode /products/{nc12}/device-groups/{deviceGroupId}/claim-codes/create-batch: post: description: This API creates a high number of claim codes. operationId: createClaimCodeBatch parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimCodeBatchRequest' description: The claim code batch body required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClaimCodeBatchResponse' description: Claim codes creation started '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: create batch of claim codes for a device group. tags: - claimCode /products/{nc12}/device-groups/{deviceGroupId}/claim-codes/batches/{batchId}: get: description: returns claim code batch progress. operationId: getClaimCodeBatchStatus parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple - description: claim code batch id explode: false in: path name: batchId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClaimCodeBatchStatus' description: Claim code status '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Returns claim code batch status tags: - claimCode /products/{nc12}/device-groups/{deviceGroupId}/claim-codes/{claimCodeId}: delete: description: 'delete claim code. ' operationId: deleteClaimCode parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple - description: claim code id explode: false in: path name: claimCodeId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: delete a claim code. tags: - claimCode get: description: 'returns a specific claim code for a specific device group and nc12 product. ' operationId: getClaimCodeById parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple - description: claim code id explode: false in: path name: claimCodeId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClaimCode' description: claim code '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: returns claim code by given id tags: - claimCode put: description: 'update a specific active claim code. If policy is updated to UNRESTRICTED, behaviour must be ALLOWED and device limit must be zero. Otherwise device limit must be greater than zero and behaviour can be ALLOWED or DENY. Name of the claim code must be unique for a device group. ' operationId: updateClaimCode parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple - description: claim code id explode: false in: path name: claimCodeId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimCodeBase' description: 'The claim code body ' required: true responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: update a claim code. tags: - claimCode /products/{nc12}/device-groups/{deviceGroupId}/claim-codes/{claimCodeId}/decrypt: get: description: 'fetch a decrpyted secret of a specific claim code belonging to a device group and nc12. ' operationId: getClaimCodeSecret parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple - description: claim code id explode: false in: path name: claimCodeId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/claimCodeSecret' description: Claim code secret '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: returns decrypted secret of claim code tags: - claimCode /products/{nc12}/device-groups/{deviceGroupId}/claim-codes/{claimCodeId}/revoke: post: description: 'Change the status of the claim code to REVOKED. New devices will no longer be assigned for this claim code. ' operationId: revokeClaimCode parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple - description: claim code id explode: false in: path name: claimCodeId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: revoke the given claim code tags: - claimCode /claim-codes/delete-by-criteria: post: description: 'delete all claim codes that match specified criteria. The possible criterias are revoked claim codes, maximum usage achieved and created before specified date. If revoked or maximumUsageAchieved are missing or false, they will not be used as criterias. If more than one criteria is used, they will be combined using logical AND operator. Meaning that only the claim codes that match all criterias will be deleted. If there is no valid criteria (revoked and maximumUsageAchieved are false or not set and createdBefore is not specified), error will be returned ' operationId: deleteClaimCodesByCriteria parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimCodeDeleteCriteriaRequest' description: 'The body containing the list of claim code ids to be deleted. ' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClaimCodeDeleteCriteriaResponse' description: the response contains number of claim codes deleted '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: delete claim codes based on criteria tags: - claimCode /claim-codes/batch-delete: post: description: 'Delete all claim codes with specified ids. If there is no claim code for any given id, it will be ignored. If there are no claim codes for any id, nothing will happen. ' operationId: deleteClaimCodesBatch parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ClaimCodeDeleteBatchRequest' description: 'The body containing the list of claim code ids to be deleted. ' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClaimCodeDeleteBatchResponse' description: 'Response contains a list of claim code ids that were deleted succesfully and a list of claim code ids that were not deleted. ' '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: delete claim codes in batch tags: - claimCode /products/{nc12}/device-groups/{deviceGroupId}/devices/{deviceId}: get: description: 'Fetch data for a specific device belonging to a device group and nc12. ' operationId: getDevice parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: nxp product label explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - description: uid explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple - description: device unique id explode: false in: path name: deviceId required: true schema: $ref: '#/components/schemas/deviceId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/Device' description: Device resource representation '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: return device data tags: - deviceGroup /devices: get: description: 'fetch a paginated list of devices whitelisted/claimed by customer. It is possible to filter the results by product type and device id. ' operationId: getDevices parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: filter for devices by id, wildcards (*) are supported explode: true in: query name: device-id required: false schema: $ref: '#/components/schemas/deviceIdWithWildcards' style: form - description: filter for devices by name, wildcards (*) are supported explode: true in: query name: producttype required: false schema: $ref: '#/components/schemas/genericLongNameWithWildcards' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - explode: true in: query name: size required: false schema: $ref: '#/components/schemas/pageSize' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/DevicePage' description: Returns page of avaliable devices '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: retrieve customer devices tags: - device /devices/{deviceId}/product: get: description: Determines and returns the product of the given deviceId. operationId: getProductOfDevice parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Device ID explode: false in: path name: deviceId required: true schema: $ref: '#/components/schemas/deviceId' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProductBase' description: Device group response '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed summary: Get product of given device tags: - device /cos/certificates: get: description: 'retrieve a paginated list of certificates and/or CSRs created by customer. Additional filtering is possible by name, status, signer, validity and whether certificates are assigned to any service. ' operationId: getCertificates parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: filter for certificates by name - case insensitive substring match explode: true in: query name: certificate-name required: false schema: $ref: '#/components/schemas/genericLongNameWithWildcards' style: form - description: filter for certificate status explode: true in: query name: status required: false schema: $ref: '#/components/schemas/CertificateSigningStateEnum' style: form - description: filter for signed by explode: true in: query name: signer required: false schema: $ref: '#/components/schemas/CertificateSigningAuthorityEnum' style: form - description: filter for valid or invalid certificates explode: true in: query name: validity required: false schema: $ref: '#/components/schemas/CertificateValidityEnum' style: form - description: filter certificates for service assignment status explode: true in: query name: serviceAssigned required: false schema: $ref: '#/components/schemas/ServiceAssignmentStatusEnum' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - explode: true in: query name: size required: false schema: $ref: '#/components/schemas/pageSize' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CertificatePage' description: Returns certificate page '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: retrieve certificates tags: - certificate /cos/certificates/{certificateId}: delete: description: 'delete an existing intermediate certificate with a given id. For a certificate to be deleted it must not be assigned to any service. ' operationId: deleteCertificate parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: certificate ID explode: false in: path name: certificateId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: delete an intermediate certificate tags: - certificate get: description: 'get information for a specific certificate by id. ' operationId: getCertificate parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: certificate ID explode: false in: path name: certificateId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/IntermediateCertificate' description: returns the intermediate certificate '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: get certificate by certificateId tags: - certificate /cos/certificates/create-intermediate-cert: post: description: 'creates a new intermediate certificate with nxp root ' operationId: createNxpIntermediateCertificate parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateIntermediateCertificateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/IntermediateCertificate' description: Returns the intermediate certificate '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: new nxp intermediate certificate tags: - certificate /cos/certificates/create-csr: post: description: 'creates a new certificate signing request that can be signed by a non-nxp root CA. ' operationId: createCsr parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCsrRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/IntermediateCertificate' description: Returns the intermediate certificate csr '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: new csr tags: - certificate /cos/certificates/{certificateId}/csr-value: get: description: 'Get the csr of the EXT certificate resource. If the resource is NXP, an error will be returned. ' operationId: getCsrValue parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Numeric ID of the certificate resource explode: false in: path name: certificateId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/CsrValue' description: Returns the value of the csr '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: csr for the certificate tags: - certificate /cos/certificates/{certificateId}/add-certificate-value: put: description: 'Attach signed certificate to the EXT resource. If the resource is NXP signed, an error will be returned. ' operationId: addCertificateValue parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Numeric ID of the certificate resource explode: false in: path name: certificateId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AddCertificateValueRequest' required: true responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: upload certificate signed by your own root CA tags: - certificate /audits: get: operationId: getAudits parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Event type explode: true in: query name: event-type required: false schema: $ref: '#/components/schemas/AuditEventTypeEnum' style: form - description: Start date of created audits explode: true in: query name: start-date required: false schema: format: date type: string style: form - description: End date of created audits explode: true in: query name: end-date required: false schema: format: date type: string style: form - description: sort by field explode: true in: query name: sort-by required: false schema: type: string style: form - description: sort by direction ASC or DESC explode: true in: query name: sort-by-direction required: false schema: $ref: '#/components/schemas/SortByDirection' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - description: Number of records per page. explode: true in: query name: size required: false schema: default: 20 format: int32 maximum: 100 minimum: 1 type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuditObjectPage' description: List of audit details '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Retrieve audits tags: - audit /audits/create-report: post: operationId: createReport parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AggregatedAuditRequest' required: true responses: '200': description: File download '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Retrieve the report tags: - audit /rtp/device-groups/{deviceGroupId}/devices/download-provisionings: post: description: 'Download file with devices and their secure object provisionings. ' operationId: downloadRtpProvisionings parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Numeric ID of the device group resource explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: items: $ref: '#/components/schemas/deviceId' maxItems: 500 minItems: 1 type: array required: true responses: '200': content: application/octet-stream: schema: format: binary type: string description: Returns device provisionings '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: donwload secure object provisionings for provided list of device ids. tags: - secureObject /rtp/provisionings/{provisioningId}/download-intermediate-ca: get: operationId: downloadIntermediateCaByProvisioningId parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Numeric ID of the secure object provisioning explode: false in: path name: provisioningId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/octet-stream: schema: format: binary type: string description: Returns intermediate CA in PEM format '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Download intermediate CA of an X.509 secure object provisioning by provisioning ID in PEM format tags: - secureObject /rtp/provisionings/{provisioningId}/download-certificate: get: operationId: downloadProvisioningCertificate parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Numeric ID of the secure object provisioning explode: false in: path name: provisioningId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/octet-stream: schema: format: binary type: string description: Returns certificate in PEM format '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Download certificate of an X.509 secure object provisioning in PEM format tags: - secureObject /rtp/device-groups/{deviceGroupId}/devices/{deviceId}/provisionings: get: description: 'Fetch secure object provisionings for single device. ' operationId: getSecureObjectProvisioningsForDeviceGroupAndDevice parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Numeric ID of the device group resource explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple - description: Unique device id explode: false in: path name: deviceId required: true schema: $ref: '#/components/schemas/deviceId' style: simple - explode: true in: query name: secureObjectIds required: false schema: items: $ref: '#/components/schemas/id' type: array style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - explode: true in: query name: size required: false schema: $ref: '#/components/schemas/pageSize' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/RtpDeviceProvisioningPage' description: Returns device provisionings '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Fetch secure object provisionings for device id. tags: - secureObject /rtp/secure-objects: get: description: '# Get list of secure objects by filters ' operationId: getSecureObjects parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Secure object type explode: true in: query name: secureObjectType required: false schema: $ref: '#/components/schemas/SecureObjectTypeEnum' style: form - description: Name of secure object explode: true in: query name: name required: false schema: $ref: '#/components/schemas/genericLongNameWithWildcards' style: form - description: sort by field explode: true in: query name: sortBy required: false schema: type: string style: form - description: sort by direction ASC or DESC explode: true in: query name: sortByDirection required: false schema: $ref: '#/components/schemas/SortByDirection' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - description: Number of records per page. explode: true in: query name: size required: false schema: default: 20 format: int32 maximum: 100 minimum: 1 type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecureObjectPage' description: Returns secure object details '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Get list of secure objects tags: - secureObject post: description: '# Create secure object for devices ' operationId: createSecureObject parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SecureObjectCreateRequest' description: Secure object request model required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecureObject' description: Returns created secure object '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Create secure object tags: - secureObject /rtp/secure-objects/{secureObjectId}: delete: operationId: deleteSecureObject parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Unique secure object id explode: false in: path name: secureObjectId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Removes a secure object with unique id tags: - secureObject get: operationId: getSecureObject parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Unique secure object id explode: false in: path name: secureObjectId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecureObject' description: Secure object detail '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Get a secure object in details with unique id tags: - secureObject put: description: '# Change Secure Object ' operationId: changeSecureObject parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Unique secure object id explode: false in: path name: secureObjectId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SecureObjectChangeRequest' description: Secure object with edited name required: true responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: change name of and/or add additional policies to secure object tags: - secureObject /rtp/secure-objects/{secureObjectId}/assign-device-group: post: operationId: assignDeviceGroup parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Unique secure object id explode: false in: path name: secureObjectId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceGroupIdBody' required: true responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Assign device group to a secure object tags: - secureObject /rtp/device-groups/{deviceGroupId}/assigned-secure-objects: get: operationId: getAssignedSecureObjects parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: service ID explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple - description: Secure object type explode: true in: query name: secureObjectType required: false schema: $ref: '#/components/schemas/SecureObjectTypeEnum' style: form - description: Name of secure object explode: true in: query name: secureObjectName required: false schema: $ref: '#/components/schemas/genericLongNameWithWildcards' style: form - description: sort by field explode: true in: query name: sortBy required: false schema: type: string style: form - description: sort by direction ASC or DESC explode: true in: query name: sortByDirection required: false schema: $ref: '#/components/schemas/SortByDirection' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - explode: true in: query name: size required: false schema: $ref: '#/components/schemas/pageSize' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecureObjectInDeviceGroupPage' description: Returns secure objects in device group '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Get secure objects which are assigned to the device group tags: - secureObject /rtp/secure-objects/{secureObjectId}/unassign-device-groups: post: operationId: unassignDeviceGroupsFromSecureObject parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Unique secure object id explode: false in: path name: secureObjectId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: items: $ref: '#/components/schemas/id' maxItems: 500 minItems: 1 type: array required: true responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Unassign a secure Object from list of device groups tags: - secureObject /rtp/secure-objects/{secureObjectId}/available-device-groups: get: operationId: getAvailableDeviceGroups parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Unique secure object id explode: false in: path name: secureObjectId required: true schema: $ref: '#/components/schemas/id' style: simple - description: Filter for device group by name, wildcards (*) are supported explode: true in: query name: name required: false schema: $ref: '#/components/schemas/genericLongNameWithWildcards' style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/DeviceGroupBasicDetails' type: array description: Returns device groups available for secure object '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Returns a customer's device groups which are available for assignment to a particular secure object tags: - secureObject /rtp/device-groups/{deviceGroupId}/unassign-secure-objects: post: operationId: unassignSecureObjectsFromDeviceGroup parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Unique device group id explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple requestBody: content: application/json: schema: items: $ref: '#/components/schemas/id' maxItems: 500 minItems: 1 type: array required: true responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Unassign a Secure Objects from device group tags: - secureObject /rtp/device-groups/{deviceGroupId}/available-secure-objects: get: operationId: getAvailableSecureObjects parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: service ID explode: false in: path name: deviceGroupId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/SecureObject' type: array description: Returns secure objects available for assignment to the device group '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Get secure objects which are available for assignment to the device group tags: - secureObject /rtp/secure-objects/{secureObjectId}/assigned-device-groups: get: operationId: getAssignedDeviceGroups parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Sort by field explode: true in: query name: sortBy required: false schema: type: string style: form - description: Sort by direction ASC or DESC explode: true in: query name: sortByDirection required: false schema: $ref: '#/components/schemas/SortByDirection' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - explode: true in: query name: size required: false schema: $ref: '#/components/schemas/pageSize' style: form - description: Unique secure object id explode: false in: path name: secureObjectId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceGroupInSecureObjectPage' description: Returns sevice groups assigned to secure object '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Returns a customer's assined device groups for a particular secure object tags: - secureObject /rtp/settings/secure-object/{hardwareFamilyType}/reserved-oids: get: description: '# Provides validation rules that will be used during secure object creation ' operationId: getSecureObjectReservedOids parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - explode: false in: path name: hardwareFamilyType required: true schema: $ref: '#/components/schemas/ProductHardwareFamilyType' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecureObjectValidations' description: Returns secure object validations '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: provides validation rules tags: - secureObject /rtp/settings/secure-object/policy-template/{nc12}/{secureObjectType}: get: operationId: getSecureObjectPolicyTemplate parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - explode: false in: path name: nc12 required: true schema: $ref: '#/components/schemas/nc12Type' style: simple - explode: false in: path name: secureObjectType required: true schema: $ref: '#/components/schemas/SecureObjectTypeEnum' style: simple - explode: true in: query name: algorithm required: false schema: $ref: '#/components/schemas/PolicyAlgorithmEnum' style: form - explode: true in: query name: policyType required: true schema: $ref: '#/components/schemas/PolicyProfileType' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecureObjectPolicyTemplateResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: provides default product profile for 12NC and secure object type tags: - secureObject /rtp/secure-objects/{secureObjectId}/policies: get: operationId: getPoliciesForSecureObject parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Unique secure object id explode: false in: path name: secureObjectId required: true schema: $ref: '#/components/schemas/id' style: simple - explode: true in: query name: nc12 required: false schema: $ref: '#/components/schemas/nc12Type' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - explode: true in: query name: size required: false schema: $ref: '#/components/schemas/pageSize' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecureObjectPolicyPage' description: Returns secure object policies '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: fetch policies for a secure object tags: - secureObject /rtp/secure-objects/{secureObjectId}/provisionings: get: operationId: getSecureObjectProvisionings parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Unique secure object id explode: false in: path name: secureObjectId required: true schema: $ref: '#/components/schemas/id' style: simple - description: Filter for devices by id, wildcards (*) are supported explode: true in: query name: deviceId required: false schema: $ref: '#/components/schemas/deviceIdWithWildcards' style: form - description: Filter for devices by provisioning state explode: true in: query name: provisioningState required: false schema: $ref: '#/components/schemas/SecureObjectProvisioningState' style: form - description: Sort by field explode: true in: query name: sortBy required: false schema: type: string style: form - description: Sort by direction ASC or DESC explode: true in: query name: sortByDirection required: false schema: $ref: '#/components/schemas/SortByDirection' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - explode: true in: query name: size required: false schema: $ref: '#/components/schemas/pageSize' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecureObjectProvisioningPage' description: Returns secure object provisionings '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Get provisionings for secure object. tags: - secureObject /rtp/devices/{deviceId}/secure-object-provisionings: get: operationId: getSecureObjectProvisioningsForDevice parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Unique device id explode: false in: path name: deviceId required: true schema: $ref: '#/components/schemas/deviceId' style: simple - description: Sort by field explode: true in: query name: sortBy required: false schema: type: string style: form - description: sort by direction ASC or DESC explode: true in: query name: sortByDirection required: false schema: $ref: '#/components/schemas/SortByDirection' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - explode: true in: query name: size required: false schema: $ref: '#/components/schemas/pageSize' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecureObjectProvisioningPage' description: Returns page of all assigned provisionings '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Get provisionings for single device. tags: - secureObject /rtp/intermediate-cas/{intermediateCaId}/csr: get: description: Get the csr of the EXT certificate resource. If the resource is NXP, an error will be returned. operationId: getRtpCsrValue parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Numeric ID of the certificate resource explode: false in: path name: intermediateCaId required: true schema: format: int64 type: integer style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/CsrValue' description: returns the value of the csr '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: csr for the certificate tags: - intermediateCa /rtp/intermediate-cas/{intermediateCaId}/upload-signed-intermediate-ca: put: description: Attach signed certificate to the EXT resource. If the resource is NXP signed, an error will be returned. operationId: uploadRtpSignedIntermediateCa parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Numeric ID of the certificate resource explode: false in: path name: intermediateCaId required: true schema: format: int64 type: integer style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadSignedIntermediateCaRequest' required: true responses: '204': description: No content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: upload certificate signed by your own root CA tags: - intermediateCa /rtp/intermediate-cas: get: operationId: getRtpIntermediateCertificates parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: filter for intermediate certificates by name - case insensitive substring match explode: true in: query name: name required: false schema: $ref: '#/components/schemas/genericLongNameWithWildcards' style: form - description: filter for intermediate certificate status explode: true in: query name: status required: false schema: $ref: '#/components/schemas/CertificateSigningStateEnum' style: form - description: filter for signed by explode: true in: query name: signer required: false schema: $ref: '#/components/schemas/CertificateSigningAuthorityEnum' style: form - description: filter for valid or invalid intermediate certificates explode: true in: query name: validity required: false schema: $ref: '#/components/schemas/CertificateValidityEnum' style: form - description: filter for valid or invalid intermediate certificates explode: true in: query name: algorithm required: false schema: $ref: '#/components/schemas/IntermediateCaAlgorithmEnum' style: form - description: sort by field explode: true in: query name: sort-by required: false schema: type: string style: form - description: sort by direction ASC or DESC explode: true in: query name: sort-by-direction required: false schema: $ref: '#/components/schemas/SortByDirection' style: form - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - description: Number of records per page. explode: true in: query name: size required: false schema: default: 20 format: int32 maximum: 100 minimum: 1 type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/RtpIntermediateCertificatePage' description: Intermediate certificate page '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: retrieve rtp intermediate certificates tags: - intermediateCa post: description: creates a new intermediate certificate using nxp root or optionally creates custom CSR operationId: createRtpIntermediateCertificate parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRtpIntermediateBase' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RtpIntermediateCertificate' description: Returns created object '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: new intermediate certificate tags: - intermediateCa /rtp/intermediate-cas/{intermediateCaId}: delete: operationId: deleteRtpIntermediateCertificate parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: certificate ID explode: false in: path name: intermediateCaId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '204': description: No Content '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: removes certificate by certificateId tags: - intermediateCa get: operationId: getRtpIntermediateCertificateById parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: certificate ID explode: false in: path name: intermediateCaId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/RtpIntermediateCertificate' description: returns the intermediate certificate '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: get certificate by certificateId tags: - intermediateCa /rtp/intermediate-cas/{intermediateCaId}/download-intermediate-ca: get: operationId: downloadRtpIntermediateCa parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: intermediate CA ID explode: false in: path name: intermediateCaId required: true schema: $ref: '#/components/schemas/id' style: simple responses: '200': content: application/octet-stream: schema: format: binary type: string description: Returns intermediate CA in PEM format '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '405': content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed '409': content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict '413': content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large '415': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error '502': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway '503': content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error summary: Download intermediate CA of an X.509 secure object provisioning in PEM format tags: - intermediateCa /rtp/intermediate-cas/{intermediateCaId}/create-verification-certificate: post: description: Create verification leaf x509 certificate signed by intermdiate Ca and CN name as verification code. operationId: createVerificationCertificate parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: Numeric ID of the certificate resource explode: false in: path name: intermediateCaId required: true schema: format: int64 type: integer style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/VerificationCertificateRequest' required: true responses: '200': content: application/octet-stream: schema: format: binary type: string description: x509 certicate content as file '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: Create verification leaf x509 certificate. tags: - intermediateCa /rtp/intermediate-cas/{intermediateCaId}/secure-objects: get: operationId: getIntermediateCaCertificates parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: certificate ID explode: false in: path name: intermediateCaId required: true schema: $ref: '#/components/schemas/id' style: simple - explode: true in: query name: page required: false schema: $ref: '#/components/schemas/pageNumber' style: form - description: Number of records per page. explode: true in: query name: size required: false schema: default: 20 format: int32 maximum: 100 minimum: 1 type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/IntermediateCaCertificatesPage' description: Page of secure object details '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: get intermediate associated certificates tags: - intermediateCa /rtp/intermediate-cas/supported-algorithms: get: operationId: getCertificateSupportedAlgorithms parameters: - explode: false in: header name: EL2G-Correlation-ID required: false schema: $ref: '#/components/schemas/correlationId' style: simple - explode: false in: header name: EL2G-API-Key required: true schema: $ref: '#/components/schemas/EL2G-API-Key' style: simple - description: IntermediateCA algorithm explode: true in: query name: intermediateCaAlgorithm required: false schema: $ref: '#/components/schemas/IntermediateCaAlgorithmEnum' style: form - description: KeyPair algorithm explode: true in: query name: keyPairAlgorithm required: false schema: $ref: '#/components/schemas/KeyPairAlgorithmEnum' style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/CertificateSupportedAlgorithmResponse' description: List of supported algorithms '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error summary: get KeyPair and IntermidiateCA algorithm combinations for X.509 certificate tags: - intermediateCa /swagger: x-swagger-pipe: swagger_raw components: responses: R202: description: Request accepted R400: content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad request R401: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized R403: content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden R404: content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found R405: content: application/json: schema: $ref: '#/components/schemas/Error' description: Method not allowed R409: content: application/json: schema: $ref: '#/components/schemas/Error' description: Conflict R413: content: application/json: schema: $ref: '#/components/schemas/Error' description: Request entity too large R415: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unsupported media type R422: content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource validation failed R500: content: application/json: schema: $ref: '#/components/schemas/Error' description: Unexpected error R502: content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad gateway R503: content: application/json: schema: $ref: '#/components/schemas/Error' description: Temporary error schemas: correlationId: format: uuid type: string EL2G-API-Key: description: EdgeLock api key value type: string nc12Type: maxLength: 12 minLength: 12 pattern: ^[\d]+$ type: string deviceIdDecHex: description: paddedDevice UID as decimal or hex string pattern: ^0[xX][0-9a-fA-F]+$|^[0-9]+$ type: string ProductWithBatches: allOf: - $ref: '#/components/schemas/ProductBase' - $ref: '#/components/schemas/ProductWithBatches_allOf' ProductBase: example: nc12: nc12 hardwareType: hardwareType softwareVersion: softwareVersion commercialName: commercialName hardwareVariant: hardwareVariant properties: nc12: maxLength: 12 minLength: 12 pattern: ^[\d]+$ type: string commercialName: description: Commercial name of a given product type. Has to be unique. Copy from OEFInfo.nc12 type: string hardwareType: description: The hardware type type: string hardwareVariant: description: The hardware variant type: string hardwareFamilyType: $ref: '#/components/schemas/ProductHardwareFamilyType' softwareVersion: description: Version information of the software to be displayed. Derive inside FabProductionDetailReceiver. type: string required: - commercialName - hardwareFamilyType - nc12 ProductHardwareFamilyType: enum: - A71 - SE05 - A500 - REDFINCH type: string Profile: description: Profile information container properties: type: description: Product profile type readOnly: true type: string active: description: Active state of product profile readOnly: true type: boolean type: object companyName: description: Company name, fully formatted maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9 (),\-\.\/@]+$ type: string batchIdType: description: Represents a unique oef number. pattern: ^[a-zA-Z0-9]{0,30}$ type: string Error: properties: code: type: string description: type: string details: type: string fieldErrors: items: $ref: '#/components/schemas/FieldError' type: array required: - code - description type: object FieldError: properties: code: format: int32 type: integer field: type: string description: type: string type: object HardwareType: description: The hardware type including a list of hardware variants example: hardwareVariants: - name: name products: - nc12: nc12 hardwareType: hardwareType softwareVersion: softwareVersion commercialName: commercialName hardwareVariant: hardwareVariant - nc12: nc12 hardwareType: hardwareType softwareVersion: softwareVersion commercialName: commercialName hardwareVariant: hardwareVariant - name: name products: - nc12: nc12 hardwareType: hardwareType softwareVersion: softwareVersion commercialName: commercialName hardwareVariant: hardwareVariant - nc12: nc12 hardwareType: hardwareType softwareVersion: softwareVersion commercialName: commercialName hardwareVariant: hardwareVariant name: name properties: name: type: string hardwareVariants: items: $ref: '#/components/schemas/HardwareVariant' type: array required: - name HardwareVariant: description: The hardware variant including a list of products per type example: name: name products: - nc12: nc12 hardwareType: hardwareType softwareVersion: softwareVersion commercialName: commercialName hardwareVariant: hardwareVariant - nc12: nc12 hardwareType: hardwareType softwareVersion: softwareVersion commercialName: commercialName hardwareVariant: hardwareVariant properties: name: type: string products: items: $ref: '#/components/schemas/ProductBase' type: array required: - name DevBoard: description: The development board including product information example: product: nc12: nc12 hardwareType: hardwareType softwareVersion: softwareVersion commercialName: commercialName hardwareVariant: hardwareVariant color: color name: name properties: name: type: string color: type: string product: $ref: '#/components/schemas/ProductBase' required: - color - name - product genericLongNameWithWildcards: example: Custom*5 maxLength: 100 minLength: 1 pattern: ^[a-zA-Z0-9 _\-*]+$ type: string pageNumber: default: 0 description: results page you want to retrieve (0..N) format: int32 type: integer pageSize: default: 20 description: number of records per page format: int32 maximum: 100 minimum: 1 type: integer DeviceGroupPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/DeviceGroupPage_allOf' PageResponse: discriminator: propertyName: pageType properties: current: type: string next: type: string prev: type: string totalElements: format: int64 type: integer pageType: type: string required: - pageType type: object DeviceGroupDetails: allOf: - $ref: '#/components/schemas/BaseDeviceGroupObject' - $ref: '#/components/schemas/DeviceGroupDetails_allOf' description: device group details resource representation type: object BaseDeviceGroupObject: description: base device group object properties: id: description: uid format: int64 type: integer deviceGroupName: description: customer unique device group name example: Device Group-1 maxLength: 100 minLength: 2 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string required: - deviceGroupName type: object id: description: uid format: int64 type: integer deviceGroupName: description: customer unique device group name example: Device Group-1 maxLength: 100 minLength: 2 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string deviceCount: minimum: 1 type: integer CustomerProductTypeRelationship: enum: - OWNER - USER type: string ResourceMetadata: example: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 properties: createdBy: type: string createdTs: format: date-time type: string lastModifiedBy: type: string lastModifiedTs: format: date-time type: string version: format: int64 type: integer type: object ClaimCodeStatistics: example: totalAmount: 6 groupedStatistics: - amount: 0 - amount: 0 properties: groupedStatistics: description: List of claim code overview items: $ref: '#/components/schemas/ClaimCodeGroupedStatistic' type: array totalAmount: format: int64 type: integer type: object ClaimCodeStatisticsList: description: List of claim code overview items: $ref: '#/components/schemas/ClaimCodeGroupedStatistic' type: array ClaimCodeGroupedStatistic: example: amount: 0 properties: status: $ref: '#/components/schemas/claimcodeStatisticGroup' amount: format: int64 type: integer type: object claimcodeStatisticGroup: default: LOW enum: - LOW - MEDIUM - HIGH type: string NewDeviceGroup: description: object for creating a new device group resource example: deviceGroupName: Device Group-1 properties: deviceGroupName: description: customer unique device group name example: Device Group-1 maxLength: 100 minLength: 2 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string required: - deviceGroupName type: object UpdateDeviceGroup: description: object for updating a device group resource example: deviceGroupName: Device Group-1 properties: deviceGroupName: description: customer unique device group name example: Device Group-1 maxLength: 100 minLength: 2 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string required: - deviceGroupName type: object DeviceServiceProvisioningPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/DeviceServiceProvisioningPage_allOf' DeviceServiceProvisioning: properties: device: $ref: '#/components/schemas/Device' secureUseKeyMaterial: $ref: '#/components/schemas/DeviceSecureUseKeyMaterial' provisionings: items: $ref: '#/components/schemas/Provisioning' type: array type: object Device: example: resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 deviceGroupId: 0 deviceGroupName: deviceGroupName id: id lastConnection: 2000-01-23 04:56:07+00:00 properties: id: description: paddedDevice UID as Java BigInteger String pattern: ^[\d]+$ type: string deviceGroupId: description: id of a group that device belongs to format: int64 type: integer deviceGroupName: type: string productDetail: $ref: '#/components/schemas/ProductDetail' lastConnection: description: date of the last connection of the device to NXP IoTHub. format: date-time type: string resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' required: - deviceGroupId - id type: object deviceId: description: paddedDevice UID as Java BigInteger String pattern: ^[\d]+$ type: string deviceGroupIdType: description: id of a group that device belongs to format: int64 type: integer ProductDetail: allOf: - $ref: '#/components/schemas/ProductBase' - $ref: '#/components/schemas/ProductDetail_allOf' DeviceSecureUseKeyMaterial: properties: id: description: paddedDevice UID as Java BigInteger String pattern: ^[\d]+$ type: string deviceGroupId: description: id of a group that device belongs to format: int64 type: integer secure_use_wrap_key_pair_kek: format: byte type: string secure_use_wrap_key_pair: format: byte type: string secure_use_wrap_key_pair_kcv: format: byte type: string secure_use_wrap_key_public_key: format: byte type: string secure_use_wrap_key_public_key_kcv: format: byte type: string zmk_kcv: format: byte type: string required: - deviceGroupId - id - secure_use_wrap_key_pair - secure_use_wrap_key_pair_kek - secure_use_wrap_key_public_key - secure_use_wrap_key_public_key_kcv - zmk_kcv type: object Provisioning: description: device provisioning details example: provisioningId: 0 deviceArn: deviceArn publicKey: publicKey deviceId: deviceId signedCertificate: signedCertificate cloudCertificateId: cloudCertificateId resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 nextProvisioningStateTs: 2000-01-23 04:56:07+00:00 currentProvisioningStateTs: 2000-01-23 04:56:07+00:00 deviceGroupId: 6 service: deviceConfig: endPoint: port: 1 serverCertificate: serverCertificate host: mqtt.nxp.com metaData: key: metaData intermediateCertificate: commonName: commonName country: country lastModifiedAt: 2000-01-23 04:56:07+00:00 orgUnit: orgUnit lastModifiedBy: lastModifiedBy locality: locality serviceName: serviceName createdAt: 2000-01-23 04:56:07+00:00 createdBy: createdBy cloudId: cloudId organization: organization name: name validUntil: 2000-01-23 04:56:07+00:00 id: 6 state: state serviceid: 1 value: value deletedBy: deletedBy resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 isRevoked: true deletedAt: 2000-01-23 04:56:07+00:00 isDeleted: true name: CustomName 123-5 assignedDevicesCount: 5 revokedBy: revokedBy id: 0 revokedAt: 2000-01-23 04:56:07+00:00 deviceGroupName: deviceGroupName properties: provisioningId: description: uid format: int64 type: integer deviceId: type: string deviceGroupId: description: uid format: int64 type: integer deviceGroupName: type: string service: $ref: '#/components/schemas/Service' currentProvisioningState: $ref: '#/components/schemas/ProvisioningState' currentProvisioningStateTs: description: timestamp format: date-time type: string nextProvisioningState: $ref: '#/components/schemas/ProvisioningState' nextProvisioningStateTs: description: timestamp format: date-time type: string publicKey: description: PEM formatted Public Key pattern: '-----BEGIN PUBLIC KEY-----(?:[\s\S]*?)-----END PUBLIC KEY-----\s*$' type: string signedCertificate: description: Certificate in X509 PEM encoded format pattern: '-----BEGIN CERTIFICATE-----(?:[\s\S]*?)-----END CERTIFICATE-----\s*$' type: string resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' deviceArn: type: string cloudCertificateId: type: string type: object Service: discriminator: propertyName: service_type example: deviceConfig: endPoint: port: 1 serverCertificate: serverCertificate host: mqtt.nxp.com metaData: key: metaData intermediateCertificate: commonName: commonName country: country lastModifiedAt: 2000-01-23 04:56:07+00:00 orgUnit: orgUnit lastModifiedBy: lastModifiedBy locality: locality serviceName: serviceName createdAt: 2000-01-23 04:56:07+00:00 createdBy: createdBy cloudId: cloudId organization: organization name: name validUntil: 2000-01-23 04:56:07+00:00 id: 6 state: state serviceid: 1 value: value deletedBy: deletedBy resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 isRevoked: true deletedAt: 2000-01-23 04:56:07+00:00 isDeleted: true name: CustomName 123-5 assignedDevicesCount: 5 revokedBy: revokedBy id: 0 revokedAt: 2000-01-23 04:56:07+00:00 properties: service_type: $ref: '#/components/schemas/ServiceTypeEnum' id: description: Unique ID of that service assigned by the server. format: int64 type: integer name: description: Name of the entity example: CustomName 123-5 maxLength: 30 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string intermediateCertificate: $ref: '#/components/schemas/IntermediateCertificate' serviceStatus: $ref: '#/components/schemas/ServiceStatusEnum' deviceConfig: $ref: '#/components/schemas/DeviceConfig' resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' assignedDevicesCount: description: Number of non-revoked devices assigned to the service. format: int64 type: integer revokedBy: type: string revokedAt: format: date-time type: string isRevoked: type: boolean deletedBy: description: Identifier or description who created/modified the resource. maxLength: 255 minLength: 1 type: string deletedAt: format: date-time type: string isDeleted: type: boolean required: - name - service_type type: object ServiceTypeEnum: enum: - AWSService - AzureService - CustomService type: string genericName: description: Name of the entity example: CustomName 123-5 maxLength: 30 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string IntermediateCertificate: example: commonName: commonName country: country lastModifiedAt: 2000-01-23 04:56:07+00:00 orgUnit: orgUnit lastModifiedBy: lastModifiedBy locality: locality serviceName: serviceName createdAt: 2000-01-23 04:56:07+00:00 createdBy: createdBy cloudId: cloudId organization: organization name: name validUntil: 2000-01-23 04:56:07+00:00 id: 6 state: state serviceid: 1 value: value properties: id: description: uid format: int64 type: integer name: description: name of the certificate, not used in the certificate it self type: string value: description: value of the certificate encoded in PEM format type: string cloudId: description: The id of the service certificate in the cloud, on AWS this is the ARN type: string commonName: description: common name for the certificate type: string organization: description: organization for the certificate type: string orgUnit: description: organizational unit for the certificate type: string country: description: country for the certificate type: string locality: description: locality for the certificate type: string state: description: state for the certificate type: string serviceid: description: uid format: int64 type: integer serviceName: description: name of assigned service type: string signingState: $ref: '#/components/schemas/CertificateSigningStateEnum' signingAuthority: $ref: '#/components/schemas/CertificateSigningAuthorityEnum' validUntil: format: date-time type: string createdBy: description: Identifier or description who created/modified the resource. maxLength: 255 minLength: 1 type: string createdAt: format: date-time type: string lastModifiedBy: description: Identifier or description who created/modified the resource. maxLength: 255 minLength: 1 type: string lastModifiedAt: format: date-time type: string type: object CertificateSigningStateEnum: description: Indicates if certificate is signed or only csr generated enum: - CSR_CREATED - SIGNED type: string CertificateSigningAuthorityEnum: description: Indicates if certificate is signed by NXP or externally enum: - NXP - EXT type: string createdBy: description: Identifier or description who created/modified the resource. maxLength: 255 minLength: 1 type: string modifiedBy: description: Identifier or description who created/modified the resource. maxLength: 255 minLength: 1 type: string ServiceStatusEnum: enum: - VALID - INVALID - INITIAL type: string DeviceConfig: description: 'This object defines a concrete onboarding info string required to finally configure the device. Protocol, cipher suite, the connection URL and serverCertificate, defining the certificate to verify the public key of the server to connect to, are mandatory fields. The config is not interpreted by NXP IoTHub but blindly forwarded to the device and can be used together with custom cloud infrastructures. ' example: endPoint: port: 1 serverCertificate: serverCertificate host: mqtt.nxp.com metaData: key: metaData properties: endPoint: $ref: '#/components/schemas/EndPoint' metaData: additionalProperties: type: string description: The meta data in the form of a Map (name-value pair) that you have defined in EdgeLock 2GO. type: object type: object EndPoint: example: port: 1 serverCertificate: serverCertificate host: mqtt.nxp.com properties: host: example: mqtt.nxp.com pattern: (?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-z0-9])?\.)+[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9] type: string port: description: port number of the service. format: int32 minimum: 1 type: integer protocol: $ref: '#/components/schemas/ServiceProtocolEnum' serverCertificate: description: Certificate in X509 PEM encoded format pattern: '-----BEGIN CERTIFICATE-----(?:[\s\S]*?)-----END CERTIFICATE-----\s*$' type: string type: object ServiceProtocolEnum: enum: - HTTPS - MQTTS - AMQPS - XMPP - DDS - CoAP type: string X509PemCertificate: description: Certificate in X509 PEM encoded format pattern: '-----BEGIN CERTIFICATE-----(?:[\s\S]*?)-----END CERTIFICATE-----\s*$' type: string MetaDataType: additionalProperties: type: string description: The meta data in the form of a Map (name-value pair) that you have defined in EdgeLock 2GO. type: object ProvisioningState: enum: - TO_BE_PROVISIONED - PROVISIONED - TO_BE_REVOKED - REVOKED - TO_BE_UPDATED - DEFECTIVE type: string timeStamp: description: timestamp format: date-time type: string PemPublicKey: description: PEM formatted Public Key pattern: '-----BEGIN PUBLIC KEY-----(?:[\s\S]*?)-----END PUBLIC KEY-----\s*$' type: string WhitelistDevicesRequest: example: deviceIds: - null - null - null - null - null properties: deviceIds: items: $ref: '#/components/schemas/deviceId' maxItems: 500 minItems: 1 type: array required: - deviceIds type: object DeviceIdList: example: deviceIds: - null - null - null - null - null properties: deviceIds: items: $ref: '#/components/schemas/deviceId' maxItems: 500 minItems: 1 type: array required: - deviceIds type: object DeviceIdsProcessResult: example: successfulDeviceIds: - null - null failedDeviceIds: - null - null properties: successfulDeviceIds: items: $ref: '#/components/schemas/deviceId' type: array failedDeviceIds: items: $ref: '#/components/schemas/deviceId' type: array type: object usageStatus: default: ALL enum: - REACHED - UNREACHED - ALL type: string claimStatus: default: ALL enum: - ACTIVE - REVOKED - ALL type: string SortByDirection: default: DESC enum: - DESC - ASC type: string ClaimCodePage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/ClaimCodePage_allOf' ClaimCode: allOf: - $ref: '#/components/schemas/ClaimCodeBase' - $ref: '#/components/schemas/ClaimCode_allOf' ClaimCodeBase: example: name: CustomName 123-5 deviceLimit: 0 reusable: true properties: name: description: Name of the entity example: CustomName 123-5 maxLength: 100 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string policy: $ref: '#/components/schemas/claimCodePolicy' behavior: $ref: '#/components/schemas/claimCodeBehavior' deviceLimit: default: 0 format: int64 minimum: 0 type: integer reusable: default: true type: boolean required: - behavior - deviceLimit - name - policy type: object genericLongName: description: Name of the entity example: CustomName 123-5 maxLength: 100 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string claimCodePolicy: default: UNRESTRICTED enum: - RESTRICTED - UNRESTRICTED type: string claimCodeBehavior: default: ALLOW enum: - ALLOW - DENY type: string claimCodeDeviceLimit: default: 0 format: int64 minimum: 0 type: integer reusableClaim: default: true type: boolean claimCodeId: $ref: '#/components/schemas/id' claimCodeSecret: pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$ type: string claimCodedDeviceCount: default: 0 format: int64 minimum: 0 type: integer ClaimCodeBatchRequest: example: namePrefix: namePrefix numberOfClaimCodes: 0 deviceLimit: 0 reusable: true properties: namePrefix: description: Prefix for the name maxLength: 50 minLength: 3 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string numberOfClaimCodes: description: Amount of claim coddes to be created format: int64 type: integer policy: $ref: '#/components/schemas/claimCodePolicy' behavior: $ref: '#/components/schemas/claimCodeBehavior' deviceLimit: default: 0 format: int64 minimum: 0 type: integer reusable: default: true type: boolean required: - namePrefix - numberOfClaimCodes type: object ClaimCodeBatchResponse: example: batchId: 0 properties: batchId: description: uid format: int64 type: integer required: - batchId type: object ClaimCodeBatchStatus: example: progressInPercentage: 60 batchId: 0 properties: batchId: description: uid format: int64 type: integer progressInPercentage: maximum: 100 minimum: 0 type: integer required: - batchId - progressInPercentage type: object ClaimCodeDeleteCriteriaRequest: example: createdBefore: 2000-01-23 04:56:07+00:00 revoked: true maxUsageAchieved: true properties: revoked: type: boolean maxUsageAchieved: type: boolean createdBefore: format: date-time type: string type: object ClaimCodeDeleteCriteriaResponse: example: deletedCount: 0 properties: deletedCount: format: int64 type: integer type: object ClaimCodeDeleteBatchRequest: example: claimCodeIds: - null - null - null - null - null properties: claimCodeIds: items: $ref: '#/components/schemas/claimCodeId' maxItems: 500 minItems: 1 type: array required: - claimCodeIds type: object ClaimCodeDeleteBatchResponse: description: 'Response object when adding devices. The object holds successfully processed or failed device UIDs ' example: processedClaimCodeIds: - null - null failedClaimCodeId: - null - null properties: processedClaimCodeIds: items: $ref: '#/components/schemas/claimCodeId' type: array failedClaimCodeId: items: $ref: '#/components/schemas/claimCodeId' type: array type: object CryptoPackageInfo: example: fileName: fileName size: 0 isDownloaded: true nc12: nc12 deviceCount: deviceCount lastDownloadedTs: 2000-01-23 04:56:07+00:00 sha512: sha512 batchId: batchId commercialName: commercialName properties: commercialName: description: Commercial Name readOnly: true type: string nc12: description: Project/ 12nc of the device readOnly: true type: string batchId: description: Represents a unique oef number. pattern: ^[a-zA-Z0-9]{0,30}$ type: string deviceCount: description: number of devices in the package readOnly: true type: string fileName: description: name of the batch file maxLength: 255 readOnly: true type: string size: description: size of the file format: int64 readOnly: true type: integer sha512: description: checksum of the package. readOnly: true type: string isDownloaded: description: flag for the file download status readOnly: true type: boolean lastDownloadedTs: description: Contains timestamp for last download format: date-time type: string required: - batchId - commercialName - deviceCount - fileName - isDownloaded - nc12 - sha512 - size URLData: example: data: data name: name properties: name: description: File Name type: string data: description: URL that can be used to access the content type: string required: - name - url DeliverySearchType: default: Any enum: - Batch - FtLot - Any type: string DeliveryUnitPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/DeliveryUnitPage_allOf' DeliveryUnit: description: Delivery unit properties: deliveryUnitId: description: Represents a unique delivery unit number. pattern: ^[a-zA-Z0-9]{1,30}$ type: string deliveryType: $ref: '#/components/schemas/DeliveryType' deviceCount: description: number of devices in the delivery unit readOnly: true type: integer deviceUidsAvailable: type: boolean required: - deliveryType - deliveryUnitId - deviceCount - deviceUidsAvailable type: object deliveryUnitId: description: Represents a unique delivery unit number. pattern: ^[a-zA-Z0-9]{1,30}$ type: string DeliveryType: enum: - Batch - FtLot type: string DeliveryUnitFile: description: Delivery unit example: fileName: fileName size: 0 isDownloaded: true lastDownloadedTs: 2000-01-23 04:56:07+00:00 sha512: sha512 properties: fileName: description: name of the file maxLength: 255 readOnly: true type: string size: description: size of the file format: int64 readOnly: true type: integer sha512: description: checksum of the package. readOnly: true type: string isDownloaded: description: flag for the file download status readOnly: true type: boolean lastDownloadedTs: description: Contains timestamp for last download format: date-time type: string required: - fileName - isDownloaded - sha512 - size type: object Batch: example: resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 totalFilesCount: 5 size: 6 nc12: nc12 productionDisplayDate: 2000-01-23 04:56:07+00:00 batchId: batchId deviceQuantity: 0 deviceUidsAvailable: true downloadedFilesCount: 1 cryptomaterials: - fileName: fileName size: 5 isDownloaded: true lastDownloadedTs: 2000-01-23 04:56:07+00:00 sha512: sha512 - fileName: fileName size: 5 isDownloaded: true lastDownloadedTs: 2000-01-23 04:56:07+00:00 sha512: sha512 commercialName: commercialName properties: batchId: description: Represents a unique oef number. pattern: ^[a-zA-Z0-9]{0,30}$ type: string nc12: maxLength: 12 minLength: 12 pattern: ^[\d]+$ type: string commercialName: type: string deviceQuantity: description: Number of devices format: int32 type: integer size: description: Total size of the files format: int64 type: integer productionDisplayDate: description: Contains timestamp for production display date format: date-time type: string downloadedFilesCount: description: Number of downloaded files format: int32 type: integer totalFilesCount: description: Total number of files format: int32 type: integer deviceUidsAvailable: type: boolean cryptomaterials: items: $ref: '#/components/schemas/CryptoPackage' type: array resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' required: - batchId - commercialName - deviceQuantity - deviceUidsAvailable - nc12 - productionDisplayDate type: object CryptoPackage: example: fileName: fileName size: 5 isDownloaded: true lastDownloadedTs: 2000-01-23 04:56:07+00:00 sha512: sha512 properties: fileName: description: name of the batch file maxLength: 255 readOnly: true type: string size: description: size of the file format: int64 readOnly: true type: integer sha512: description: checksum of the package. readOnly: true type: string isDownloaded: description: flag for the file download status readOnly: true type: boolean lastDownloadedTs: description: Contains timestamp for last download format: date-time type: string required: - fileName - isDownloaded - sha512 - size ServicePage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/ServicePage_allOf' CreateServiceRequest: description: object for creating a new Service example: intermediateCAId: 0 service: deviceConfig: endPoint: port: 1 serverCertificate: serverCertificate host: mqtt.nxp.com metaData: key: metaData intermediateCertificate: commonName: commonName country: country lastModifiedAt: 2000-01-23 04:56:07+00:00 orgUnit: orgUnit lastModifiedBy: lastModifiedBy locality: locality serviceName: serviceName createdAt: 2000-01-23 04:56:07+00:00 createdBy: createdBy cloudId: cloudId organization: organization name: name validUntil: 2000-01-23 04:56:07+00:00 id: 6 state: state serviceid: 1 value: value deletedBy: deletedBy resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 isRevoked: true deletedAt: 2000-01-23 04:56:07+00:00 isDeleted: true name: CustomName 123-5 assignedDevicesCount: 5 revokedBy: revokedBy id: 0 revokedAt: 2000-01-23 04:56:07+00:00 intermediateCAName: CustomName 123-5 intermediateCACNPrefix: intermediateCACNPrefix properties: service: $ref: '#/components/schemas/Service' assignCertificateMode: $ref: '#/components/schemas/AssignCertificateMode' intermediateCAId: description: uid format: int64 type: integer intermediateCAName: description: Name of the entity example: CustomName 123-5 maxLength: 100 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string intermediateCACNPrefix: type: string required: - assignCertificateMode - service type: object AssignCertificateMode: enum: - CREATE_ON_THE_FLY - USE_EXISTING type: string RevokeServiceRequest: description: object for creating a new Service example: revokedBy: revokedBy properties: revokedBy: description: Identifier or description who created/modified the resource. maxLength: 255 minLength: 1 type: string required: - revokedBy type: object ServiceSecurityUpdate: discriminator: propertyName: requestType example: requestType: requestType properties: requestType: type: string service_type: $ref: '#/components/schemas/ServiceTypeEnum' required: - requestType - service_type type: object DeviceGroupIds: example: deviceGroupIds: - null - null - null - null - null properties: deviceGroupIds: items: $ref: '#/components/schemas/deviceGroupIdType' maxItems: 500 minItems: 1 type: array required: - deviceGroupIds type: object deviceIdWithWildcards: example: 123*9 minLength: 1 pattern: ^[\d*]+$ type: string ProvisioningPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/ProvisioningPage_allOf' DevicePage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/DevicePage_allOf' ServiceSettingProtocol: description: It holds the servicetype and list of protocols example: serviceType: serviceType supportedProtocol: - defaultPort: 0 name: name - defaultPort: 0 name: name properties: serviceType: type: string supportedProtocol: items: $ref: '#/components/schemas/SupportedProtocol' type: array type: object SupportedProtocol: description: Defines the protocol and port for a given service type example: defaultPort: 0 name: name properties: name: type: string protocol: $ref: '#/components/schemas/ServiceProtocolEnum' defaultPort: description: Name of the Cloud type: integer type: object CertificateValidityEnum: enum: - VALID - EXPIRED type: string ServiceAssignmentStatusEnum: enum: - ASSIGNED - UNASSIGNED type: string CertificatePage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/CertificatePage_allOf' CreateIntermediateCertificateRequest: example: prefix: prefix name: CustomName 123-5 properties: name: description: Name of the entity example: CustomName 123-5 maxLength: 100 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string prefix: description: prefix for the CN pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string required: - name type: object CreateCsrRequest: example: commonName: commonName country: country organization: organization orgUnit: orgUnit name: CustomName 123-5 locality: locality state: state email: email properties: name: description: Name of the entity example: CustomName 123-5 maxLength: 100 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string commonName: description: CN for the certificate maxLength: 64 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string organization: description: organization for the certificate maxLength: 64 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string country: description: country code for the certificate maxLength: 2 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string state: description: state or province name for the certificate maxLength: 128 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string locality: description: locality for the certificate maxLength: 128 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string orgUnit: description: organizational unit name for the certificate maxLength: 64 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string email: description: email address that allows only characters usable in certificates maxLength: 40 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+@[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string required: - commonName - name type: object certificateCommonName: description: CN for the certificate maxLength: 64 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string certificateOrganization: description: organization for the certificate maxLength: 64 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string countryCode: description: country code for the certificate maxLength: 2 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string certificateState: description: state or province name for the certificate maxLength: 128 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string certificateLocality: description: locality for the certificate maxLength: 128 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string certificateOrgUnit: description: organizational unit name for the certificate maxLength: 64 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string certificateEmail: description: email address that allows only characters usable in certificates maxLength: 40 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+@[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string CsrValue: example: value: value properties: value: description: value of the csr type: string type: object AddCertificateValueRequest: example: rootCa: rootCa signedCertificate: signedCertificate properties: signedCertificate: description: Certificate in X509 PEM encoded format pattern: '-----BEGIN CERTIFICATE-----(?:[\s\S]*?)-----END CERTIFICATE-----\s*$' type: string rootCa: description: Certificate in X509 PEM encoded format pattern: '-----BEGIN CERTIFICATE-----(?:[\s\S]*?)-----END CERTIFICATE-----\s*$' type: string required: - rootCa - signedCertificate type: object CigCustomerInfoPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/CigCustomerInfoPage_allOf' CustomerOverview: properties: id: description: uid format: int64 type: integer companyName: description: Company name, fully formatted maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9 (),\-\.\/@]+$ type: string address: description: address of the customer maxLength: 255 minLength: 1 pattern: ^[A-Za-zẞÀ-ž0-9 (),\-\.\/@]+$ type: string resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' companyAddress: description: address of the customer maxLength: 255 minLength: 1 pattern: ^[A-Za-zẞÀ-ž0-9 (),\-\.\/@]+$ type: string CigCustomerCreateRequest: description: For storing customer info example: license: endDate: 2000-01-23 startDate: 2000-01-23 address: address createdBy: createdBy companyName: companyName properties: companyName: description: Company name, fully formatted maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9 (),\-\.\/@]+$ type: string address: description: address of the customer maxLength: 255 minLength: 1 pattern: ^[A-Za-zẞÀ-ž0-9 (),\-\.\/@]+$ type: string createdBy: description: Identifier or description who created/modified the resource. maxLength: 255 minLength: 1 type: string license: $ref: '#/components/schemas/LicenseRequest' required: - address - companyName - createdBy - license LicenseRequest: example: endDate: 2000-01-23 startDate: 2000-01-23 properties: startDate: format: date type: string endDate: format: date type: string licenseType: $ref: '#/components/schemas/LicenseType' required: - licenseType - startDate LicenseType: enum: - EVALUATION - COMMERCIAL type: string CigCustomerInfo: example: alertEmail: alertEmail api-keys: - resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 name: name id: 5 value: value - resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 name: name id: 5 value: value address: address companyName: companyName customerFeatures: - feature: name: name description: description id: 6 endDate: 2000-01-23 startDate: 2000-01-23 - feature: name: name description: description id: 6 endDate: 2000-01-23 startDate: 2000-01-23 bootstrapDomain: bootstrapDomain resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 customerQuotas: - resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 limit: 1 description: description id: 1 - resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 limit: 1 description: description id: 1 agreementAcceptedAt: 2000-01-23 04:56:07+00:00 agreementAcceptedBy: agreementAcceptedBy subdomain: subdomain id: 0 agreementAccepted: true properties: id: description: uid format: int64 type: integer companyName: description: Company name, fully formatted maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9 (),\-\.\/@]+$ type: string address: description: address of the customer maxLength: 255 minLength: 1 pattern: ^[A-Za-zẞÀ-ž0-9 (),\-\.\/@]+$ type: string agreementType: $ref: '#/components/schemas/AgreementType' customerFeatures: items: $ref: '#/components/schemas/CustomerFeature' type: array customerQuotas: items: $ref: '#/components/schemas/CustomerQuota' type: array api-keys: items: $ref: '#/components/schemas/EL2G-API-Key-Info' type: array agreementAccepted: type: boolean agreementAcceptedBy: type: string agreementAcceptedAt: format: date-time type: string alertEmail: description: email address maxLength: 64 pattern: ^[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ type: string subdomain: description: company sepcific domain maxLength: 253 minLength: 8 pattern: ^[a-z0-9\.-]+$ type: string bootstrapDomain: description: company sepcific domain maxLength: 253 minLength: 8 pattern: ^[a-z0-9\.-]+$ type: string resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' required: - address - agreementType - companyName - createdBy - email AgreementType: enum: - CLICK_THROUGH - CUSTOM_AGREEMENT type: string CustomerFeature: example: feature: name: name description: description id: 6 endDate: 2000-01-23 startDate: 2000-01-23 properties: feature: $ref: '#/components/schemas/Feature' licenseType: $ref: '#/components/schemas/LicenseType' startDate: format: date type: string endDate: format: date type: string type: object Feature: example: name: name description: description id: 6 properties: id: description: uid format: int64 type: integer name: type: string description: type: string type: object CustomerQuota: example: resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 limit: 1 description: description id: 1 properties: id: description: uid format: int64 type: integer key: $ref: '#/components/schemas/quotaKey' description: type: string limit: minimum: 1 type: integer resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' required: - limit quotaKey: enum: - USERS - DEVICE_GROUPS - SERVICES - SECURE_OBJECTS - CLAIM_CODES - DEVICE_CONNECTIONS - DEVICE_BOOTSTRAP_CONNECTIONS - CUSTOMERS type: string EL2G-API-Key-Info: description: EdgeLock api key details example: resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 name: name id: 5 value: value properties: id: description: uid format: int64 type: integer name: description: short description of api key type: string value: description: plain value of API key type: string resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' type: object email: description: email address maxLength: 64 pattern: ^[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ type: string serverNameIndication: description: company sepcific domain maxLength: 253 minLength: 8 pattern: ^[a-z0-9\.-]+$ type: string CigCustomerUpdateRequest: description: For updating customer info example: license: endDate: 2000-01-23 startDate: 2000-01-23 address: address companyName: companyName modifiedBy: modifiedBy properties: companyName: description: Company name, fully formatted maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9 (),\-\.\/@]+$ type: string address: description: address of the customer maxLength: 255 minLength: 1 pattern: ^[A-Za-zẞÀ-ž0-9 (),\-\.\/@]+$ type: string modifiedBy: description: Identifier or description who created/modified the resource. maxLength: 255 minLength: 1 type: string license: $ref: '#/components/schemas/LicenseRequest' required: - address - companyName - license - modifiedBy RegenerateApiKeyRequest: example: modifiedBy: modifiedBy properties: modifiedBy: description: Identifier or description who created/modified the resource. maxLength: 255 minLength: 1 type: string required: - modifiedBy type: object AuditEventTypeEnum: enum: - NEW_SERVICE - REVOKE_SERVICE - DELETE_SERVICE - NEW_COS_INTERMEDIATE_CA_NXP - NEW_COS_INTERMEDIATE_CA_CSR - COS_INTERMEDIATE_CA_CSR_SIGNED - DELETE_COS_INTERMEDIATE_CA - NEW_DEVICE - DEVICE_CLAIMED - DEVICE_UNCLAIMED - PROVISION_SERVICE - REVOKE_SERVICE_DEVICE - PROVISION_KEYPAIR - PROVISION_CERTIFICATE - PROVISION_STATIC_KEY - PROVISION_STATIC_PUBLIC_KEY - PROVISION_HMAC_KEY - PROVISION_BINARY_FILE - PROVISIONING_DOWNLOAD - GENERATE_KEYPAIR - GENERATE_CERTIFICATE - GENERATE_STATIC_KEY - GENERATE_STATIC_PUBLIC_KEY - GENERATE_HMAC_KEY - GENERATE_BINARY_FILE - DELETE_KEYPAIR - DELETE_CERTIFICATE - DELETE_STATIC_KEY - DELETE_STATIC_PUBLIC_KEY - DELETE_HMAC_KEY - DELETE_BINARY_FILE - RTP_INTERMEDIATE_CA_NXP_CREATED - RTP_INTERMEDIATE_CA_CSR_CREATED - RTP_INTERMEDIATE_CA_CRL_CREATED - RTP_INTERMEDIATE_CA_CSR_SIGNED - RTP_INTERMEDIATE_CA_DELETED - SECURE_OBJECT_CREATED - SECURE_OBJECT_DELETED - AUS_APPLET_DOWNLOADED type: string AuditObjectPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/AuditObjectPage_allOf' AggregatedAuditRequest: description: Audit report request example: startMonthYear: month: 1 year: 6424 endMonthYear: month: 1 year: 6424 properties: startMonthYear: $ref: '#/components/schemas/MonthYear' endMonthYear: $ref: '#/components/schemas/MonthYear' required: - endMonthYear - startMonthYear type: object MonthYear: description: Audit report request example: month: 1 year: 6424 properties: month: description: Month maximum: 12 minimum: 1 type: integer year: description: Year maximum: 9999 minimum: 1000 type: integer required: - month - year type: object RtpDeviceProvisioningPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/RtpDeviceProvisioningPage_allOf' RtpDeviceProvisioning: properties: provisioningId: description: uid format: int64 type: integer secureObject: $ref: '#/components/schemas/RtpDeviceSecureObject' state: $ref: '#/components/schemas/SecureObjectProvisioningState' apdus: $ref: '#/components/schemas/ProvisioningApdus' type: object RtpDeviceSecureObject: discriminator: mapping: MASTER_KEY: '#/components/schemas/RtpDeviceAesKey' HMAC_KEY: '#/components/schemas/RtpDeviceHmacKey' STATIC_PUBLIC_KEY: '#/components/schemas/RtpDeviceStaticPublicKey' KEYPAIR: '#/components/schemas/RtpDeviceKeyPair' CERTIFICATE: '#/components/schemas/RtpDeviceX509Certificate' BINARY_FILE: '#/components/schemas/RtpDeviceBinaryFile' propertyName: secureObjectType properties: secureObjectType: $ref: '#/components/schemas/SecureObjectTypeEnum' id: description: uid format: int64 type: integer name: description: Name of the entity example: CustomName 123-5 maxLength: 30 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string objectId: pattern: ^[a-fA-F0-9]{1,8}$ type: string required: - name - objectId - secureObjectType type: object SecureObjectTypeEnum: enum: - MASTER_KEY - HMAC_KEY - STATIC_PUBLIC_KEY - KEYPAIR - CERTIFICATE - BINARY_FILE type: string SecureObjectProvisioningState: enum: - GENERATION_TRIGGERED - GENERATION_COMPLETED - GENERATION_FAILED - PROVISIONING_COMPLETED - PROVISIONING_FAILED - GENERATION_ON_CONNECTION type: string ProvisioningApdus: properties: createApdu: $ref: '#/components/schemas/Apdu' writeApdus: items: $ref: '#/components/schemas/Apdu' type: array type: object Apdu: properties: apdu: format: byte type: string type: object SecureObjectPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/SecureObjectPage_allOf' SecureObject: discriminator: mapping: MASTER_KEY: '#/components/schemas/AesKey' HMAC_KEY: '#/components/schemas/HmacKey' STATIC_PUBLIC_KEY: '#/components/schemas/StaticPublicKey' KEYPAIR: '#/components/schemas/KeyPair' CERTIFICATE: '#/components/schemas/X509Certificate' BINARY_FILE: '#/components/schemas/BinaryFile' propertyName: secureObjectType example: resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 generateOnDeviceConnection: true name: CustomName 123-5 downloadedCount: 5 id: 0 objectId: objectId deviceGroupCount: 6 provisioningCount: 1 properties: secureObjectType: $ref: '#/components/schemas/SecureObjectTypeEnum' id: description: uid format: int64 type: integer name: description: Name of the entity example: CustomName 123-5 maxLength: 30 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string objectId: pattern: ^[a-fA-F0-9]{1,8}$ type: string policySourceType: $ref: '#/components/schemas/PolicySourceType' generateOnDeviceConnection: type: boolean deviceGroupCount: description: Number of device groups assigned to the secure object. format: int64 type: integer provisioningCount: description: Number of provisionings to the secure object. format: int64 type: integer downloadedCount: description: Number of downloaded APDUs to the secure object. format: int64 type: integer resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' required: - name - objectId - secureObjectType type: object PolicySourceType: enum: - DEFAULT - CUSTOM type: string SecureObjectCreateRequest: discriminator: mapping: MASTER_KEY: '#/components/schemas/AesKeyCreateRequest' HMAC_KEY: '#/components/schemas/HmacKeyCreateRequest' STATIC_PUBLIC_KEY: '#/components/schemas/StaticPublicKeyCreateRequest' KEYPAIR: '#/components/schemas/KeyPairCreateRequest' CERTIFICATE: '#/components/schemas/X509CertificateCreateRequest' BINARY_FILE: '#/components/schemas/BinaryFileCreateRequest' propertyName: secureObjectType example: generateOnDeviceConnection: false name: CustomName 123-5 policies: key: accessRuleConfiguration: - accessRules: - null - null objectId: objectId - accessRules: - null - null objectId: objectId objectId: objectId properties: name: description: Name of the entity example: CustomName 123-5 maxLength: 30 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string secureObjectType: $ref: '#/components/schemas/SecureObjectTypeEnum' objectId: pattern: ^[a-fA-F0-9]{1,8}$ type: string policySourceType: $ref: '#/components/schemas/PolicySourceType' policies: additionalProperties: $ref: '#/components/schemas/SecureObjectPolicyConfiguration' description: Map of type: object generateOnDeviceConnection: default: false type: boolean required: - name - objectId - policySourceType - secureObjectType type: object SecureObjectPolicyConfiguration: example: accessRuleConfiguration: - accessRules: - null - null objectId: objectId - accessRules: - null - null objectId: objectId properties: policyType: $ref: '#/components/schemas/PolicyProfileType' policySourceType: $ref: '#/components/schemas/PolicySourceType' accessRuleConfiguration: items: $ref: '#/components/schemas/AccessRuleConfiguration' type: array required: - accessRuleConfiguration - policySourceType - policyType type: object AccessRuleConfiguration: example: accessRules: - null - null objectId: objectId properties: objectId: pattern: ^[a-fA-F0-9]{1,8}$ type: string type: $ref: '#/components/schemas/UserPolicyUsageType' accessRules: items: $ref: '#/components/schemas/AccessRule' type: array required: - accessRules - objectId - type type: object UserPolicyUsageType: enum: - CUSTOM - UNAUTHENTICATED - MANDATORY type: string AccessRule: enum: - POLICY_OBJ_ALLOW_DELETE - POLICY_OBJ_REQUIRE_SM - POLICY_OBJ_FORBID_ALL - POLICY_OBJ_ALLOW_SIGN - POLICY_OBJ_ALLOW_VERIFY - POLICY_OBJ_ALLOW_ENC - POLICY_OBJ_ALLOW_DEC - POLICY_OBJ_ALLOW_WRITE - POLICY_OBJ_ALLOW_GEN - POLICY_OBJ_ALLOW_KA - POLICY_OBJ_ALLOW_READ - POLICY_OBJ_ALLOW_DESFIRE_AUTHENTICATION - POLICY_OBJ_ALLOW_DESFIRE_DUMP_SESSION_KEYS - POLICY_OBJ_ALLOW_ATTESTATION - POLICY_OBJ_ALLOW_KDF - POLICY_OBJ_ALLOW_WRAP - POLICY_OBJ_ALLOW_DERIVED_INPUT - POLICY_OBJ_FORBID_DERIVED_OUTPUT - POLICY_OBJ_ALLOW_TLS_KDF - POLICY_OBJ_ALLOW_TLS_KDF_EXT_RANDOM - POLICY_OBJ_ALLOW_TLS_PMS - POLICY_OBJ_ALLOW_HKDF - POLICY_OBJ_ALLOW_PBKDF - POLICY_OBJ_ALLOW_RFC3394_UNWRAP - POLICY_OBJ_ALLOW_DESFIRE_CHANGEKEY - POLICY_OBJ_ALLOW_DESFIRE_KDF - POLICY_OBJ_FORBID_EXTERNAL_IV - POLICY_OBJ_ALLOW_USAGE_AS_HMAC_PEPPER type: string SecureObjectChangeRequest: example: name: CustomName 123-5 policies: key: accessRuleConfiguration: - accessRules: - null - null objectId: objectId - accessRules: - null - null objectId: objectId properties: name: description: Name of the entity example: CustomName 123-5 maxLength: 30 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string policies: additionalProperties: $ref: '#/components/schemas/SecureObjectPolicyConfiguration' description: Policies to be added to the secure object, Map of type: object type: object DeviceGroupIdBody: example: deviceGroupId: 0 properties: deviceGroupId: description: id of a group that device belongs to format: int64 type: integer required: - deviceGroupId type: object SecureObjectInDeviceGroupPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/SecureObjectInDeviceGroupPage_allOf' SecureObjectInDeviceGroup: properties: secureObjectType: $ref: '#/components/schemas/SecureObjectTypeEnum' secureObjectId: description: uid format: int64 type: integer secureObjectName: description: Name of the entity example: CustomName 123-5 maxLength: 30 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string objectId: pattern: ^[a-fA-F0-9]{1,8}$ type: string deviceGroupId: description: uid format: int64 type: integer unassignable: type: boolean secureObjectCreatedTs: format: date-time type: string resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' required: - objectId - secureObjectId - secureObjectName - secureObjectType type: object DeviceGroupBasicDetails: description: basic details of device group object example: deviceGroupName: Device Group-1 id: 0 properties: id: description: uid format: int64 type: integer deviceGroupName: description: customer unique device group name example: Device Group-1 maxLength: 100 minLength: 2 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string type: object DeviceGroupInSecureObjectPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/DeviceGroupInSecureObjectPage_allOf' DeviceGroupInSecureObject: properties: deviceGroupId: description: uid format: int64 type: integer deviceGroupName: description: Name of the entity example: CustomName 123-5 maxLength: 30 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string unassignable: type: boolean type: object SecureObjectValidations: example: suggestedObjectIdRanges: - minValue: minValue maxValue: maxValue - minValue: minValue maxValue: maxValue forbiddenObjectIdRanges: - minValue: minValue maxValue: maxValue - minValue: minValue maxValue: maxValue properties: suggestedObjectIdRanges: items: $ref: '#/components/schemas/SecureObjectIdRange' type: array forbiddenObjectIdRanges: items: $ref: '#/components/schemas/SecureObjectIdRange' type: array type: object SecureObjectIdRange: example: minValue: minValue maxValue: maxValue properties: minValue: type: string maxValue: type: string type: object PolicyAlgorithmEnum: description: Types of policy algorithms enum: - NIST_P192 - NIST_P224 - NIST_P256 - NIST_P384 - NIST_P521 - SECP160K1 - SECP192K1 - SECP224K1 - SECP256K1 - BRAINPOOLP160R1 - BRAINPOOLP192R1 - BRAINPOOLP224R1 - BRAINPOOLP256R1 - BRAINPOOLP320R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - ECC_ED_25519 - ECC_MONT_DH_448 - ECC_MONT_DH_25519 - RSA_1024 - RSA_2048 - RSA_3072 - RSA_4096 - RSA_1024_CRT - RSA_2048_CRT - RSA_3072_CRT - RSA_4096_CRT - AES128 - AES256 - BINARY_FILE_CONFIDENTIAL - BINARY_FILE_NON_CONFIDENTIAL type: string PolicyProfileType: enum: - ACCESS_RULE - PSA_KEY_USAGE type: string SecureObjectPolicyTemplateResponse: example: psaUsageKeyOidConfiguration: objectIdRanges: key: - minValue: minValue maxValue: maxValue - minValue: minValue maxValue: maxValue secureObjectPolicyTemplate: secureObject: {} allowedAccessRuleOptions: - null - null accessRuleConfigurationTemplate: - accessRules: - null - null objectId: objectId - accessRules: - null - null objectId: objectId enabled: true accessRuleOidConfiguration: objectIdRanges: key: - minValue: minValue maxValue: maxValue - minValue: minValue maxValue: maxValue unauthenticatedUserOid: unauthenticatedUserOid mandatoryUserOid: mandatoryUserOid properties: secureObjectPolicyTemplate: $ref: '#/components/schemas/SecureObjectPolicyTemplate' psaUsageKeyOidConfiguration: $ref: '#/components/schemas/PSAUsageKeyOidConfiguration' accessRuleOidConfiguration: $ref: '#/components/schemas/AccessRuleOidConfiguration' type: object SecureObjectPolicyTemplate: example: secureObject: {} allowedAccessRuleOptions: - null - null accessRuleConfigurationTemplate: - accessRules: - null - null objectId: objectId - accessRules: - null - null objectId: objectId enabled: true properties: secureObject: $ref: '#/components/schemas/AbstractSecureObjectProfile' enabled: type: boolean policyType: $ref: '#/components/schemas/PolicyProfileType' accessRuleConfigurationTemplate: items: $ref: '#/components/schemas/AccessRuleConfigurationTemplate' type: array allowedAccessRuleOptions: items: $ref: '#/components/schemas/AccessRulePolicyType' type: array type: object AbstractSecureObjectProfile: discriminator: mapping: MASTER_KEY: '#/components/schemas/MasterKeyProfile' HMAC_KEY: '#/components/schemas/HmacKeyProfile' STATIC_PUBLIC_KEY: '#/components/schemas/StaticPublicKeyProfile' KEYPAIR: '#/components/schemas/KeyPairProfile' CERTIFICATE: '#/components/schemas/CertificateProfile' BINARY_FILE: '#/components/schemas/BinaryFileProfile' propertyName: type example: {} properties: type: $ref: '#/components/schemas/SecureObjectTypeEnum' type: object AccessRuleConfigurationTemplate: example: accessRules: - null - null objectId: objectId properties: objectId: pattern: ^[a-fA-F0-9]{1,8}$ type: string type: $ref: '#/components/schemas/UserPolicyUsageType' accessRules: items: $ref: '#/components/schemas/AccessRulePolicyType' type: array type: object AccessRulePolicyType: enum: - POLICY_OBJ_ALLOW_DELETE - POLICY_OBJ_REQUIRE_SM - POLICY_OBJ_FORBID_ALL - POLICY_OBJ_ALLOW_SIGN - POLICY_OBJ_ALLOW_VERIFY - POLICY_OBJ_ALLOW_ENC - POLICY_OBJ_ALLOW_DEC - POLICY_OBJ_ALLOW_WRITE - POLICY_OBJ_ALLOW_GEN - POLICY_OBJ_ALLOW_KA - POLICY_OBJ_ALLOW_READ - POLICY_OBJ_ALLOW_DESFIRE_AUTHENTICATION - POLICY_OBJ_ALLOW_DESFIRE_DUMP_SESSION_KEYS - POLICY_OBJ_ALLOW_ATTESTATION - POLICY_OBJ_ALLOW_KDF - POLICY_OBJ_ALLOW_WRAP - POLICY_OBJ_ALLOW_DERIVED_INPUT - POLICY_OBJ_FORBID_DERIVED_OUTPUT - POLICY_OBJ_ALLOW_TLS_KDF - POLICY_OBJ_ALLOW_TLS_KDF_EXT_RANDOM - POLICY_OBJ_ALLOW_TLS_PMS - POLICY_OBJ_ALLOW_HKDF - POLICY_OBJ_ALLOW_PBKDF - POLICY_OBJ_ALLOW_RFC3394_UNWRAP - POLICY_OBJ_ALLOW_DESFIRE_CHANGEKEY - POLICY_OBJ_ALLOW_DESFIRE_KDF - POLICY_OBJ_FORBID_EXTERNAL_IV - POLICY_OBJ_ALLOW_USAGE_AS_HMAC_PEPPER type: string PSAUsageKeyOidConfiguration: example: objectIdRanges: key: - minValue: minValue maxValue: maxValue - minValue: minValue maxValue: maxValue properties: objectIdRanges: additionalProperties: items: $ref: '#/components/schemas/ObjectIdRange' type: array description: Map of > type: object required: - objectIdRanges type: object ObjectIdRange: example: minValue: minValue maxValue: maxValue properties: minValue: pattern: ^[a-fA-F0-9]{1,8}$ type: string maxValue: pattern: ^[a-fA-F0-9]{1,8}$ type: string required: - maxValue - minValue type: object AccessRuleOidConfiguration: example: objectIdRanges: key: - minValue: minValue maxValue: maxValue - minValue: minValue maxValue: maxValue unauthenticatedUserOid: unauthenticatedUserOid mandatoryUserOid: mandatoryUserOid properties: mandatoryUserOid: pattern: ^[a-fA-F0-9]{1,8}$ type: string unauthenticatedUserOid: pattern: ^[a-fA-F0-9]{1,8}$ type: string objectIdRanges: additionalProperties: items: $ref: '#/components/schemas/ObjectIdRange' type: array description: Map of > type: object required: - mandatoryUserOid - objectIdRanges - unauthenticatedUserOid type: object SecureObjectPolicyPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/SecureObjectPolicyPage_allOf' SecureObject12NCPolicyConfiguration: properties: commercialName: description: Commercial product name readOnly: true type: string nc12: description: 12nc of the product readOnly: true type: string assignedDeviceGroups: items: $ref: '#/components/schemas/DeviceGroupBasicDetails' type: array secureObjectPolicyConfiguration: $ref: '#/components/schemas/SecureObjectPolicyConfiguration' type: object SecureObjectProvisioningPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/SecureObjectProvisioningPage_allOf' SecureObjectProvisioning: description: Secure Object provisioning details discriminator: mapping: MASTER_KEY: '#/components/schemas/SecureObjectProvisioning' HMAC_KEY: '#/components/schemas/SecureObjectProvisioning' STATIC_PUBLIC_KEY: '#/components/schemas/SecureObjectProvisioning' KEYPAIR: '#/components/schemas/SecureObjectProvisioning' CERTIFICATE: '#/components/schemas/SecureObjectCertificateProvisioning' BINARY_FILE: '#/components/schemas/SecureObjectProvisioning' propertyName: secureObjectType properties: provisioningId: description: uid format: int64 type: integer secureObjectId: description: uid format: int64 type: integer secureObjectName: description: Name of the entity example: CustomName 123-5 maxLength: 30 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string secureObjectType: $ref: '#/components/schemas/SecureObjectTypeEnum' deviceId: description: paddedDevice UID as Java BigInteger String pattern: ^[\d]+$ type: string deviceGroupId: description: uid format: int64 type: integer deviceGroupName: description: customer unique device group name example: Device Group-1 maxLength: 100 minLength: 2 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string provisioningState: $ref: '#/components/schemas/SecureObjectProvisioningState' resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' type: object UploadSignedIntermediateCaRequest: example: rootCa: rootCa signedCertificate: signedCertificate properties: signedCertificate: description: Certificate in X509 PEM encoded format pattern: '-----BEGIN CERTIFICATE-----(?:[\s\S]*?)-----END CERTIFICATE-----\s*$' type: string rootCa: description: Certificate in X509 PEM encoded format pattern: '-----BEGIN CERTIFICATE-----(?:[\s\S]*?)-----END CERTIFICATE-----\s*$' type: string required: - rootCa - signedCertificate type: object IntermediateCaAlgorithmEnum: description: Types of asymetric algorithms for intermediate CA enum: - NIST_P256 - NIST_P384 - NIST_P521 - RSA_2048 - RSA_4096 type: string RtpIntermediateCertificatePage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/RtpIntermediateCertificatePage_allOf' RtpIntermediateCertificate: example: commonName: commonName country: country orgUnit: orgUnit locality: locality resourceMetadata: createdBy: createdBy lastModifiedBy: lastModifiedBy createdTs: 2000-01-23 04:56:07+00:00 version: 6 lastModifiedTs: 2000-01-23 04:56:07+00:00 hasAuthorityKeyIdentifier: false hasSubjectKeyIdentifier: false organization: organization name: name validUntil: 2000-01-23 04:56:07+00:00 id: 0 state: state value: value properties: id: description: uid format: int64 type: integer algorithm: $ref: '#/components/schemas/IntermediateCaAlgorithmEnum' name: description: name of the certificate, not used in the certificate it self type: string value: description: value of the certificate encoded in PEM format type: string commonName: description: common name for the certificate type: string organization: description: organization for the certificate type: string orgUnit: description: organizational unit for the certificate type: string country: description: country for the certificate type: string locality: description: locality for the certificate type: string state: description: state for the certificate type: string signingState: $ref: '#/components/schemas/CertificateSigningStateEnum' signingAuthority: $ref: '#/components/schemas/CertificateSigningAuthorityEnum' validUntil: format: date-time type: string hasAuthorityKeyIdentifier: default: false type: boolean hasSubjectKeyIdentifier: default: false type: boolean resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' type: object CreateRtpIntermediateBase: discriminator: mapping: WITH_CSR: '#/components/schemas/CreateRtpIntermediateCAWithCSRRequest' WITHOUT_CSR: '#/components/schemas/CreateRtpIntermediateCARequest' propertyName: requestType example: name: CustomName 123-5 properties: algorithm: $ref: '#/components/schemas/IntermediateCaAlgorithmEnum' name: description: Name of the entity example: CustomName 123-5 maxLength: 100 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string requestType: $ref: '#/components/schemas/CARequestType' required: - algorithm - name - requestType type: object CARequestType: enum: - WITH_CSR - WITHOUT_CSR type: string VerificationCertificateRequest: example: verificationCode: verificationCode properties: verificationCode: description: Verification code maxLength: 64 minLength: 3 pattern: ^[a-zA-Z0-9 '()+,\-.\/:=?]+$ type: string required: - verificationCode type: object IntermediateCaCertificatesPage: allOf: - $ref: '#/components/schemas/PageResponse' - $ref: '#/components/schemas/IntermediateCaCertificatesPage_allOf' IntermediateCaCertificate: properties: secureObjectType: $ref: '#/components/schemas/SecureObjectTypeEnum' name: description: Name of the entity example: CustomName 123-5 maxLength: 30 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9 _\-]+[a-zA-Z0-9]$ type: string assignmentDateTime: description: assignment date time format: date-time type: string type: object KeyPairAlgorithmEnum: description: Types of keypair algorithms enum: - NIST_P192 - NIST_P224 - NIST_P256 - NIST_P384 - NIST_P521 - SECP160K1 - SECP192K1 - SECP224K1 - SECP256K1 - BRAINPOOLP160R1 - BRAINPOOLP192R1 - BRAINPOOLP224R1 - BRAINPOOLP256R1 - BRAINPOOLP320R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - ECC_ED_25519 - ECC_MONT_DH_448 - ECC_MONT_DH_25519 - RSA_1024 - RSA_2048 - RSA_3072 - RSA_4096 - RSA_1024_CRT - RSA_2048_CRT - RSA_3072_CRT - RSA_4096_CRT type: string CertificateSupportedAlgorithmResponse: description: Contains list of supported algorithms example: supportedAlgorithms: - {} - {} properties: supportedAlgorithms: items: $ref: '#/components/schemas/CertificateSupportedAlgorithm' type: array required: - supportedAlgorithms CertificateSupportedAlgorithm: example: {} properties: status: $ref: '#/components/schemas/CertificateSupportedAlgorithmStatus' keyPairAlgorithm: $ref: '#/components/schemas/KeyPairAlgorithmEnum' intermediateCaAlgorithm: $ref: '#/components/schemas/IntermediateCaAlgorithmEnum' required: - intermediateCaAlgorithm - keyPairAlgorithm - status type: object CertificateSupportedAlgorithmStatus: description: Supported Algorithm Status enum: - NONE - WARNING - NOT_ALLOWED type: string ProductWithBatches_allOf: properties: profiles: items: $ref: '#/components/schemas/Profile' type: array customers: items: $ref: '#/components/schemas/companyName' type: array batches: items: $ref: '#/components/schemas/batchIdType' type: array DeviceGroupPage_allOf: properties: content: items: $ref: '#/components/schemas/DeviceGroupDetails' type: array DeviceGroupDetails_allOf: properties: deviceCount: minimum: 1 type: integer productRelationship: $ref: '#/components/schemas/CustomerProductTypeRelationship' productDetails: $ref: '#/components/schemas/ProductBase' resourceMetadata: $ref: '#/components/schemas/ResourceMetadata' claimCodeOverviews: $ref: '#/components/schemas/ClaimCodeStatistics' DeviceServiceProvisioningPage_allOf: properties: content: items: $ref: '#/components/schemas/DeviceServiceProvisioning' type: array ProductDetail_allOf: properties: iotHubAccount: description: Account to be informed in case of devices get produced. Copy from OEFInfo.iotHubAccount type: string required: - iotHubAccount ClaimCodePage_allOf: properties: content: items: $ref: '#/components/schemas/ClaimCode' type: array ClaimCode_allOf: properties: id: description: uid format: int64 type: integer secret: pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$ type: string deviceCount: default: 0 format: int64 minimum: 0 type: integer status: $ref: '#/components/schemas/claimStatus' metadata: $ref: '#/components/schemas/ResourceMetadata' DeliveryUnitPage_allOf: properties: content: items: $ref: '#/components/schemas/DeliveryUnit' type: array ServicePage_allOf: properties: content: items: $ref: '#/components/schemas/Service' type: array ProvisioningPage_allOf: properties: content: items: $ref: '#/components/schemas/Provisioning' type: array DevicePage_allOf: properties: content: items: $ref: '#/components/schemas/Device' type: array CertificatePage_allOf: properties: content: items: $ref: '#/components/schemas/IntermediateCertificate' type: array CigCustomerInfoPage_allOf: properties: content: items: $ref: '#/components/schemas/CustomerOverview' type: array AuditObjectPage_allOf: properties: content: items: type: object type: array RtpDeviceProvisioningPage_allOf: properties: content: items: $ref: '#/components/schemas/RtpDeviceProvisioning' type: array SecureObjectPage_allOf: properties: content: items: $ref: '#/components/schemas/SecureObject' type: array SecureObjectInDeviceGroupPage_allOf: properties: content: items: $ref: '#/components/schemas/SecureObjectInDeviceGroup' type: array DeviceGroupInSecureObjectPage_allOf: properties: content: items: $ref: '#/components/schemas/DeviceGroupInSecureObject' type: array SecureObjectPolicyPage_allOf: properties: content: items: $ref: '#/components/schemas/SecureObject12NCPolicyConfiguration' type: array SecureObjectProvisioningPage_allOf: properties: content: items: $ref: '#/components/schemas/SecureObjectProvisioning' type: array RtpIntermediateCertificatePage_allOf: properties: content: items: $ref: '#/components/schemas/RtpIntermediateCertificate' type: array IntermediateCaCertificatesPage_allOf: properties: content: items: $ref: '#/components/schemas/IntermediateCaCertificate' type: array