Microsoft.CodeTransparency (preview:2025-01-31)

2025/03/06 • 6 new methods

GetTransparencyConfigCbor (new)
Description :  Get the transparency service configuration, mandatory in IETF SCITT draft
Reference :  Link ¶

⚼ Request

GET:  /.well-known/transparency-configuration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accept:
{
Description: Accept header ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (500)

{
$schema: file ,
}

⚐ Response (503)

{
$headers:
{
retry-after:
{
Description: Retry the same request after a suggested number of seconds ,
}
integer ,
}
,
$schema: file ,
}
CreateEntry (new)
Description :  Post an entry to be registered on the CodeTransparency instance, mandatory in IETF SCITT draft
Reference :  Link ¶

⚼ Request

POST:  /entries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accept:
{
Description: Accept header ,
Required: True ,
}
string ,
body:
{
Description: CoseSign1 signature envelope ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: Location of the receipt ,
}
string ,
}
,
$schema: file ,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Location of the operation ,
}
string ,
retry-after:
{
Description: Retry-After seconds value to help with polling ,
}
integer ,
}
,
$schema: file ,
}

⚐ Response (400)

{
$schema: file ,
}

⚐ Response (404)

{
$schema: file ,
}

⚐ Response (429)

{
$headers:
{
retry-after:
{
Description: Retry-After seconds value to help with polling ,
}
integer ,
}
,
$schema: file ,
}

⚐ Response (500)

{
$schema: file ,
}

⚐ Response (503)

{
$headers:
{
retry-after:
{
Description: Retry the same request after a suggested number of seconds ,
}
integer ,
}
,
$schema: file ,
}
GetEntry (new)
Description :  Get receipt
Reference :  Link ¶

⚼ Request

GET:  /entries/{entryId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
entryId:
{
Description: ID of the entry to retrieve. ,
Required: True ,
}
string ,
accept:
{
Description: Accept header ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: Location of the receipt ,
}
string ,
}
,
$schema: file ,
}

⚐ Response (400)

{
$schema: file ,
}

⚐ Response (404)

{
$schema: file ,
}

⚐ Response (429)

{
$headers:
{
retry-after:
{
Description: Retry-After seconds value to help with polling ,
}
integer ,
}
,
$schema: file ,
}

⚐ Response (500)

{
$schema: file ,
}

⚐ Response (503)

{
$headers:
{
retry-after:
{
Description: Retry the same request after a suggested number of seconds ,
}
integer ,
}
,
$schema: file ,
}
GetEntryStatement (new)
Description :  Get the transparent statement consisting of the signed statement and the receipt embedded in the header
Reference :  Link ¶

⚼ Request

GET:  /entries/{entryId}/statement
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
entryId:
{
Description: ID of the entry to retrieve. ,
Required: True ,
}
string ,
accept:
{
Description: Accept header ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (400)

{
$schema: file ,
}

⚐ Response (404)

{
$schema: file ,
}

⚐ Response (429)

{
$headers:
{
retry-after:
{
Description: Retry-After seconds value to help with polling ,
}
integer ,
}
,
$schema: file ,
}

⚐ Response (500)

{
$schema: file ,
}

⚐ Response (503)

{
$headers:
{
retry-after:
{
Description: Retry the same request after a suggested number of seconds ,
}
integer ,
}
,
$schema: file ,
}
GetPublicKeys (new)
Description :  Get the public keys used by the service to sign receipts, mentioned in IETF SCITT draft as part of jwks_uri implementation
Reference :  Link ¶

⚼ Request

GET:  /jwks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
keys:
{
Description: List of public keys used for receipt verification. ,
Required: True ,
}
[
{
alg:
{
Description: The "alg" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA "JSON Web Signature and Encryption Algorithms" registry established by [JWA] or be a value that contains a Collision- Resistant Name. ,
Required: False ,
}
string ,
crv:
{
Description: The "crv" (curve) parameter identifies the curve type ,
Required: False ,
}
string ,
d:
{
Description: RSA private exponent or ECC private key ,
Required: False ,
}
string ,
dp:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
dq:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
e:
{
Description: RSA public exponent, in Base64 ,
Required: False ,
}
string ,
k:
{
Description: Symmetric key ,
Required: False ,
}
string ,
kid:
{
Description: The "kid" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the "kid" value is unspecified. When "kid" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct "kid" values. (One example in which different keys might use the same "kid" value is if they have different "kty" (key type) values but are considered to be equivalent alternatives by the application using them.) The "kid" value is a case-sensitive string. ,
Required: False ,
}
string ,
kty:
{
Description: The "kty" (key type) parameter identifies the cryptographic algorithm family used with the key, such as "RSA" or "EC". "kty" values should either be registered in the IANA "JSON Web Key Types" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The "kty" value is a case-sensitive string. ,
Required: True ,
}
string ,
n:
{
Description: RSA modulus, in Base64 ,
Required: False ,
}
string ,
p:
{
Description: RSA secret prime ,
Required: False ,
}
string ,
q:
{
Description: RSA secret prime, with p < q ,
Required: False ,
}
string ,
qi:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
use:
{
Description: Use ("public key use") identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly "sig" (signature) or "enc" (encryption). ,
Required: False ,
}
string ,
x:
{
Description: X coordinate for the Elliptic Curve point ,
Required: False ,
}
string ,
x5c:
{
Description: The "x5c" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. ,
Required: False ,
}
[
string ,
]
,
y:
{
Description: Y coordinate for the Elliptic Curve point ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (400)

{
$schema: file ,
}

⚐ Response (404)

{
$schema: file ,
}

⚐ Response (429)

{
$headers:
{
retry-after:
{
Description: Retry-After seconds value to help with polling ,
}
integer ,
}
,
$schema: file ,
}

⚐ Response (500)

{
$schema: file ,
}

⚐ Response (503)

{
$headers:
{
retry-after:
{
Description: Retry the same request after a suggested number of seconds ,
}
integer ,
}
,
$schema: file ,
}
GetOperation (new)
Description :  Get status of the long running registration operation, mandatory in IETF SCITT draft
Reference :  Link ¶

⚼ Request

GET:  /operations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
operationId:
{
Description: ID of the operation to retrieve. ,
Required: True ,
}
string ,
accept:
{
Description: Accept header ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
location:
{
Description: Location of the entry ,
}
string ,
}
,
$schema: file ,
}

⚐ Response (202)

{
location:
{
Description: Location of the operation ,
}
string ,
retry-after:
{
Description: Retry-After seconds value to help with polling ,
}
integer ,
}

⚐ Response (400)

{
$schema: file ,
}

⚐ Response (404)

{
$schema: file ,
}

⚐ Response (429)

{
$headers:
{
retry-after:
{
Description: Retry-After seconds value to help with polling ,
}
integer ,
}
,
$schema: file ,
}

⚐ Response (500)

{
$schema: file ,
}

⚐ Response (503)

{
$headers:
{
retry-after:
{
Description: Retry the same request after a suggested number of seconds ,
}
integer ,
}
,
$schema: file ,
}