Microsoft.ConfidentialLedger (preview:2024-12-09)

2025/02/22 • 33 new methods

GetConstitution (new)
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 ,
}
,
}
ListConsortiumMembers (new)
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 ,
}
,
]
,
nextLink:
{
Description: Path from which to retrieve the next page of results. ,
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 ,
}
,
}
GetEnclaveQuotes (new)
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 ,
}
,
}
ListCollections (new)
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)

{
collections:
{
Required: True ,
}
[
{
collectionId:
{
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: Path from which to retrieve the next page of results. ,
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 ,
}
,
}
ListLedgerEntries (new)
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 ,
preHooks:
{
Description: List of user defined function hooks to be executed before the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
postHooks:
{
Description: List of user defined function hooks to be executed after the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
]
,
}

⚐ 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 ,
}
,
}
CreateLedgerEntry (new)
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: 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 ,
preHooks:
{
Description: List of user defined function hooks to be executed before the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
postHooks:
{
Description: List of user defined function hooks to be executed after the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
}
GetLedgerEntry (new)
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 ,
preHooks:
{
Description: List of user defined function hooks to be executed before the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
postHooks:
{
Description: List of user defined function hooks to be executed after the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
}
GetReceipt (new)
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)

{
applicationClaims:
{
Description: List of application claims. ,
Required: False ,
}
[
{
digest:
{
Description: An application claim in digested form. ,
Required: False ,
}
{
value:
{
Description: The digest of the application claim, in hexadecimal form. ,
Required: False ,
}
string ,
protocol:
{
Description: Represents the protocol to be used to compute the digest of a claim from the given claim data. ,
Enum:
{
LedgerEntryV1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
kind:
{
Description: Represents the kind of an application claim. ,
Enum:
{
LedgerEntry: No description available. ,
ClaimDigest: No description available. ,
}
,
Required: True ,
}
enum ,
ledgerEntry:
{
Description: An application claim derived from ledger entry data. ,
Required: False ,
}
{
collectionId:
{
Description: Identifier of a collection. ,
Required: False ,
}
string ,
contents:
{
Description: Contents of a ledger entry. ,
Required: False ,
}
string ,
secretKey:
{
Description: Base64-encoded secret key. ,
Required: False ,
}
string ,
protocol:
{
Description: Represents the protocol to be used to compute the digest of a claim from the given claim data. ,
Enum:
{
LedgerEntryV1: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
}
GetTransactionStatus (new)
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 ,
}
,
}
GetCurrentLedgerEntry (new)
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 ,
preHooks:
{
Description: List of user defined function hooks to be executed before the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
postHooks:
{
Description: List of user defined function hooks to be executed after the ledger entry is written. ,
Required: False ,
}
[
{
functionId:
{
Description: ID of the user defined function to execute. ,
Required: True ,
}
string ,
properties:
{
Description: The properties for executing a user defined function. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
}
ListUsers (new)
Description :  All users' object IDs and single role per user will be returned.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
ledgerUsers:
{
Required: False ,
}
[
{
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 ,
}
,
]
,
nextLink:
{
Description: Path from which to retrieve the next page of results. ,
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 ,
}
,
}
ListLedgerUsers (new)
Description :  All users' object IDs and multiple roles will be returned.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
ledgerUsers:
{
Required: False ,
}
[
{
assignedRoles:
{
Description: Represents an assignable role. ,
Required: True ,
}
[
string ,
]
,
userId:
{
Description: Identifier for the user. This must either be an AAD object id or a certificate fingerprint. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Path from which to retrieve the next page of results. ,
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 ,
}
,
}
DeleteUser (new)
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 ,
}
,
}
GetUser (new)
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 ,
}
,
}
CreateOrUpdateUser (new)
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 ,
}
,
}
DeleteLedgerUser (new)
Description :  Deletes a user with multiple roles from the Confidential Ledger.
Reference :  Link ¶

⚼ Request

DELETE:  /app/ledgerUsers/{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 ,
}
,
}
GetLedgerUser (new)
Description :  Gets a user with multiple roles.
Reference :  Link ¶

⚼ Request

GET:  /app/ledgerUsers/{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)

{
assignedRoles:
{
Description: Represents an assignable role. ,
Required: True ,
}
[
string ,
]
,
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 ,
}
,
}
CreateOrUpdateLedgerUser (new)
Description :  A JSON merge patch is applied for existing users
Reference :  Link ¶

⚼ Request

PATCH:  /app/ledgerUsers/{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 ,
userMultipleRoles:
{
Description: Details about a Confidential Ledger user with multiple roles. ,
Required: True ,
}
{
assignedRoles:
{
Description: Represents an assignable role. ,
Required: True ,
}
[
string ,
]
,
userId:
{
Description: Identifier for the user. This must either be an AAD object id or a certificate fingerprint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
assignedRoles:
{
Description: Represents an assignable role. ,
Required: True ,
}
[
string ,
]
,
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 ,
}
,
}
GetUserDefinedEndpoint (new)
Description :  Returns the user defined endpoint in the ACL instance
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
metadata:
{
Required: True ,
}
{
endpoints:
{
Description: A map of path to method endpoints for the path ,
Required: True ,
}
object ,
}
,
modules:
{
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 ,
}
,
}
CreateUserDefinedEndpoint (new)
Description :  Creates the user defined endpoint in the ACL instance
Reference :  Link ¶

⚼ Request

PUT:  /app/userDefinedEndpoints
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
bundle:
{
Description: bundle parameter description ,
Required: True ,
}
{
metadata:
{
Required: True ,
}
{
endpoints:
{
Description: A map of path to method endpoints for the path ,
Required: True ,
}
object ,
}
,
modules:
{
Required: True ,
}
object ,
}
,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
}
GetRuntimeOptions (new)
Description :  It returns the runtime options
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}

⚐ 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 ,
}
,
}
UpdateRuntimeOptions (new)
Description :  Updates the runtime options.
Reference :  Link ¶

⚼ Request

PATCH:  /app/userDefinedEndpoints/runTimeOptions
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
JSRuntimeOptions:
{
Description: JS runtime options ,
Required: True ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}

⚐ 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 ,
}
,
}
GetUserDefinedEndpointsModule (new)
Description :  It gets the module for the user defined endpoint.
Reference :  Link ¶

⚼ Request

GET:  /app/userDefinedEndpoints/modules
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
module:
{
Description: module name of the user defined endpoint ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
module:
{
Required: True ,
}
string ,
name:
{
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 ,
}
,
}
ListUserDefinedFunctions (new)
Description :  User defined functions stored in the Confidential Ledger
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
functions:
{
Required: True ,
}
[
{
code:
{
Description: Code of the user defined function in JavaScript. ,
Required: True ,
}
string ,
id:
{
Description: ID of the user defined function. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Path from which to retrieve the next page of results. ,
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 ,
}
,
}
DeleteUserDefinedFunction (new)
Description :  Deletes a user defined function from the Confidential Ledger.
Reference :  Link ¶

⚼ Request

DELETE:  /app/userDefinedFunctions/{functionId}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
functionId:
{
Description: Identifies a user defined function. ,
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 ,
}
,
}
GetUserDefinedFunction (new)
Description :  Returns the user defined function in the Confidential Ledger
Reference :  Link ¶

⚼ Request

GET:  /app/userDefinedFunctions/{functionId}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
functionId:
{
Description: Identifies a user defined function. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
code:
{
Description: Code of the user defined function in JavaScript. ,
Required: True ,
}
string ,
id:
{
Description: ID of the user defined function. ,
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 ,
}
,
}
CreateUserDefinedFunction (new)
Description :  Creates the user defined function in the Confidential Ledger
Reference :  Link ¶

⚼ Request

PUT:  /app/userDefinedFunctions/{functionId}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
functionId:
{
Description: Identifies a user defined function. ,
Required: True ,
}
string ,
userDefinedFunction:
{
Description: Specify a user defined function of a Confidential Ledger. ,
Required: True ,
}
{
code:
{
Description: Code of the user defined function in JavaScript. ,
Required: True ,
}
string ,
id:
{
Description: ID of the user defined function. ,
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: A user defined function in the ledger. ,
}
{
code:
{
Description: Code of the user defined function in JavaScript. ,
Required: True ,
}
string ,
id:
{
Description: ID of the user defined function. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-ccf-transaction-id:
{
Description: The transaction id at which this write will become durable. ,
}
string ,
}
,
$schema:
{
Description: A user defined function in the ledger. ,
}
{
code:
{
Description: Code of the user defined function in JavaScript. ,
Required: True ,
}
string ,
id:
{
Description: ID of the user defined function. ,
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 ,
}
,
}
ExecuteUserDefinedFunction (new)
Description :  Executes the user defined function in the Confidential Ledger
Reference :  Link ¶

⚼ Request

POST:  /app/userDefinedFunctions/{functionId}:execute
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
functionId:
{
Description: Identifies a user defined function. ,
Required: True ,
}
string ,
userDefinedFunctionExecutionProperties:
{
Description: Specify user defined function execution properties. ,
Required: False ,
}
{
arguments:
{
Description: Runtime arguments of the user defined function. Defaults to an empty list. ,
Required: False ,
}
[
string ,
]
,
exportedFunctionName:
{
Description: Name of the exported function to execute in the code of the user defined function. Defaults to main. ,
Required: False ,
}
string ,
runtimeOptions:
{
Description: JS runtime options for user defined endpoints and functions ,
Required: False ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object of a user defined function execution. This is returned only when the user defined function execution throws an exception. ,
Required: False ,
}
{
message:
{
Description: Message indicating the error thrown when executing the function. ,
Required: False ,
}
string ,
}
,
result:
{
Description: The result object of a user defined function execution. This is returned only when the user defined function executes successfully. ,
Required: False ,
}
{
returnValue:
{
Description: String-encoded value returned by the user defined function execution. If the function does not return any value, this is set to an empty string. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the status of a user defined function execution. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ 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 ,
}
,
}
GetUserDefinedRole (new)
Description :  user defined roles allow users to define and manage app specific AuthZ policy.
Reference :  Link ¶

⚼ Request

GET:  /app/roles
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
roleName:
{
Description: user defined role name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
roleName:
{
Description: name of the user defined role ,
Required: False ,
}
string ,
roleActions:
{
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 ,
}
,
}
CreateUserDefinedRole (new)
Description :  User defined roles allow users to define and manage app specific AuthZ policy.
Reference :  Link ¶

⚼ Request

PUT:  /app/roles
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
roles:
{
Description: user defined role ,
Required: True ,
}
{
roleName:
{
Description: name of the user defined role ,
Required: False ,
}
string ,
roleActions:
{
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
UpdateUserDefinedRole (new)
Description :  User defined roles allow users to define and manage app specific AuthZ policy.
Reference :  Link ¶

⚼ Request

PATCH:  /app/roles
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
roles:
{
Description: user defined role ,
Required: True ,
}
{
roleName:
{
Description: name of the user defined role ,
Required: False ,
}
string ,
roleActions:
{
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
DeleteUserDefinedRole (new)
Description :  A user defined role allows the users to create and manage their own role actions using the API.
Reference :  Link ¶

⚼ Request

DELETE:  /app/roles
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
roleName:
{
Description: user defined role name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
}
GetLedgerIdentity (new)
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 ,
}
,
}