Microsoft.ConfidentialLedger (preview:2022-04-20)

2025/10/09 • 14 deleted methods

ConfidentialLedger_GetConstitution (removed)
Description :  The constitution is a script that assesses and applies proposals from consortium members.
Reference :  Link ¶

⚼ Request

GET:  /app/governance/constitution
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
digest:
{
Description: SHA256 digest of the constitution script. ,
Required: True ,
}
string ,
script:
{
Description: Contents of the constitution. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_GetConsortiumMembers (removed)
Description :  Consortium members can manage the Confidential Ledger.
Reference :  Link ¶

⚼ Request

GET:  /app/governance/members
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
members:
{
Required: True ,
}
[
{
certificate:
{
Description: PEM-encoded certificate associated with the member. ,
Required: True ,
}
string ,
id:
{
Description: Identifier assigned to the member. ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_GetEnclaveQuotes (removed)
Description :  A quote is an SGX enclave measurement that can be used to verify the validity of a node and its enclave.
Reference :  Link ¶

⚼ Request

GET:  /app/enclaveQuotes
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
currentNodeId:
{
Description: Id of the Confidential Ledger node responding to the request. ,
Required: True ,
}
string ,
enclaveQuotes:
{
Description: Dictionary of enclave quotes, indexed by node id. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_GetCollections (removed)
Description :  Collection ids are user-created collections of ledger entries
Reference :  Link ¶

⚼ Request

GET:  /app/collections
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
collectionId:
{
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_GetLedgerEntries (removed)
Description :  A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned.
Reference :  Link ¶

⚼ Request

GET:  /app/transactions
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection id. ,
Required: False ,
}
string ,
fromTransactionId:
{
Description: Specify the first transaction ID in a range. ,
Required: False ,
}
string ,
toTransactionId:
{
Description: Specify the last transaction ID in a range. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
state:
{
Description: State of a ledger query. ,
Enum:
{
Loading: No description available. ,
Ready: No description available. ,
}
,
Required: True ,
}
enum ,
nextLink:
{
Description: Path from which to retrieve the next page of results. ,
Required: False ,
}
string ,
entries:
{
Description: Array of ledger entries. ,
Required: True ,
}
[
{
contents:
{
Description: Contents of the ledger entry. ,
Required: True ,
}
string ,
collectionId:
{
Required: False ,
}
string ,
transactionId:
{
Description: A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_PostLedgerEntry (removed)
Description :  A collection id may optionally be specified.
Reference :  Link ¶

⚼ Request

POST:  /app/transactions
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection id. ,
Required: False ,
}
string ,
entry:
{
Description: Ledger entry. ,
Required: False ,
}
{
contents:
{
Description: Contents of the ledger entry. ,
Required: True ,
}
string ,
collectionId:
{
Required: False ,
}
string ,
transactionId:
{
Description: A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: The transaction id at which this write will become durable. ,
}
string ,
}
,
$schema:
{
Description: Returned as a result of a write to the Confidential Ledger, the transaction id in the response indicates when the write will become durable. ,
}
{
collectionId:
{
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_GetLedgerEntry (removed)
Description :  To return older ledger entries, the relevant sections of the ledger must be read from disk and validated. To prevent blocking within the enclave, the response will indicate whether the entry is ready and part of the response, or if the loading is still ongoing.
Reference :  Link ¶

⚼ Request

GET:  /app/transactions/{transactionId}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection id. ,
Required: False ,
}
string ,
transactionId:
{
Description: Identifies a write transaction. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
state:
{
Description: State of a ledger query. ,
Enum:
{
Loading: No description available. ,
Ready: No description available. ,
}
,
Required: True ,
}
enum ,
entry:
{
Description: The ledger entry found as a result of the query. This is only available if the query is in Ready state. ,
Required: False ,
}
{
contents:
{
Description: Contents of the ledger entry. ,
Required: True ,
}
string ,
collectionId:
{
Required: False ,
}
string ,
transactionId:
{
Description: A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_GetReceipt (removed)
Description :  Gets a receipt certifying ledger contents at a particular transaction id.
Reference :  Link ¶

⚼ Request

GET:  /app/transactions/{transactionId}/receipt
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
transactionId:
{
Description: Identifies a write transaction. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
receipt:
{
Required: False ,
}
{
cert:
{
Required: False ,
}
string ,
leaf:
{
Required: False ,
}
string ,
leafComponents:
{
Required: False ,
}
{
claimsDigest:
{
Required: False ,
}
string ,
commitEvidence:
{
Required: False ,
}
string ,
writeSetDigest:
{
Required: False ,
}
string ,
}
,
nodeId:
{
Required: True ,
}
string ,
proof:
{
Required: True ,
}
[
{
left:
{
Required: False ,
}
string ,
right:
{
Required: False ,
}
string ,
}
,
]
,
root:
{
Required: False ,
}
string ,
serviceEndorsements:
{
Required: False ,
}
[
string ,
]
,
signature:
{
Required: True ,
}
string ,
}
,
state:
{
Description: State of a ledger query. ,
Enum:
{
Loading: No description available. ,
Ready: No description available. ,
}
,
Required: True ,
}
enum ,
transactionId:
{
Description: A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_GetTransactionStatus (removed)
Description :  Gets the status of an entry identified by a transaction id.
Reference :  Link ¶

⚼ Request

GET:  /app/transactions/{transactionId}/status
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
transactionId:
{
Description: Identifies a write transaction. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
state:
{
Description: Represents the state of the transaction. ,
Enum:
{
Committed: No description available. ,
Pending: No description available. ,
}
,
Required: True ,
}
enum ,
transactionId:
{
Description: A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_GetCurrentLedgerEntry (removed)
Description :  A collection id may optionally be specified.
Reference :  Link ¶

⚼ Request

GET:  /app/transactions/current
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection id. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
contents:
{
Description: Contents of the ledger entry. ,
Required: True ,
}
string ,
collectionId:
{
Required: False ,
}
string ,
transactionId:
{
Description: A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_DeleteUser (removed)
Description :  Deletes a user from the Confidential Ledger.
Reference :  Link ¶

⚼ Request

DELETE:  /app/users/{userId}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
userId:
{
Description: The user id, either an AAD object ID or certificate fingerprint. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_GetUser (removed)
Description :  Gets a user.
Reference :  Link ¶

⚼ Request

GET:  /app/users/{userId}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
userId:
{
Description: The user id, either an AAD object ID or certificate fingerprint. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
assignedRole:
{
Description: Represents an assignable role. ,
Enum:
{
Administrator: No description available. ,
Contributor: No description available. ,
Reader: No description available. ,
}
,
Required: True ,
}
enum ,
userId:
{
Description: Identifier for the user. This must either be an AAD object id or a certificate fingerprint. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedger_CreateOrUpdateUser (removed)
Description :  A JSON merge patch is applied for existing users
Reference :  Link ¶

⚼ Request

PATCH:  /app/users/{userId}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
userId:
{
Description: The user id, either an AAD object ID or certificate fingerprint. ,
Required: True ,
}
string ,
userDetails:
{
Description: Details about a Confidential Ledger user. ,
Required: True ,
}
{
assignedRole:
{
Description: Represents an assignable role. ,
Enum:
{
Administrator: No description available. ,
Contributor: No description available. ,
Reader: No description available. ,
}
,
Required: True ,
}
enum ,
userId:
{
Description: Identifier for the user. This must either be an AAD object id or a certificate fingerprint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
assignedRole:
{
Description: Represents an assignable role. ,
Enum:
{
Administrator: No description available. ,
Contributor: No description available. ,
Reader: No description available. ,
}
,
Required: True ,
}
enum ,
userId:
{
Description: Identifier for the user. This must either be an AAD object id or a certificate fingerprint. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
ConfidentialLedgerIdentityService_GetLedgerIdentity (removed)
Description :  Gets identity information for a Confidential Ledger instance.
Reference :  Link ¶

⚼ Request

GET:  /ledgerIdentity/{ledgerId}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
ledgerId:
{
Description: Id of the Confidential Ledger instance to get information for ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
ledgerId:
{
Description: Id for the ledger. ,
Required: False ,
}
string ,
ledgerTlsCertificate:
{
Description: PEM-encoded certificate used for TLS by the Confidential Ledger. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}