REST API - attest

esx attestation report: attest

Request a report using remote attestation.

Request:

HTTP request

POST https://{server}/api/esx/attestation/report

?action=attest

{
    "types" : [
        "KMS_AUTH_JWT",
        "KMS_AUTH_JWT"
    ]
}

Body Parameters:

Name	Type	Description
bold = required
-	object	The report request.
-.types	string[]	The types of document being requested.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "documents" : [
        {
            "reporting_jwt" : "string",
            "kms_auth_jwt" : "string",
            "type" : "KMS_AUTH_JWT"
        },
        {
            "reporting_jwt" : "string",
            "kms_auth_jwt" : "string",
            "type" : "KMS_AUTH_JWT"
        }
    ],
    "attested" : true
}

Headers:

None

Type:

Name	Type	Description
bold = required
-.attested	boolean	Indicates if the requester has been successfully attested. When true, all requested documents are available.
-.documents	document[]	The documents that were requested. This list is only populated when esx.attestation.report.esx.attestation.report._attest-_result.attested reports true.
-.documents[].type	string	The type of attestation report document. Defines valid attestation report document types. Value is one of: KMS_AUTH_JWT: A JSON Web Token for use in KMS authentication. REPORTING_JWT: A JSON Web Token for use in reporting attestation claims. This constant was added in vSphere API 7.0.1.0.
-.documents[].kms_auth_jwt	string	A JSON Web Token for use in KMS authentication. Optional. It is only relevant when type has value KMS_AUTH_JWT. This field is optional and it is only relevant when the value of `type` is KMS_AUTH_JWT.
-.documents[].reporting_jwt	string	A JSON Web Token for use in reporting purposes only. A reporting token is never used for authentication or authorization. This attribute was added in vSphere API 7.0.1.0. Optional. It is only relevant when type has value REPORTING_JWT. This field is optional and it is only relevant when the value of `type` is REPORTING_JWT.
-	object	The report result.

Errors:

HTTP Status Code	Type	Description
500	error	If a generic error.
400	invalid_argument	If the request is invalid.
401	unauthenticated	If the caller is not authenticated.
403	unauthorized	If the caller is not authorized.