# \DefaultApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_v2_idps_idp_id**](DefaultApi.md#delete_v2_idps_idp_id) | **DELETE** /v2/idps/{idp_id} |
[**delete_v2_users_user_id**](DefaultApi.md#delete_v2_users_user_id) | **DELETE** /v2/users/{user_id} |
[**get_livez**](DefaultApi.md#get_livez) | **GET** /livez |
[**get_readyz**](DefaultApi.md#get_readyz) | **GET** /readyz |
[**get_v2_authenticated_user**](DefaultApi.md#get_v2_authenticated_user) | **GET** /v2/authenticated-user |
[**get_v2_idps**](DefaultApi.md#get_v2_idps) | **GET** /v2/idps |
[**get_v2_idps_idp_id**](DefaultApi.md#get_v2_idps_idp_id) | **GET** /v2/idps/{idp_id} |
[**get_v2_interactive_submission_preferred_package_version**](DefaultApi.md#get_v2_interactive_submission_preferred_package_version) | **GET** /v2/interactive-submission/preferred-package-version |
[**get_v2_package_vetting**](DefaultApi.md#get_v2_package_vetting) | **GET** /v2/package-vetting |
[**get_v2_packages**](DefaultApi.md#get_v2_packages) | **GET** /v2/packages |
[**get_v2_packages_package_id**](DefaultApi.md#get_v2_packages_package_id) | **GET** /v2/packages/{package_id} |
[**get_v2_packages_package_id_status**](DefaultApi.md#get_v2_packages_package_id_status) | **GET** /v2/packages/{package_id}/status |
[**get_v2_parties**](DefaultApi.md#get_v2_parties) | **GET** /v2/parties |
[**get_v2_parties_participant_id**](DefaultApi.md#get_v2_parties_participant_id) | **GET** /v2/parties/participant-id |
[**get_v2_parties_party**](DefaultApi.md#get_v2_parties_party) | **GET** /v2/parties/{party} |
[**get_v2_state_active_contracts_page**](DefaultApi.md#get_v2_state_active_contracts_page) | **GET** /v2/state/active-contracts-page |
[**get_v2_state_connected_synchronizers**](DefaultApi.md#get_v2_state_connected_synchronizers) | **GET** /v2/state/connected-synchronizers |
[**get_v2_state_latest_pruned_offsets**](DefaultApi.md#get_v2_state_latest_pruned_offsets) | **GET** /v2/state/latest-pruned-offsets |
[**get_v2_state_ledger_end**](DefaultApi.md#get_v2_state_ledger_end) | **GET** /v2/state/ledger-end |
[**get_v2_updates_transaction_tree_by_id_update_id**](DefaultApi.md#get_v2_updates_transaction_tree_by_id_update_id) | **GET** /v2/updates/transaction-tree-by-id/{update_id} |
[**get_v2_updates_transaction_tree_by_offset_offset**](DefaultApi.md#get_v2_updates_transaction_tree_by_offset_offset) | **GET** /v2/updates/transaction-tree-by-offset/{offset} |
[**get_v2_users**](DefaultApi.md#get_v2_users) | **GET** /v2/users |
[**get_v2_users_user_id**](DefaultApi.md#get_v2_users_user_id) | **GET** /v2/users/{user_id} |
[**get_v2_users_user_id_rights**](DefaultApi.md#get_v2_users_user_id_rights) | **GET** /v2/users/{user_id}/rights |
[**get_v2_version**](DefaultApi.md#get_v2_version) | **GET** /v2/version |
[**patch_v2_idps_idp_id**](DefaultApi.md#patch_v2_idps_idp_id) | **PATCH** /v2/idps/{idp_id} |
[**patch_v2_parties_party**](DefaultApi.md#patch_v2_parties_party) | **PATCH** /v2/parties/{party} |
[**patch_v2_users_user_id**](DefaultApi.md#patch_v2_users_user_id) | **PATCH** /v2/users/{user_id} |
[**patch_v2_users_user_id_identity_provider_id**](DefaultApi.md#patch_v2_users_user_id_identity_provider_id) | **PATCH** /v2/users/{user_id}/identity-provider-id |
[**patch_v2_users_user_id_rights**](DefaultApi.md#patch_v2_users_user_id_rights) | **PATCH** /v2/users/{user_id}/rights |
[**post_v2_commands_async_submit**](DefaultApi.md#post_v2_commands_async_submit) | **POST** /v2/commands/async/submit |
[**post_v2_commands_async_submit_reassignment**](DefaultApi.md#post_v2_commands_async_submit_reassignment) | **POST** /v2/commands/async/submit-reassignment |
[**post_v2_commands_completions**](DefaultApi.md#post_v2_commands_completions) | **POST** /v2/commands/completions |
[**post_v2_commands_submit_and_wait**](DefaultApi.md#post_v2_commands_submit_and_wait) | **POST** /v2/commands/submit-and-wait |
[**post_v2_commands_submit_and_wait_for_reassignment**](DefaultApi.md#post_v2_commands_submit_and_wait_for_reassignment) | **POST** /v2/commands/submit-and-wait-for-reassignment |
[**post_v2_commands_submit_and_wait_for_transaction**](DefaultApi.md#post_v2_commands_submit_and_wait_for_transaction) | **POST** /v2/commands/submit-and-wait-for-transaction |
[**post_v2_commands_submit_and_wait_for_transaction_tree**](DefaultApi.md#post_v2_commands_submit_and_wait_for_transaction_tree) | **POST** /v2/commands/submit-and-wait-for-transaction-tree |
[**post_v2_contracts_contract_by_id**](DefaultApi.md#post_v2_contracts_contract_by_id) | **POST** /v2/contracts/contract-by-id |
[**post_v2_dars**](DefaultApi.md#post_v2_dars) | **POST** /v2/dars |
[**post_v2_dars_validate**](DefaultApi.md#post_v2_dars_validate) | **POST** /v2/dars/validate |
[**post_v2_events_events_by_contract_id**](DefaultApi.md#post_v2_events_events_by_contract_id) | **POST** /v2/events/events-by-contract-id |
[**post_v2_idps**](DefaultApi.md#post_v2_idps) | **POST** /v2/idps |
[**post_v2_interactive_submission_execute**](DefaultApi.md#post_v2_interactive_submission_execute) | **POST** /v2/interactive-submission/execute |
[**post_v2_interactive_submission_executeandwait**](DefaultApi.md#post_v2_interactive_submission_executeandwait) | **POST** /v2/interactive-submission/executeAndWait |
[**post_v2_interactive_submission_executeandwaitfortransaction**](DefaultApi.md#post_v2_interactive_submission_executeandwaitfortransaction) | **POST** /v2/interactive-submission/executeAndWaitForTransaction |
[**post_v2_interactive_submission_preferred_packages**](DefaultApi.md#post_v2_interactive_submission_preferred_packages) | **POST** /v2/interactive-submission/preferred-packages |
[**post_v2_interactive_submission_prepare**](DefaultApi.md#post_v2_interactive_submission_prepare) | **POST** /v2/interactive-submission/prepare |
[**post_v2_package_vetting**](DefaultApi.md#post_v2_package_vetting) | **POST** /v2/package-vetting |
[**post_v2_package_vetting_list**](DefaultApi.md#post_v2_package_vetting_list) | **POST** /v2/package-vetting/list |
[**post_v2_package_vetting_update**](DefaultApi.md#post_v2_package_vetting_update) | **POST** /v2/package-vetting/update |
[**post_v2_packages**](DefaultApi.md#post_v2_packages) | **POST** /v2/packages |
[**post_v2_parties**](DefaultApi.md#post_v2_parties) | **POST** /v2/parties |
[**post_v2_parties_external_allocate**](DefaultApi.md#post_v2_parties_external_allocate) | **POST** /v2/parties/external/allocate |
[**post_v2_parties_external_generate_topology**](DefaultApi.md#post_v2_parties_external_generate_topology) | **POST** /v2/parties/external/generate-topology |
[**post_v2_state_active_contracts**](DefaultApi.md#post_v2_state_active_contracts) | **POST** /v2/state/active-contracts |
[**post_v2_updates**](DefaultApi.md#post_v2_updates) | **POST** /v2/updates |
[**post_v2_updates_flats**](DefaultApi.md#post_v2_updates_flats) | **POST** /v2/updates/flats |
[**post_v2_updates_get_updates_page**](DefaultApi.md#post_v2_updates_get_updates_page) | **POST** /v2/updates/get-updates-page |
[**post_v2_updates_transaction_by_id**](DefaultApi.md#post_v2_updates_transaction_by_id) | **POST** /v2/updates/transaction-by-id |
[**post_v2_updates_transaction_by_offset**](DefaultApi.md#post_v2_updates_transaction_by_offset) | **POST** /v2/updates/transaction-by-offset |
[**post_v2_updates_trees**](DefaultApi.md#post_v2_updates_trees) | **POST** /v2/updates/trees |
[**post_v2_updates_update_by_id**](DefaultApi.md#post_v2_updates_update_by_id) | **POST** /v2/updates/update-by-id |
[**post_v2_updates_update_by_offset**](DefaultApi.md#post_v2_updates_update_by_offset) | **POST** /v2/updates/update-by-offset |
[**post_v2_users**](DefaultApi.md#post_v2_users) | **POST** /v2/users |
[**post_v2_users_user_id_rights**](DefaultApi.md#post_v2_users_user_id_rights) | **POST** /v2/users/{user_id}/rights |
## delete_v2_idps_idp_id
> serde_json::Value delete_v2_idps_idp_id(idp_id)
Delete an existing identity provider configuration.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**idp_id** | **String** | | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_v2_users_user_id
> serde_json::Value delete_v2_users_user_id(user_id)
Delete an existing user and all its rights.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_livez
> get_livez()
Checks if the service is alive
### Parameters
This endpoint does not need any parameter.
### Return type
(empty response body)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain, application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_readyz
> String get_readyz()
Checks if the service is ready to serve requests
### Parameters
This endpoint does not need any parameter.
### Return type
**String**
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain, application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_authenticated_user
> models::GetUserResponse get_v2_authenticated_user(identity_provider_id)
Get the user data of the current authenticated user.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**identity_provider_id** | Option<**String**> | | |
### Return type
[**models::GetUserResponse**](GetUserResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_idps
> models::ListIdentityProviderConfigsResponse get_v2_idps()
List all existing identity provider configurations.
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::ListIdentityProviderConfigsResponse**](ListIdentityProviderConfigsResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_idps_idp_id
> models::GetIdentityProviderConfigResponse get_v2_idps_idp_id(idp_id)
Get the identity provider configuration data by id.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**idp_id** | **String** | | [required] |
### Return type
[**models::GetIdentityProviderConfigResponse**](GetIdentityProviderConfigResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_interactive_submission_preferred_package_version
> models::GetPreferredPackageVersionResponse get_v2_interactive_submission_preferred_package_version(package_name, parties, vetting_valid_at, synchronizer_id)
A preferred package is the highest-versioned package for a provided package-name that is vetted by all the participants hosting the provided parties. Ledger API clients should use this endpoint for constructing command submissions that are compatible with the provided preferred package, by making informed decisions on: - which are the compatible packages that can be used to create contracts - which contract or exercise choice argument version can be used in the command - which choices can be executed on a template or interface of a contract Can be accessed by any Ledger API client with a valid token when Ledger API authorization is enabled. Provided for backwards compatibility, it will be removed in the Canton version 3.4.0
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**package_name** | **String** | | [required] |
**parties** | Option<[**Vec<String>**](String.md)> | | |
**vetting_valid_at** | Option<**chrono::DateTime<chrono::FixedOffset>**> | | |
**synchronizer_id** | Option<**String**> | | |
### Return type
[**models::GetPreferredPackageVersionResponse**](GetPreferredPackageVersionResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_package_vetting
> models::ListVettedPackagesResponse get_v2_package_vetting(list_vetted_packages_request)
Lists which participant node vetted what packages on which synchronizer. This endpoint (GET /package-vetting) is deprecated and will be removed in a future release. Please use POST /package-vetting/list instead.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**list_vetted_packages_request** | [**ListVettedPackagesRequest**](ListVettedPackagesRequest.md) | | [required] |
### Return type
[**models::ListVettedPackagesResponse**](ListVettedPackagesResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_packages
> models::ListPackagesResponse get_v2_packages()
Returns the identifiers of all supported packages.
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::ListPackagesResponse**](ListPackagesResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_packages_package_id
> std::path::PathBuf get_v2_packages_package_id(package_id)
Returns the contents of a single package.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**package_id** | **String** | | [required] |
### Return type
[**std::path::PathBuf**](std::path::PathBuf.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/octet-stream, text/plain, application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_packages_package_id_status
> models::GetPackageStatusResponse get_v2_packages_package_id_status(package_id)
Returns the status of a single package.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**package_id** | **String** | | [required] |
### Return type
[**models::GetPackageStatusResponse**](GetPackageStatusResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_parties
> models::ListKnownPartiesResponse get_v2_parties(identity_provider_id, filter_party, page_size, page_token)
List the parties known by the participant. The list returned contains parties whose ledger access is facilitated by the participant and the ones maintained elsewhere.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**identity_provider_id** | Option<**String**> | | |
**filter_party** | Option<**String**> | | |
**page_size** | Option<**i32**> | maximum number of elements in a returned page | |
**page_token** | Option<**String**> | token - to continue results from a given page, leave empty to start from the beginning of the list, obtain token from the result of previous page | |
### Return type
[**models::ListKnownPartiesResponse**](ListKnownPartiesResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_parties_participant_id
> models::GetParticipantIdResponse get_v2_parties_participant_id()
Return the identifier of the participant. All horizontally scaled replicas should return the same id. daml-on-kv-ledger: returns an identifier supplied on command line at launch time canton: returns globally unique identifier of the participant
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::GetParticipantIdResponse**](GetParticipantIdResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_parties_party
> models::GetPartiesResponse get_v2_parties_party(party, identity_provider_id, parties)
Get the party details of the given parties. Only known parties will be returned in the list.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**party** | **String** | | [required] |
**identity_provider_id** | Option<**String**> | | |
**parties** | Option<[**Vec<String>**](String.md)> | | |
### Return type
[**models::GetPartiesResponse**](GetPartiesResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_state_active_contracts_page
> models::JsGetActiveContractsPageResponse get_v2_state_active_contracts_page(get_active_contracts_page_request)
Returns a page of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once all pages are fetched by repeated calls to ``GetActiveContractsPage``, the client SHOULD begin retrieving updates from the update service, starting at the ``GetActiveContractsPageResponse``.``active_at_offset`` specified in this request. Clients SHOULD NOT assume that the set of active contracts they receive reflects the state at the ledger end.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_active_contracts_page_request** | [**GetActiveContractsPageRequest**](GetActiveContractsPageRequest.md) | | [required] |
### Return type
[**models::JsGetActiveContractsPageResponse**](JsGetActiveContractsPageResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_state_connected_synchronizers
> models::GetConnectedSynchronizersResponse get_v2_state_connected_synchronizers(party, participant_id, identity_provider_id)
Get the list of connected synchronizers at the time of the query.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**party** | Option<**String**> | | |
**participant_id** | Option<**String**> | | |
**identity_provider_id** | Option<**String**> | | |
### Return type
[**models::GetConnectedSynchronizersResponse**](GetConnectedSynchronizersResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_state_latest_pruned_offsets
> models::GetLatestPrunedOffsetsResponse get_v2_state_latest_pruned_offsets()
Get the latest successfully pruned ledger offsets
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::GetLatestPrunedOffsetsResponse**](GetLatestPrunedOffsetsResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_state_ledger_end
> models::GetLedgerEndResponse get_v2_state_ledger_end()
Get the current ledger end. Subscriptions started with the returned offset will serve events after this RPC was called.
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::GetLedgerEndResponse**](GetLedgerEndResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_updates_transaction_tree_by_id_update_id
> models::JsGetTransactionTreeResponse get_v2_updates_transaction_tree_by_id_update_id(update_id, parties)
Get transaction tree by id. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates/update-by-id instead.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**update_id** | **String** | | [required] |
**parties** | Option<[**Vec<String>**](String.md)> | | |
### Return type
[**models::JsGetTransactionTreeResponse**](JsGetTransactionTreeResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_updates_transaction_tree_by_offset_offset
> models::JsGetTransactionTreeResponse get_v2_updates_transaction_tree_by_offset_offset(offset, parties)
Get transaction tree by offset. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates/update-by-offset instead.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**offset** | **i64** | | [required] |
**parties** | Option<[**Vec<String>**](String.md)> | | |
### Return type
[**models::JsGetTransactionTreeResponse**](JsGetTransactionTreeResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_users
> models::ListUsersResponse get_v2_users(page_size, page_token)
List all existing users.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page_size** | Option<**i32**> | maximum number of elements in a returned page | |
**page_token** | Option<**String**> | token - to continue results from a given page, leave empty to start from the beginning of the list, obtain token from the result of previous page | |
### Return type
[**models::ListUsersResponse**](ListUsersResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_users_user_id
> models::GetUserResponse get_v2_users_user_id(user_id, identity_provider_id)
Get the user data of a specific user or the authenticated user.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**identity_provider_id** | Option<**String**> | | |
### Return type
[**models::GetUserResponse**](GetUserResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_users_user_id_rights
> models::ListUserRightsResponse get_v2_users_user_id_rights(user_id)
List the set of all rights granted to a user.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
### Return type
[**models::ListUserRightsResponse**](ListUserRightsResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_v2_version
> models::GetLedgerApiVersionResponse get_v2_version()
Read the Ledger API version
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::GetLedgerApiVersionResponse**](GetLedgerApiVersionResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## patch_v2_idps_idp_id
> models::UpdateIdentityProviderConfigResponse patch_v2_idps_idp_id(idp_id, update_identity_provider_config_request)
Update selected modifiable attribute of an identity provider config resource described by the ``IdentityProviderConfig`` message.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**idp_id** | **String** | | [required] |
**update_identity_provider_config_request** | [**UpdateIdentityProviderConfigRequest**](UpdateIdentityProviderConfigRequest.md) | | [required] |
### Return type
[**models::UpdateIdentityProviderConfigResponse**](UpdateIdentityProviderConfigResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## patch_v2_parties_party
> models::UpdatePartyDetailsResponse patch_v2_parties_party(party, update_party_details_request)
Update selected modifiable participant-local attributes of a party details resource. Can update the participant's local information for local parties.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**party** | **String** | | [required] |
**update_party_details_request** | [**UpdatePartyDetailsRequest**](UpdatePartyDetailsRequest.md) | | [required] |
### Return type
[**models::UpdatePartyDetailsResponse**](UpdatePartyDetailsResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## patch_v2_users_user_id
> models::UpdateUserResponse patch_v2_users_user_id(user_id, update_user_request)
Update selected modifiable attribute of a user resource described by the ``User`` message.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**update_user_request** | [**UpdateUserRequest**](UpdateUserRequest.md) | | [required] |
### Return type
[**models::UpdateUserResponse**](UpdateUserResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## patch_v2_users_user_id_identity_provider_id
> serde_json::Value patch_v2_users_user_id_identity_provider_id(user_id, update_user_identity_provider_id_request)
Update the assignment of a user from one IDP to another.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**update_user_identity_provider_id_request** | [**UpdateUserIdentityProviderIdRequest**](UpdateUserIdentityProviderIdRequest.md) | | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## patch_v2_users_user_id_rights
> models::RevokeUserRightsResponse patch_v2_users_user_id_rights(user_id, revoke_user_rights_request)
Revoke rights from a user. Revoking rights does not affect the resource version of the corresponding user.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**revoke_user_rights_request** | [**RevokeUserRightsRequest**](RevokeUserRightsRequest.md) | | [required] |
### Return type
[**models::RevokeUserRightsResponse**](RevokeUserRightsResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_commands_async_submit
> serde_json::Value post_v2_commands_async_submit(js_commands)
Submit a single composite command.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**js_commands** | [**JsCommands**](JsCommands.md) | | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_commands_async_submit_reassignment
> serde_json::Value post_v2_commands_async_submit_reassignment(submit_reassignment_request)
Submit a single reassignment.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**submit_reassignment_request** | [**SubmitReassignmentRequest**](SubmitReassignmentRequest.md) | | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_commands_completions
> Vec<models::CompletionStreamResponse> post_v2_commands_completions(completion_stream_request, limit, stream_idle_timeout_ms)
Query completions list (blocking call) Subscribe to command completion events. Notice: This endpoint should be used for small results set. When number of results exceeded node configuration limit (`http-list-max-elements-limit`) there will be an error (`413 Content Too Large`) returned. Increasing this limit may lead to performance issues and high memory consumption. Consider using websockets (asyncapi) for better efficiency with larger results.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**completion_stream_request** | [**CompletionStreamRequest**](CompletionStreamRequest.md) | | [required] |
**limit** | Option<**i64**> | maximum number of elements to return, this param is ignored if is bigger than server setting | |
**stream_idle_timeout_ms** | Option<**i64**> | timeout to complete and send result if no new elements are received (for open ended streams) | |
### Return type
[**Vec<models::CompletionStreamResponse>**](CompletionStreamResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_commands_submit_and_wait
> models::SubmitAndWaitResponse post_v2_commands_submit_and_wait(js_commands)
Submits a single composite command and waits for its result. Propagates the gRPC error of failed submissions including Daml interpretation errors.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**js_commands** | [**JsCommands**](JsCommands.md) | | [required] |
### Return type
[**models::SubmitAndWaitResponse**](SubmitAndWaitResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_commands_submit_and_wait_for_reassignment
> models::JsSubmitAndWaitForReassignmentResponse post_v2_commands_submit_and_wait_for_reassignment(submit_and_wait_for_reassignment_request)
Submits a single composite reassignment command, waits for its result, and returns the reassignment. Propagates the gRPC error of failed submission.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**submit_and_wait_for_reassignment_request** | [**SubmitAndWaitForReassignmentRequest**](SubmitAndWaitForReassignmentRequest.md) | | [required] |
### Return type
[**models::JsSubmitAndWaitForReassignmentResponse**](JsSubmitAndWaitForReassignmentResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_commands_submit_and_wait_for_transaction
> models::JsSubmitAndWaitForTransactionResponse post_v2_commands_submit_and_wait_for_transaction(js_submit_and_wait_for_transaction_request)
Submits a single composite command, waits for its result, and returns the transaction. Propagates the gRPC error of failed submissions including Daml interpretation errors.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**js_submit_and_wait_for_transaction_request** | [**JsSubmitAndWaitForTransactionRequest**](JsSubmitAndWaitForTransactionRequest.md) | | [required] |
### Return type
[**models::JsSubmitAndWaitForTransactionResponse**](JsSubmitAndWaitForTransactionResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_commands_submit_and_wait_for_transaction_tree
> models::JsSubmitAndWaitForTransactionTreeResponse post_v2_commands_submit_and_wait_for_transaction_tree(js_commands)
Submit a batch of commands and wait for the transaction trees response. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use submit-and-wait-for-transaction instead.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**js_commands** | [**JsCommands**](JsCommands.md) | | [required] |
### Return type
[**models::JsSubmitAndWaitForTransactionTreeResponse**](JsSubmitAndWaitForTransactionTreeResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_contracts_contract_by_id
> models::GetContractResponse post_v2_contracts_contract_by_id(get_contract_request)
Looking up contract data by contract ID. This endpoint is experimental / alpha, therefore no backwards compatibility is guaranteed. This endpoint must not be used to look up contracts which entered the participant via party replication or repair service.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_contract_request** | [**GetContractRequest**](GetContractRequest.md) | | [required] |
### Return type
[**models::GetContractResponse**](GetContractResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_dars
> serde_json::Value post_v2_dars(body, vet_all_packages, synchronizer_id)
Upload a DAR to the participant node
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | **std::path::PathBuf** | | [required] |
**vet_all_packages** | Option<**bool**> | | |
**synchronizer_id** | Option<**String**> | | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/octet-stream
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_dars_validate
> post_v2_dars_validate(body, synchronizer_id)
Validates the DAR and checks the upgrade compatibility of the DAR's packages with the set of the already vetted packages on the target vetting synchronizer. See ValidateDarFileRequest for details regarding the target vetting synchronizer. The operation has no effect on the state of the participant or the Canton ledger: the DAR payload and its packages are not persisted neither are the packages vetted.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | **std::path::PathBuf** | | [required] |
**synchronizer_id** | Option<**String**> | | |
### Return type
(empty response body)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/octet-stream
- **Accept**: text/plain, application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_events_events_by_contract_id
> models::JsGetEventsByContractIdResponse post_v2_events_events_by_contract_id(get_events_by_contract_id_request)
Get the create and the consuming exercise event for the contract with the provided ID. No events will be returned for contracts that have been pruned because they have already been archived before the latest pruning offset. If the contract cannot be found for the request, or all the contract-events are filtered, a CONTRACT_EVENTS_NOT_FOUND error will be raised.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_events_by_contract_id_request** | [**GetEventsByContractIdRequest**](GetEventsByContractIdRequest.md) | | [required] |
### Return type
[**models::JsGetEventsByContractIdResponse**](JsGetEventsByContractIdResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_idps
> models::CreateIdentityProviderConfigResponse post_v2_idps(create_identity_provider_config_request)
Create a new identity provider configuration. The request will fail if the maximum allowed number of separate configurations is reached.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_identity_provider_config_request** | [**CreateIdentityProviderConfigRequest**](CreateIdentityProviderConfigRequest.md) | | [required] |
### Return type
[**models::CreateIdentityProviderConfigResponse**](CreateIdentityProviderConfigResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_interactive_submission_execute
> serde_json::Value post_v2_interactive_submission_execute(js_execute_submission_request)
Execute a prepared submission _asynchronously_ on the ledger. Requires a signature of the transaction from the submitting external party.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**js_execute_submission_request** | [**JsExecuteSubmissionRequest**](JsExecuteSubmissionRequest.md) | | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_interactive_submission_executeandwait
> models::ExecuteSubmissionAndWaitResponse post_v2_interactive_submission_executeandwait(js_execute_submission_and_wait_request)
Similar to ExecuteSubmission but _synchronously_ wait for the completion of the transaction IMPORTANT: Relying on the response from this endpoint requires trusting the Participant Node to be honest. A malicious node could make a successfully committed request appeared failed and vice versa
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**js_execute_submission_and_wait_request** | [**JsExecuteSubmissionAndWaitRequest**](JsExecuteSubmissionAndWaitRequest.md) | | [required] |
### Return type
[**models::ExecuteSubmissionAndWaitResponse**](ExecuteSubmissionAndWaitResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_interactive_submission_executeandwaitfortransaction
> models::JsExecuteSubmissionAndWaitForTransactionResponse post_v2_interactive_submission_executeandwaitfortransaction(js_execute_submission_and_wait_for_transaction_request)
Similar to ExecuteSubmissionAndWait but additionally returns the transaction IMPORTANT: Relying on the response from this endpoint requires trusting the Participant Node to be honest. A malicious node could make a successfully committed request appear as failed and vice versa
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**js_execute_submission_and_wait_for_transaction_request** | [**JsExecuteSubmissionAndWaitForTransactionRequest**](JsExecuteSubmissionAndWaitForTransactionRequest.md) | | [required] |
### Return type
[**models::JsExecuteSubmissionAndWaitForTransactionResponse**](JsExecuteSubmissionAndWaitForTransactionResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_interactive_submission_preferred_packages
> models::GetPreferredPackagesResponse post_v2_interactive_submission_preferred_packages(get_preferred_packages_request)
Compute the preferred packages for the vetting requirements in the request. A preferred package is the highest-versioned package for a provided package-name that is vetted by all the participants hosting the provided parties. Ledger API clients should use this endpoint for constructing command submissions that are compatible with the provided preferred packages, by making informed decisions on: - which are the compatible packages that can be used to create contracts - which contract or exercise choice argument version can be used in the command - which choices can be executed on a template or interface of a contract If the package preferences could not be computed due to no selection satisfying the requirements, a `FAILED_PRECONDITION` error will be returned. Can be accessed by any Ledger API client with a valid token when Ledger API authorization is enabled. Experimental API: this endpoint is not guaranteed to provide backwards compatibility in future releases
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_preferred_packages_request** | [**GetPreferredPackagesRequest**](GetPreferredPackagesRequest.md) | | [required] |
### Return type
[**models::GetPreferredPackagesResponse**](GetPreferredPackagesResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_interactive_submission_prepare
> models::JsPrepareSubmissionResponse post_v2_interactive_submission_prepare(js_prepare_submission_request)
Requires `readAs` scope for the submitting party when LAPI User authorization is enabled
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**js_prepare_submission_request** | [**JsPrepareSubmissionRequest**](JsPrepareSubmissionRequest.md) | | [required] |
### Return type
[**models::JsPrepareSubmissionResponse**](JsPrepareSubmissionResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_package_vetting
> models::UpdateVettedPackagesResponse post_v2_package_vetting(update_vetted_packages_request)
Update the vetted packages of this participant This endpoint (POST /package-vetting) is deprecated and will be removed in a future release. Please use POST /package-vetting/update instead.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**update_vetted_packages_request** | [**UpdateVettedPackagesRequest**](UpdateVettedPackagesRequest.md) | | [required] |
### Return type
[**models::UpdateVettedPackagesResponse**](UpdateVettedPackagesResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_package_vetting_list
> models::ListVettedPackagesResponse post_v2_package_vetting_list(list_vetted_packages_request)
Lists which participant node vetted what packages on which synchronizer. Can be called by any authenticated user.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**list_vetted_packages_request** | [**ListVettedPackagesRequest**](ListVettedPackagesRequest.md) | | [required] |
### Return type
[**models::ListVettedPackagesResponse**](ListVettedPackagesResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_package_vetting_update
> models::UpdateVettedPackagesResponse post_v2_package_vetting_update(update_vetted_packages_request)
Update the vetted packages of this participant
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**update_vetted_packages_request** | [**UpdateVettedPackagesRequest**](UpdateVettedPackagesRequest.md) | | [required] |
### Return type
[**models::UpdateVettedPackagesResponse**](UpdateVettedPackagesResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_packages
> serde_json::Value post_v2_packages(body, vet_all_packages, synchronizer_id)
Behaves the same as /dars. This endpoint will be deprecated and removed in a future release. Upload a DAR file to the participant. If vetting is enabled in the request, the DAR is checked for upgrade compatibility with the set of the already vetted packages on the target vetting synchronizer See UploadDarFileRequest for details regarding vetting and the target vetting synchronizer.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | **std::path::PathBuf** | | [required] |
**vet_all_packages** | Option<**bool**> | | |
**synchronizer_id** | Option<**String**> | | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/octet-stream
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_parties
> models::AllocatePartyResponse post_v2_parties(allocate_party_request)
Allocates a new party on a ledger and adds it to the set managed by the participant. Caller specifies a party identifier suggestion, the actual identifier allocated might be different and is implementation specific. Caller can specify party metadata that is stored locally on the participant. This call may: - Succeed, in which case the actual allocated identifier is visible in the response. - Respond with a gRPC error daml-on-kv-ledger: suggestion's uniqueness is checked by the validators in the consensus layer and call rejected if the identifier is already present. canton: completely different globally unique identifier is allocated. Behind the scenes calls to an internal protocol are made. As that protocol is richer than the surface protocol, the arguments take implicit values The party identifier suggestion must be a valid party name. Party names are required to be non-empty US-ASCII strings built from letters, digits, space, colon, minus and underscore limited to 255 chars
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**allocate_party_request** | [**AllocatePartyRequest**](AllocatePartyRequest.md) | | [required] |
### Return type
[**models::AllocatePartyResponse**](AllocatePartyResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_parties_external_allocate
> models::AllocateExternalPartyResponse post_v2_parties_external_allocate(allocate_external_party_request)
Alpha 3.3: Endpoint to allocate a new external party on a synchronizer Expected to be stable in 3.5 The external party must be hosted (at least) on this node with either confirmation or observation permissions It can optionally be hosted on other nodes (then called a multi-hosted party). If hosted on additional nodes, explicit authorization of the hosting relationship must be performed on those nodes before the party can be used. Decentralized namespaces are supported but must be provided fully authorized by their owners. The individual owner namespace transactions can be submitted in the same call (fully authorized as well). In the simple case of a non-multi hosted, non-decentralized party, the RPC will return once the party is effectively allocated and ready to use, similarly to the AllocateParty behavior. For more complex scenarios applications may need to query the party status explicitly (only through the admin API as of now).
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**allocate_external_party_request** | [**AllocateExternalPartyRequest**](AllocateExternalPartyRequest.md) | | [required] |
### Return type
[**models::AllocateExternalPartyResponse**](AllocateExternalPartyResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_parties_external_generate_topology
> models::GenerateExternalPartyTopologyResponse post_v2_parties_external_generate_topology(generate_external_party_topology_request)
Alpha 3.3: Convenience endpoint to generate topology transactions for external signing Expected to be stable in 3.5 You may use this endpoint to generate the common external topology transactions which can be signed externally and uploaded as part of the allocate party process Note that this request will create a normal namespace using the same key for the identity as for signing. More elaborate schemes such as multi-signature or decentralized parties require you to construct the topology transactions yourself.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**generate_external_party_topology_request** | [**GenerateExternalPartyTopologyRequest**](GenerateExternalPartyTopologyRequest.md) | | [required] |
### Return type
[**models::GenerateExternalPartyTopologyResponse**](GenerateExternalPartyTopologyResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_state_active_contracts
> Vec<models::JsGetActiveContractsResponse> post_v2_state_active_contracts(get_active_contracts_request, limit, stream_idle_timeout_ms)
Query active contracts list (blocking call). Querying active contracts is an expensive operation and if possible should not be repeated often. Consider querying active contracts initially (for a given offset) and then repeatedly call one of `/v2/updates/...`endpoints to get subsequent modifications. You can also use websockets to get updates with better performance. Returns a stream of the snapshot of the active contracts and incomplete (un)assignments at a ledger offset. Once the stream of GetActiveContractsResponses completes, the client SHOULD begin streaming updates from the update service, starting at the GetActiveContractsRequest.active_at_offset specified in this request. Clients SHOULD NOT assume that the set of active contracts they receive reflects the state at the ledger end. Notice: This endpoint should be used for small results set. When number of results exceeded node configuration limit (`http-list-max-elements-limit`) there will be an error (`413 Content Too Large`) returned. Increasing this limit may lead to performance issues and high memory consumption. Consider using websockets (asyncapi) for better efficiency with larger results.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_active_contracts_request** | [**GetActiveContractsRequest**](GetActiveContractsRequest.md) | | [required] |
**limit** | Option<**i64**> | maximum number of elements to return, this param is ignored if is bigger than server setting | |
**stream_idle_timeout_ms** | Option<**i64**> | timeout to complete and send result if no new elements are received (for open ended streams) | |
### Return type
[**Vec<models::JsGetActiveContractsResponse>**](JsGetActiveContractsResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_updates
> Vec<models::JsGetUpdatesResponse> post_v2_updates(get_updates_request, limit, stream_idle_timeout_ms)
Read the ledger's filtered update stream for the specified contents and filters. It returns the event types in accordance with the stream contents selected. Also the selection criteria for individual events depends on the transaction shape chosen. - ACS delta: a requesting party must be a stakeholder of an event for it to be included. - ledger effects: a requesting party must be a witness of an event for it to be included. Notice: This endpoint should be used for small results set. When number of results exceeded node configuration limit (`http-list-max-elements-limit`) there will be an error (`413 Content Too Large`) returned. Increasing this limit may lead to performance issues and high memory consumption. Consider using websockets (asyncapi) for better efficiency with larger results.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_updates_request** | [**GetUpdatesRequest**](GetUpdatesRequest.md) | | [required] |
**limit** | Option<**i64**> | maximum number of elements to return, this param is ignored if is bigger than server setting | |
**stream_idle_timeout_ms** | Option<**i64**> | timeout to complete and send result if no new elements are received (for open ended streams) | |
### Return type
[**Vec<models::JsGetUpdatesResponse>**](JsGetUpdatesResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_updates_flats
> Vec<models::JsGetUpdatesResponse> post_v2_updates_flats(get_updates_request, limit, stream_idle_timeout_ms)
Query flat transactions update list (blocking call). Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. Notice: This endpoint should be used for small results set. When number of results exceeded node configuration limit (`http-list-max-elements-limit`) there will be an error (`413 Content Too Large`) returned. Increasing this limit may lead to performance issues and high memory consumption. Consider using websockets (asyncapi) for better efficiency with larger results.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_updates_request** | [**GetUpdatesRequest**](GetUpdatesRequest.md) | | [required] |
**limit** | Option<**i64**> | maximum number of elements to return, this param is ignored if is bigger than server setting | |
**stream_idle_timeout_ms** | Option<**i64**> | timeout to complete and send result if no new elements are received (for open ended streams) | |
### Return type
[**Vec<models::JsGetUpdatesResponse>**](JsGetUpdatesResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_updates_get_updates_page
> models::JsGetUpdatesPageResponse post_v2_updates_get_updates_page(get_updates_page_request)
Read a page of ledger's filtered updates. It returns the event types in accordance with the specified contents and filters. Additionally, the selection criteria for individual events depends on the transaction shape chosen. - ACS delta: an event is included only if the requesting party is a stakeholder. - ledger effects: an event is included if the requesting party is a witness.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_updates_page_request** | [**GetUpdatesPageRequest**](GetUpdatesPageRequest.md) | | [required] |
### Return type
[**models::JsGetUpdatesPageResponse**](JsGetUpdatesPageResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_updates_transaction_by_id
> models::JsGetTransactionResponse post_v2_updates_transaction_by_id(get_transaction_by_id_request)
Get transaction by id. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates/update-by-id instead.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_transaction_by_id_request** | [**GetTransactionByIdRequest**](GetTransactionByIdRequest.md) | | [required] |
### Return type
[**models::JsGetTransactionResponse**](JsGetTransactionResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_updates_transaction_by_offset
> models::JsGetTransactionResponse post_v2_updates_transaction_by_offset(get_transaction_by_offset_request)
Get transaction by offset. Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates/update-by-offset instead.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_transaction_by_offset_request** | [**GetTransactionByOffsetRequest**](GetTransactionByOffsetRequest.md) | | [required] |
### Return type
[**models::JsGetTransactionResponse**](JsGetTransactionResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_updates_trees
> Vec<models::JsGetUpdateTreesResponse> post_v2_updates_trees(get_updates_request, limit, stream_idle_timeout_ms)
Query update transactions tree list (blocking call). Provided for backwards compatibility, it will be removed in the Canton version 3.5.0, use v2/updates instead. Notice: This endpoint should be used for small results set. When number of results exceeded node configuration limit (`http-list-max-elements-limit`) there will be an error (`413 Content Too Large`) returned. Increasing this limit may lead to performance issues and high memory consumption. Consider using websockets (asyncapi) for better efficiency with larger results.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_updates_request** | [**GetUpdatesRequest**](GetUpdatesRequest.md) | | [required] |
**limit** | Option<**i64**> | maximum number of elements to return, this param is ignored if is bigger than server setting | |
**stream_idle_timeout_ms** | Option<**i64**> | timeout to complete and send result if no new elements are received (for open ended streams) | |
### Return type
[**Vec<models::JsGetUpdateTreesResponse>**](JsGetUpdateTreesResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_updates_update_by_id
> models::JsGetUpdateResponse post_v2_updates_update_by_id(get_update_by_id_request)
Lookup an update by its ID. If there is no update with this ID, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_update_by_id_request** | [**GetUpdateByIdRequest**](GetUpdateByIdRequest.md) | | [required] |
### Return type
[**models::JsGetUpdateResponse**](JsGetUpdateResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_updates_update_by_offset
> models::JsGetUpdateResponse post_v2_updates_update_by_offset(get_update_by_offset_request)
Lookup an update by its offset. If there is no update with this offset, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_update_by_offset_request** | [**GetUpdateByOffsetRequest**](GetUpdateByOffsetRequest.md) | | [required] |
### Return type
[**models::JsGetUpdateResponse**](JsGetUpdateResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_users
> models::CreateUserResponse post_v2_users(create_user_request)
Create a new user.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_user_request** | [**CreateUserRequest**](CreateUserRequest.md) | | [required] |
### Return type
[**models::CreateUserResponse**](CreateUserResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_v2_users_user_id_rights
> models::GrantUserRightsResponse post_v2_users_user_id_rights(user_id, grant_user_rights_request)
Grant rights to a user. Granting rights does not affect the resource version of the corresponding user.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | | [required] |
**grant_user_rights_request** | [**GrantUserRightsRequest**](GrantUserRightsRequest.md) | | [required] |
### Return type
[**models::GrantUserRightsResponse**](GrantUserRightsResponse.md)
### Authorization
[httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)