Microsoft.CodeTransparency (preview:2024-01-11)

2025/03/06 • 3 new, 7 updated methods

CreateEntryDeprecated (new)
Description :  Post an entry to be registered on the CodeTransparency instance (deprecated)
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
operationId:
{
Description: String representing the operation id submitted ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetEntryDeprecated (new)
Description :  Get signed statement with or without receipt embedded in its unprotected header
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 ,
embedReceipt:
{
Description: Embed a receipt as part of the response ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetEntryReceiptDeprecated (new)
Description :  Get the receipt of an entry given a specific entry id.
Reference :  Link ¶

⚼ Request

GET:  /entries/{entryId}/receipt
{
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 ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetDidConfig (updated)
Description :  Get the DID configuration file (deprecated)
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetDidConfig",
  "Description": {
    "new": "Get the DID configuration file (deprecated)",
    "old": "Get the DID configuration file."
  }
}

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: String representing a DID issuer. ,
Required: True ,
}
string ,
assertionMethod:
{
Description: List of public keys used for receipt endorsement verification. ,
Required: True ,
}
[
{
id:
{
Description: Key identifier. ,
Required: True ,
}
string ,
controller:
{
Description: Key controller - similar to DID issuer. ,
Required: True ,
}
string ,
type:
{
Description: Key type. ,
Enum:
{
JsonWebKey2020: No description available. ,
}
,
Required: True ,
}
enum ,
publicKeyJwk:
{
Description: Serialized public key in JWK format. ,
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 (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetCodeTransparencyConfig (updated)
Description :  Get CodeTransparency configuration information.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetCodeTransparencyConfig",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "policy",
          "Description": {
            "new": "Policy configuration",
            "old": "Configuration of CCF Authentication policies."
          }
        },
        {
          "#name": "authentication",
          "Description": {
            "new": "Authentication configuration",
            "old": "Configuration of CCF authentication."
          },
          "$properties": [
            {
              "#name": "jwt",
              "Description": {
                "new": "JWT requirements if authentication is enabled",
                "old": "Configuration of JWT claims"
              }
            }
          ]
        },
        {
          "#name": "service_identifier",
          "Description": {
            "new": "Issuer used in receipts",
            "old": "did:web identifier"
          }
        }
      ]
    },
    "@added_d8cf0e1161394c52aa7eb3a6564c537f": {
      "#status": "500",
      "$headers": [
        {
          "#name": "x-ms-error-code",
          "Description": "String error code indicating what went wrong.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "A response containing error details.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": true,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "One of a server-defined set of error codes.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "A human-readable representation of the error.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The target of the error.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "An array of details about specific errors that led to this reported error.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "innererror",
                "Description": "An object containing more specific information than the current object about the error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "One of a server-defined set of error codes.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "innererror",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "@added_db4c385941bd4880b8a0c7b633e32a32": {
      "#status": "503",
      "$headers": [
        {
          "#name": "retry-after",
          "Description": "Retry the same request after a suggested number of seconds",
          "Type": "string"
        },
        {
          "#name": "x-ms-error-code",
          "Description": "String error code indicating what went wrong.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "A response containing error details.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": true,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "One of a server-defined set of error codes.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "A human-readable representation of the error.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The target of the error.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "An array of details about specific errors that led to this reported error.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "innererror",
                "Description": "An object containing more specific information than the current object about the error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "One of a server-defined set of error codes.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "innererror",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "@removed_c6d8fbc66cd8407a83eaa140d91e4d6f": {
      "#status": "default",
      "$headers": [
        {
          "#name": "x-ms-error-code",
          "Description": "String error code indicating what went wrong.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "A response containing error details.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": true,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "One of a server-defined set of error codes.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "A human-readable representation of the error.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The target of the error.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "An array of details about specific errors that led to this reported error.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "innererror",
                "Description": "An object containing more specific information than the current object about the error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "One of a server-defined set of error codes.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "innererror",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
policy:
{
Description: Policy configuration ,
Required: False ,
}
{
accepted_algorithms:
{
Description: Accepted COSE signature algorithms when verifying signed statements ,
Required: False ,
}
[
string ,
]
,
accepted_did_issuers:
{
Description: Accepted COSE signature did:web issuers when verifying signed statements ,
Required: False ,
}
[
string ,
]
,
}
,
authentication:
{
Description: Authentication configuration ,
Required: False ,
}
{
allow_unauthenticated:
{
Description: Disable API authentication and rely on signed statement verification only ,
Required: True ,
}
boolean ,
jwt:
{
Description: JWT requirements if authentication is enabled ,
Required: False ,
}
{
required_claims:
{
Description: Claims that must be present in the JWT ,
Required: True ,
}
object ,
}
,
}
,
service_identifier:
{
Description: Issuer used in receipts ,
Required: False ,
}
string ,
}

⚐ Response (500)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (503)

{
$headers:
{
retry-after:
{
Description: Retry the same request after a suggested number of seconds ,
}
string ,
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListEntryIds (updated)
Description :  Historical query to get a list of entries of a given range
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListEntryIds",
  "$responses": {
    "@added_f6837e6e98884555a88a033e76f5e406": {
      "#status": "500",
      "$headers": [
        {
          "#name": "x-ms-error-code",
          "Description": "String error code indicating what went wrong.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "A response containing error details.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": true,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "One of a server-defined set of error codes.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "A human-readable representation of the error.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The target of the error.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "An array of details about specific errors that led to this reported error.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "innererror",
                "Description": "An object containing more specific information than the current object about the error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "One of a server-defined set of error codes.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "innererror",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "503": {
      "Description": {
        "new": "A response containing error details.",
        "old": "Service temporarily unavailable"
      }
    },
    "@removed_86eeeb183fe842968575c55077add7b4": {
      "#status": "default",
      "$headers": [
        {
          "#name": "x-ms-error-code",
          "Description": "String error code indicating what went wrong.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "A response containing error details.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": true,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "One of a server-defined set of error codes.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "A human-readable representation of the error.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The target of the error.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "An array of details about specific errors that led to this reported error.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "innererror",
                "Description": "An object containing more specific information than the current object about the error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "One of a server-defined set of error codes.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "innererror",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /entries/txIds
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
from:
{
Description: Starting Transaction Id ,
Format: int64 ,
Required: False ,
}
integer ,
to:
{
Description: Ending Transaction Id ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
transactionIds:
{
Description: List of entry ids ,
Required: True ,
}
[
string ,
]
,
nextLink:
{
Description: Path to the next page of results ,
Required: False ,
}
string ,
}

⚐ Response (500)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (503)

{
$headers:
{
retry-after:
{
Description: Retry the same request after a suggested number of seconds ,
}
string ,
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ListEntryStatuses (updated)
Description :  Get the status of all entries operations (deprecated)
Reference :  Link ¶

⚶ Changes

{
  "#id": "ListEntryStatuses",
  "Description": {
    "new": "Get the status of all entries operations (deprecated)",
    "old": "Get the status of all entries operations"
  }
}

⚼ Request

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

⚐ Response (200)

{
operations:
{
Description: List of operations ,
Required: True ,
}
[
{
entryId:
{
Description: ID of the transaction. Only if status is Succeeded. ,
Required: False ,
}
string ,
error:
{
Description: Error in json format. Only if Status is Failed. ,
Required: False ,
}
string ,
operationId:
{
Description: OperationId ,
Required: True ,
}
string ,
status:
{
Description: Status of the operation. ,
Enum:
{
running: Operation is still running. ,
failed: Operation failed. ,
succeeded: Operation succeeded. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetEntryStatus (updated)
Description :  Get the status the entry operation (deprecated)
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetEntryStatus",
  "Description": {
    "new": "Get the status the entry operation (deprecated)",
    "old": "Get the status the entry operation"
  }
}

⚼ 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 ,
}

⚐ Response (200)

{
entryId:
{
Description: ID of the transaction. Only if status is Succeeded. ,
Required: False ,
}
string ,
error:
{
Description: Error in json format. Only if Status is Failed. ,
Required: False ,
}
string ,
operationId:
{
Description: OperationId ,
Required: True ,
}
string ,
status:
{
Description: Status of the operation. ,
Enum:
{
running: Operation is still running. ,
failed: Operation failed. ,
succeeded: Operation succeeded. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetParameters (updated)
Description :  Get service parameters (deprecated)
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetParameters",
  "Description": {
    "new": "Get service parameters (deprecated)",
    "old": "Get service parameters"
  }
}

⚼ Request

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

⚐ Response (200)

{
serviceCertificate:
{
Description: Service certificate used in TLS and for receipt verification ,
Required: True ,
}
string ,
serviceId:
{
Description: Service identifier ,
Required: True ,
}
string ,
signatureAlgorithm:
{
Description: Signature algorithm used in receipts ,
Required: True ,
}
string ,
treeAlgorithm:
{
Description: Tree algorithm used in receipts ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
GetCodeTransparencyVersion (updated)
Description :  Get CodeTransparency version information.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetCodeTransparencyVersion",
  "$responses": {
    "@added_b2073c4e6e4447cfb2eb589dac155a21": {
      "#status": "500",
      "$headers": [
        {
          "#name": "x-ms-error-code",
          "Description": "String error code indicating what went wrong.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "A response containing error details.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": true,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "One of a server-defined set of error codes.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "A human-readable representation of the error.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The target of the error.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "An array of details about specific errors that led to this reported error.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "innererror",
                "Description": "An object containing more specific information than the current object about the error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "One of a server-defined set of error codes.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "innererror",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "@added_3a0634bc4c3f46a6ab5eda26c2fc9685": {
      "#status": "503",
      "$headers": [
        {
          "#name": "retry-after",
          "Description": "Retry the same request after a suggested number of seconds",
          "Type": "string"
        },
        {
          "#name": "x-ms-error-code",
          "Description": "String error code indicating what went wrong.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "A response containing error details.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": true,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "One of a server-defined set of error codes.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "A human-readable representation of the error.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The target of the error.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "An array of details about specific errors that led to this reported error.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "innererror",
                "Description": "An object containing more specific information than the current object about the error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "One of a server-defined set of error codes.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "innererror",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "@removed_da14838f52fe4a028cdecac3acc1fa5b": {
      "#status": "default",
      "$headers": [
        {
          "#name": "x-ms-error-code",
          "Description": "String error code indicating what went wrong.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "A response containing error details.",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": true,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "One of a server-defined set of error codes.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "A human-readable representation of the error.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The target of the error.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "An array of details about specific errors that led to this reported error.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "innererror",
                "Description": "An object containing more specific information than the current object about the error.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "One of a server-defined set of error codes.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "innererror",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
scitt_version:
{
Description: Version of the CodeTransparency service ,
Required: True ,
}
string ,
}

⚐ Response (500)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (503)

{
$headers:
{
retry-after:
{
Description: Retry the same request after a suggested number of seconds ,
}
string ,
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}