AttestationClient (stable:2018-09-01)

2025/09/26 • 9 new methods

Policy_PrepareToSet (new)
Description :  Accepts a new policy document and returns a JWT which expresses used in preparation to set attestation policy.
Reference :  Link ¶

⚼ Request

POST:  /operations/policy/updatepolicy
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
tee:
{
Description: Specifies the trusted execution environment to be used to validate the evidence ,
Required: True ,
}
string ,
PolicyJws:
{
Description: JSON Web Signature (See RFC7515) expressing the new policy ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (400)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
Policy_Get (new)
Description :  Retrieves the current policy for a given kind of TEE.
Reference :  Link ¶

⚼ Request

GET:  /operations/policy/current
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
tee:
{
Description: Specifies the trusted execution environment to be used to validate the evidence ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
policy:
{
Description: JSON Web Token whose body is an AttestationPolicyRequest definition. ,
Required: False ,
}
string ,
}

⚐ Response (400)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
Policy_Set (new)
Description :  Sets the policy for a given kind of TEE.
Reference :  Link ¶

⚼ Request

PUT:  /operations/policy/current
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
tee:
{
Description: Specifies the trusted execution environment to be used to validate the evidence ,
Required: True ,
}
string ,
newAttestationPolicy:
{
Description: JWT Expressing the new policy ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (400)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
Policy_Reset (new)
Description :  Resets the attestation policy for the specified tenant and reverts to the default policy.
Reference :  Link ¶

⚼ Request

POST:  /operations/policy/current
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
tee:
{
Description: Specifies the trusted execution environment to be used to validate the evidence ,
Required: True ,
}
string ,
PolicyJws:
{
Description: JSON Web Signature with an empty policy document ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (400)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PolicyCertificates_Get (new)
Description :  Retrieves the set of certificates used to express policy for the current tenant.
Reference :  Link ¶

⚼ Request

GET:  /operations/policy/certificates
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (400)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PolicyCertificates_Add (new)
Description :  Adds a new attestation policy certificate to the set of policy management certificates.
Reference :  Link ¶

⚼ Request

PUT:  /operations/policy/certificates
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
policyCertificateToAdd:
{
Description: An RFC7519 JSON Web Token containing a claim named "maa-policyCertificate" whose value is an RFC7517 JSON Web Key which specifies a new key to add. The RFC7519 JWT must be signed with one of the existing signing certificates ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (400)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PolicyCertificates_Remove (new)
Description :  Removes the specified policy management certificate. Note that the final policy management certificate cannot be removed.
Reference :  Link ¶

⚼ Request

POST:  /operations/policy/certificates
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
policyCertificateToRemove:
{
Description: An RFC7519 JSON Web Token containing a claim named "maa-policyCertificate" whose value is an RFC7517 JSON Web Key which specifies a new key to update. The RFC7519 JWT must be signed with one of the existing signing certificates ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (400)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$schema: string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
SigningCertificates_Get (new)
Description :  Retrieves metadata signing certificates in use by the attestation service
Reference :  Link ¶

⚼ Request

GET:  /certs
{}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (400)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
MetadataConfiguration_Get (new)
Description :  Retrieves metadata about the attestation signing keys in use by the attestation service
Reference :  Link ¶

⚼ Request

GET:  /.well-known/openid-configuration
{}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (400)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}