Microsoft.ConfidentialLedger (preview:2024-08-22)

2024/12/04 • 6 new methods

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