Configuration These operations allow the read and update of the device configuration. This section includes Secure Enclave provisioning (on Encedo PPA only and during manufacture only).
Manage device configuration
Allowed users
User Master ExtAuth
Allowed only to call Get configuration .
Required access scope
Main Alternative
auth:ext:pair
Operation sucessful
Get configuration
GET
https://my.ence.do/api/system/config
Read the device configuration data.
200: OK Operation sucessful 401: Unauthorized Missing or invalid JWT_TOKEN 403: Forbidden Incorrect access scope 400: Bad Request Incorrect argument(s) 406: Not Acceptable Operation failed 409: Conflict Incorrect internal state
Copy {
"iat" : 1647381403 ,
"uts" : 1647381403 ,
"devid" : "2023b758c209269a" ,
"instanceid" : "f4980240-da72-13e3-f45c-2ffbde2a1800" ,
"eid" : "ff6/rpgprw6OjcPbedIB5LbsxjZqmnf43J1zeK1x82I=" ,
"eid_sign" : "T61jY1AgV5XUW++eAcQibRDFOl5KjKwLGdo+U0def8A=" ,
"user" : "John Doe" ,
"email" : "john@example.com" ,
"hostname" : "example.ence.do" ,
"dnsd" : true ,
"trusted_ts" : true ,
"trusted_backend" : true ,
"allow_keysearch" : true ,
"origin" : "*" ,
"ctx" : 0 ,
"http_option_hsts" : true ,
"http_option_dosprot_mode" : 1 ,
"ip" : "192.168.11.1/24" ,
"genuine_id" : "0123eb561f5ea073ee" ,
"storage_mode" : 81 ,
"storage_disk0size" : 8388607 ,
"storage_capacity" : 120979451 ,
"spk" : "fi2bgSQwaGhLkRi016q9saqeTWvrLyU08nM8hJUpTBg=" ,
"nonce" : "fOw1YvMYWIqbTfrxgQFzEuvcJozIRqEVKluO9KDza0w="
}
Response data for successful operation
Update configuration
POST
https://my.ence.do/api/system/config
Change some configuration data e.g. options, password or update TLS certificate.
Request Body
400: Bad Request Incorrect argument(s) 401: Unauthorized Missing or invalid JWT_TOKEN 403: Forbidden Incorrect access scope 406: Not Acceptable Operation failed 409: Conflict Incorrect internal state 200: OK Operation sucessful
Copy {
"csr": "MIICATCCAaagAwIBAgIBbTAKBggqhkjOPQQDAjBCMQswCQYDVQQGEwJVSzEXMBUGA1UECgwORW5jZWRvIExpbWl0ZWQxGjAYBgNVBAMMEUVuY2VkbyBDdXN0b2R5IENBMB4XDTIwMTAwNTE5MjkzM1oXDTIzMTAwNTE5MjkzM1owQDELMAkGA1UEBhMCVUsxEzARBgNVBAoMCkVuY2VkbyBMdGQxHDAaBgNVBAMMEyMwMTIzZWI1NjFmNWVhMDczZWUwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAASdUuVLRdTcTd1DSu/6qTdh562q5WsXGEcHBP/gpUvHcU/501HwR2NybMmFQQ7/HgLgCYgaTPE+kvq6Lb0AuRf/o4GOMIGLMA4GA1UdDwEB/wQEAwIHgDAJBgNVHRMEAjAAMB0GA1UdDgQWBBSqAknAzbCHMuji+7pJhSslHyuApTAfBgNVHSMEGDAWgBR5VVeOla0ntTsGycLKHAI2qA58BjAuBgNVHREEJzAloCMGCSsGAQQBg7cnAaAWBBRGRaJpZ1sXy+HKN/vFyusw810N+DAKBggqhkjOPQQDAgNJADBGAiEA7un6HD6upjiPmhCLYMCk3fxNZyx6cZMNWzQV7LozMTMCIQDptL4bvTeMymy5WiGKrFPkDv7f+Nz9x5vop9vZry0N1Q==",
"genuine": "qgJJwM2whzLo4vu6SYUrJR8rgKU=.MTY0NzY0MTI4NQ==.MEYCIQCYDC9IDlnGlkBI7/1YPMSIC/31nfiFUISpWEb3Pw5vAgIhAPIcyOufL4MQPwl/dUpM4W8gi+IECx9i9m1LcSHo8Bqo",
"updated" : true ,
"reboot_required" : true
}
Response data for successful operation
Log entries
Get device attestation data
This endpoint is available only on Encedo PPA.
This endpoint is ignoring access scope
, effectively any scope
value is allowed as long as the JWT_TOKEN
is valid.
The Authorization
header is not required on fresh, not personalized devices.
Device attestation
GET
https://my.ence.do/api/system/config/attestation
Get device attestation data, the proof of genuine.
200: OK Operation sucessful 401: Unauthorized Missing or invalid JWT_TOKEN 409: Conflict Incorrect internal state
Copy {
"crt": "MIICATCCAaagAwIBAgIBbTAKBggqhkjOPQQDAjBCMQswCQYDVQQGEwJVSzEXMBUGA1UECgwORW5jZWRvIExpbWl0ZWQxGjAYBgNVBAMMEUVuY2VkbyBDdXN0b2R5IENBMB4XDTIwMTAwNTE5MjkzM1oXDTIzMTAwNTE5MjkzM1owQDELMAkGA1UEBhMCVUsxEzARBgNVBAoMCkVuY2VkbyBMdGQxHDAaBgNVBAMMEyMwMTIzZWI1NjFmNWVhMDczZWUwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAASdUuVLRdTcTd1DSu/6qTdh562q5WsXGEcHBP/gpUvHcU/501HwR2NybMmFQQ7/HgLgCYgaTPE+kvq6Lb0AuRf/o4GOMIGLMA4GA1UdDwEB/wQEAwIHgDAJBgNVHRMEAjAAMB0GA1UdDgQWBBSqAknAzbCHMuji+7pJhSslHyuApTAfBgNVHSMEGDAWgBR5VVeOla0ntTsGycLKHAI2qA58BjAuBgNVHREEJzAloCMGCSsGAQQBg7cnAaAWBBRGRaJpZ1sXy+HKN/vFyusw810N+DAKBggqhkjOPQQDAgNJADBGAiEA7un6HD6upjiPmhCLYMCk3fxNZyx6cZMNWzQV7LozMTMCIQDptL4bvTeMymy5WiGKrFPkDv7f+Nz9x5vop9vZry0N1Q==",
"genuine": "qgJJwM2whzLo4vu6SYUrJR8rgKU=.MTY0NzY0MTI4NQ==.MEYCIQCYDC9IDlnGlkBI7/1YPMSIC/31nfiFUISpWEb3Pw5vAgIhAPIcyOufL4MQPwl/dUpM4W8gi+IECx9i9m1LcSHo8Bqo"
}
Response data for successful operation
Factory provisioning
This endpoint is available only on Encedo PPA.
This endpoint is used during the manufacturing process to provision the Secure Enclave chip. After successful provisioning, all following calls to this endpoint will return response code 406.
Factory provisioning
POST
https://my.ence.do/api/system/config/provisioning
On factory Secure Enclave provisioning (on Encedo PPA only).
Request Body
200: OK Operation sucsessful 403: Forbidden Device personalized 406: Not Acceptable Operation failed 400: Bad Request Incorrect or malformated argument(s)