diff --git a/aries_cloudcontroller/api/action_menu_api.py b/aries_cloudcontroller/api/action_menu_api.py index 93abd4ff..d9c88fe7 100644 --- a/aries_cloudcontroller/api/action_menu_api.py +++ b/aries_cloudcontroller/api/action_menu_api.py @@ -179,7 +179,7 @@ def _close_active_menu_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -356,7 +356,7 @@ def _fetch_active_menu_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -546,7 +546,7 @@ def _perform_action_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -735,7 +735,7 @@ def _request_active_menu_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -925,7 +925,7 @@ def _send_menu_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/basicmessage_api.py b/aries_cloudcontroller/api/basicmessage_api.py index 43fa9723..b04ae066 100644 --- a/aries_cloudcontroller/api/basicmessage_api.py +++ b/aries_cloudcontroller/api/basicmessage_api.py @@ -190,7 +190,7 @@ def _send_message_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/connection_api.py b/aries_cloudcontroller/api/connection_api.py index 6c72d62c..e8ab5673 100644 --- a/aries_cloudcontroller/api/connection_api.py +++ b/aries_cloudcontroller/api/connection_api.py @@ -257,7 +257,7 @@ def _accept_invitation_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -468,7 +468,7 @@ def _accept_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -728,7 +728,7 @@ def _create_invitation_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -931,7 +931,7 @@ def _create_static_connection_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1118,7 +1118,7 @@ def _delete_connection_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1295,7 +1295,7 @@ def _get_connection_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1472,7 +1472,7 @@ def _get_connection_endpoint_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1813,7 +1813,7 @@ def _get_connections_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2043,7 +2043,7 @@ def _get_metadata_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2281,7 +2281,7 @@ def _receive_invitation_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2493,7 +2493,7 @@ def _set_metadata_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/credential_definition_api.py b/aries_cloudcontroller/api/credential_definition_api.py index 63649144..754283e2 100644 --- a/aries_cloudcontroller/api/credential_definition_api.py +++ b/aries_cloudcontroller/api/credential_definition_api.py @@ -194,7 +194,7 @@ def _credential_definitions_cred_def_id_write_record_post_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -487,7 +487,7 @@ def _get_created_cred_defs_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -692,7 +692,7 @@ def _get_cred_def_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -910,7 +910,7 @@ def _publish_cred_def_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/credentials_api.py b/aries_cloudcontroller/api/credentials_api.py index 32515fba..6cb5ad62 100644 --- a/aries_cloudcontroller/api/credentials_api.py +++ b/aries_cloudcontroller/api/credentials_api.py @@ -187,7 +187,7 @@ def _delete_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -364,7 +364,7 @@ def _delete_w3c_credential_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -541,7 +541,7 @@ def _get_credential_mime_types_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -718,7 +718,7 @@ def _get_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -948,7 +948,7 @@ def _get_records_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1185,7 +1185,7 @@ def _get_revocation_status_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1370,7 +1370,7 @@ def _get_w3c_credential_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1613,7 +1613,7 @@ def _get_w3c_credentials_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/default_api.py b/aries_cloudcontroller/api/default_api.py index b1873229..7b722a08 100644 --- a/aries_cloudcontroller/api/default_api.py +++ b/aries_cloudcontroller/api/default_api.py @@ -157,7 +157,7 @@ def _establish_inbound_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -308,7 +308,7 @@ def _get_features_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/did_exchange_api.py b/aries_cloudcontroller/api/did_exchange_api.py index 99ca8335..ced1c547 100644 --- a/aries_cloudcontroller/api/did_exchange_api.py +++ b/aries_cloudcontroller/api/did_exchange_api.py @@ -220,7 +220,7 @@ def _accept_invitation_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -471,7 +471,7 @@ def _accept_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -838,7 +838,7 @@ def _create_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1058,7 +1058,7 @@ def _didexchange_conn_id_reject_post_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1332,7 +1332,7 @@ def _receive_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/discover_features_api.py b/aries_cloudcontroller/api/discover_features_api.py index 66955fc5..9bbfff50 100644 --- a/aries_cloudcontroller/api/discover_features_api.py +++ b/aries_cloudcontroller/api/discover_features_api.py @@ -227,7 +227,7 @@ def _discover_features_query_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -420,7 +420,7 @@ def _discover_features_records_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/discover_features_v20_api.py b/aries_cloudcontroller/api/discover_features_v20_api.py index 176a5a54..a16d680f 100644 --- a/aries_cloudcontroller/api/discover_features_v20_api.py +++ b/aries_cloudcontroller/api/discover_features_v20_api.py @@ -235,7 +235,7 @@ def _discover_features20_queries_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -428,7 +428,7 @@ def _discover_features20_records_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/endorse_transaction_api.py b/aries_cloudcontroller/api/endorse_transaction_api.py index 6ef8fa36..65949c06 100644 --- a/aries_cloudcontroller/api/endorse_transaction_api.py +++ b/aries_cloudcontroller/api/endorse_transaction_api.py @@ -181,7 +181,7 @@ def _cancel_transaction_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -393,7 +393,7 @@ def _create_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -607,7 +607,7 @@ def _endorse_transaction_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -775,7 +775,7 @@ def _get_records_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -950,7 +950,7 @@ def _get_transaction_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1127,7 +1127,7 @@ def _refuse_transaction_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1304,7 +1304,7 @@ def _resend_transaction_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1513,7 +1513,7 @@ def _set_endorser_info_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1717,7 +1717,7 @@ def _set_endorser_role_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1898,7 +1898,7 @@ def _write_transaction_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/introduction_api.py b/aries_cloudcontroller/api/introduction_api.py index 6e455880..c43a4ab3 100644 --- a/aries_cloudcontroller/api/introduction_api.py +++ b/aries_cloudcontroller/api/introduction_api.py @@ -208,7 +208,7 @@ def _start_introduction_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/issue_credential_v10_api.py b/aries_cloudcontroller/api/issue_credential_v10_api.py index e0cc0e26..515dfa75 100644 --- a/aries_cloudcontroller/api/issue_credential_v10_api.py +++ b/aries_cloudcontroller/api/issue_credential_v10_api.py @@ -208,7 +208,7 @@ def _create_credential_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -395,7 +395,7 @@ def _create_offer_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -588,7 +588,7 @@ def _delete_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -771,7 +771,7 @@ def _get_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1014,7 +1014,7 @@ def _get_records_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1224,7 +1224,7 @@ def _issue_credential_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1413,7 +1413,7 @@ def _issue_credential_automated_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1619,7 +1619,7 @@ def _report_problem_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1827,7 +1827,7 @@ def _send_offer_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2016,7 +2016,7 @@ def _send_offer_free_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2203,7 +2203,7 @@ def _send_proposal_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2409,7 +2409,7 @@ def _send_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2617,7 +2617,7 @@ def _store_credential_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/issue_credential_v20_api.py b/aries_cloudcontroller/api/issue_credential_v20_api.py index 1456184d..4894adb4 100644 --- a/aries_cloudcontroller/api/issue_credential_v20_api.py +++ b/aries_cloudcontroller/api/issue_credential_v20_api.py @@ -199,7 +199,7 @@ def _create_credential_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -392,7 +392,7 @@ def _delete_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -575,7 +575,7 @@ def _get_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -818,7 +818,7 @@ def _get_records_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1028,7 +1028,7 @@ def _issue_credential_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1217,7 +1217,7 @@ def _issue_credential20_create_offer_post_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1404,7 +1404,7 @@ def _issue_credential_automated_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1610,7 +1610,7 @@ def _report_problem_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1818,7 +1818,7 @@ def _send_offer_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2007,7 +2007,7 @@ def _send_offer_free_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2194,7 +2194,7 @@ def _send_proposal_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2400,7 +2400,7 @@ def _send_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2589,7 +2589,7 @@ def _send_request_free_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2795,7 +2795,7 @@ def _store_credential_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/jsonld_api.py b/aries_cloudcontroller/api/jsonld_api.py index 91f73d81..4013aebf 100644 --- a/aries_cloudcontroller/api/jsonld_api.py +++ b/aries_cloudcontroller/api/jsonld_api.py @@ -180,7 +180,7 @@ def _sign_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -367,7 +367,7 @@ def _verify_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/ledger_api.py b/aries_cloudcontroller/api/ledger_api.py index 11454c03..46ba4caa 100644 --- a/aries_cloudcontroller/api/ledger_api.py +++ b/aries_cloudcontroller/api/ledger_api.py @@ -191,7 +191,7 @@ def _accept_taa_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -365,7 +365,7 @@ def _fetch_taa_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -562,7 +562,7 @@ def _get_did_endpoint_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -745,7 +745,7 @@ def _get_did_nym_role_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -924,7 +924,7 @@ def _get_did_verkey_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1090,7 +1090,7 @@ def _ledger_config_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1252,7 +1252,7 @@ def _ledger_get_write_ledger_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1414,7 +1414,7 @@ def _ledger_get_write_ledgers_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1589,7 +1589,7 @@ def _ledger_ledger_id_set_write_ledger_put_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1846,7 +1846,7 @@ def _register_nym_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2034,7 +2034,7 @@ def _rotate_public_did_keypair_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/mediation_api.py b/aries_cloudcontroller/api/mediation_api.py index 94da710c..8e3e85b4 100644 --- a/aries_cloudcontroller/api/mediation_api.py +++ b/aries_cloudcontroller/api/mediation_api.py @@ -175,7 +175,7 @@ def _clear_default_mediator_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -356,7 +356,7 @@ def _delete_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -552,7 +552,7 @@ def _deny_mediation_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -728,7 +728,7 @@ def _get_default_mediator_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -909,7 +909,7 @@ def _get_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1111,7 +1111,7 @@ def _get_records_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1300,7 +1300,7 @@ def _grant_mediation_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1490,7 +1490,7 @@ def _mediation_update_keylist_conn_id_post_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1692,7 +1692,7 @@ def _request_mediation_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1915,7 +1915,7 @@ def _retrieve_keylists_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2155,7 +2155,7 @@ def _send_keylist_query_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2371,7 +2371,7 @@ def _send_keylist_update_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2566,7 +2566,7 @@ def _set_default_mediator_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/multitenancy_api.py b/aries_cloudcontroller/api/multitenancy_api.py index 9eb623eb..1f4b6a16 100644 --- a/aries_cloudcontroller/api/multitenancy_api.py +++ b/aries_cloudcontroller/api/multitenancy_api.py @@ -189,7 +189,7 @@ def _create_wallet_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -389,7 +389,7 @@ def _delete_wallet_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -591,7 +591,7 @@ def _get_auth_token_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -780,7 +780,7 @@ def _get_wallet_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -963,7 +963,7 @@ def _get_wallets_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1170,7 +1170,7 @@ def _get_wallets_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1366,7 +1366,7 @@ def _update_wallet_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/out_of_band_api.py b/aries_cloudcontroller/api/out_of_band_api.py index 1d7ed896..2f0eb0ff 100644 --- a/aries_cloudcontroller/api/out_of_band_api.py +++ b/aries_cloudcontroller/api/out_of_band_api.py @@ -226,7 +226,7 @@ def _create_invitation_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -506,7 +506,7 @@ def _receive_invitation_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/present_proof_v10_api.py b/aries_cloudcontroller/api/present_proof_v10_api.py index 1baf69e7..b7a7cd11 100644 --- a/aries_cloudcontroller/api/present_proof_v10_api.py +++ b/aries_cloudcontroller/api/present_proof_v10_api.py @@ -201,7 +201,7 @@ def _create_proof_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -394,7 +394,7 @@ def _delete_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -665,7 +665,7 @@ def _get_matching_credentials_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -864,7 +864,7 @@ def _get_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1107,7 +1107,7 @@ def _get_records_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1317,7 +1317,7 @@ def _report_problem_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1525,7 +1525,7 @@ def _send_presentation_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1714,7 +1714,7 @@ def _send_proposal_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1920,7 +1920,7 @@ def _send_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2109,7 +2109,7 @@ def _send_request_free_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2302,7 +2302,7 @@ def _verify_presentation_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/present_proof_v20_api.py b/aries_cloudcontroller/api/present_proof_v20_api.py index 02ca9e82..9b412c90 100644 --- a/aries_cloudcontroller/api/present_proof_v20_api.py +++ b/aries_cloudcontroller/api/present_proof_v20_api.py @@ -197,7 +197,7 @@ def _create_proof_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -390,7 +390,7 @@ def _delete_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -661,7 +661,7 @@ def _get_matching_credentials_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -860,7 +860,7 @@ def _get_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1103,7 +1103,7 @@ def _get_records_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1313,7 +1313,7 @@ def _report_problem_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1521,7 +1521,7 @@ def _send_presentation_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1710,7 +1710,7 @@ def _send_proposal_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1916,7 +1916,7 @@ def _send_request_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2105,7 +2105,7 @@ def _send_request_free_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2298,7 +2298,7 @@ def _verify_presentation_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/resolver_api.py b/aries_cloudcontroller/api/resolver_api.py index f05f4aff..eb77b151 100644 --- a/aries_cloudcontroller/api/resolver_api.py +++ b/aries_cloudcontroller/api/resolver_api.py @@ -177,7 +177,7 @@ def _get_did_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/revocation_api.py b/aries_cloudcontroller/api/revocation_api.py index 38f06733..7f608b81 100644 --- a/aries_cloudcontroller/api/revocation_api.py +++ b/aries_cloudcontroller/api/revocation_api.py @@ -203,7 +203,7 @@ def _clear_pending_revocations_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -390,7 +390,7 @@ def _create_registry_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -583,7 +583,7 @@ def _download_tails_file_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -766,7 +766,7 @@ def _get_active_registry_for_cred_def_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -971,7 +971,7 @@ def _get_created_registries_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1160,7 +1160,7 @@ def _get_registry_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1343,7 +1343,7 @@ def _get_registry_issued_credentials_count_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1573,7 +1573,7 @@ def _get_revocation_status_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1807,7 +1807,7 @@ def _publish_rev_reg_def_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2041,7 +2041,7 @@ def _publish_rev_reg_entry_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2228,7 +2228,7 @@ def _publish_revocations_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2421,7 +2421,7 @@ def _revocation_active_registry_cred_def_id_rotate_post_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2629,7 +2629,7 @@ def _revocation_registry_delete_tails_file_delete_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2840,7 +2840,7 @@ def _revocation_registry_rev_reg_id_fix_revocation_entry_state_put_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -3027,7 +3027,7 @@ def _revocation_registry_rev_reg_id_issued_details_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -3210,7 +3210,7 @@ def _revocation_registry_rev_reg_id_issued_indy_recs_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -3387,7 +3387,7 @@ def _revoke_credential_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -3599,7 +3599,7 @@ def _set_registry_state_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -3799,7 +3799,7 @@ def _update_registry_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -3994,7 +3994,7 @@ def _upload_tails_file_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/schema_api.py b/aries_cloudcontroller/api/schema_api.py index 21635bcc..4b176948 100644 --- a/aries_cloudcontroller/api/schema_api.py +++ b/aries_cloudcontroller/api/schema_api.py @@ -252,7 +252,7 @@ def _get_created_schemas_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -443,7 +443,7 @@ def _get_schema_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -661,7 +661,7 @@ def _publish_schema_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -858,7 +858,7 @@ def _write_record_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/server_api.py b/aries_cloudcontroller/api/server_api.py index fc0f7270..a022e5cf 100644 --- a/aries_cloudcontroller/api/server_api.py +++ b/aries_cloudcontroller/api/server_api.py @@ -168,7 +168,7 @@ def _check_liveliness_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -330,7 +330,7 @@ def _get_config_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -492,7 +492,7 @@ def _get_plugins_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -654,7 +654,7 @@ def _get_ready_state_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -816,7 +816,7 @@ def _get_status_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -978,7 +978,7 @@ def _reset_statistics_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1140,7 +1140,7 @@ def _shutdown_server_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/settings_api.py b/aries_cloudcontroller/api/settings_api.py index 6c563ffd..15d120f8 100644 --- a/aries_cloudcontroller/api/settings_api.py +++ b/aries_cloudcontroller/api/settings_api.py @@ -165,7 +165,7 @@ def _settings_get_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -340,7 +340,7 @@ def _settings_put_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/trustping_api.py b/aries_cloudcontroller/api/trustping_api.py index c327a1e5..c15e957d 100644 --- a/aries_cloudcontroller/api/trustping_api.py +++ b/aries_cloudcontroller/api/trustping_api.py @@ -191,7 +191,7 @@ def _send_ping_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api/wallet_api.py b/aries_cloudcontroller/api/wallet_api.py index dc18a265..939b106a 100644 --- a/aries_cloudcontroller/api/wallet_api.py +++ b/aries_cloudcontroller/api/wallet_api.py @@ -187,7 +187,7 @@ def _create_did_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -374,7 +374,7 @@ def _get_did_endpoint_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -659,7 +659,7 @@ def _get_dids_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -841,7 +841,7 @@ def _get_public_did_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1016,7 +1016,7 @@ def _rotate_keypair_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1236,7 +1236,7 @@ def _set_did_endpoint_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1493,7 +1493,7 @@ def _set_public_did_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1686,7 +1686,7 @@ def _wallet_jwt_sign_post_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -1873,7 +1873,7 @@ def _wallet_jwt_verify_post_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2060,7 +2060,7 @@ def _wallet_sd_jwt_sign_post_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters @@ -2247,7 +2247,7 @@ def _wallet_sd_jwt_verify_post_serialize( _query_params: List[Tuple[str, str]] = [] _header_params: Dict[str, Optional[str]] = _headers or {} _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} + _files: Dict[str, Union[str, bytes]] = {} _body_params: Optional[bytes] = None # process the path parameters diff --git a/aries_cloudcontroller/api_client.py b/aries_cloudcontroller/api_client.py index 2d594c0b..206b046d 100644 --- a/aries_cloudcontroller/api_client.py +++ b/aries_cloudcontroller/api_client.py @@ -19,10 +19,11 @@ import re import tempfile from enum import Enum -from typing import Dict, List, Optional, Tuple +from typing import Dict, List, Optional, Tuple, Union from urllib.parse import quote from dateutil.parser import parse +from pydantic import SecretStr import aries_cloudcontroller.models from aries_cloudcontroller import rest @@ -192,7 +193,8 @@ def param_serialize( post_params = post_params if post_params else [] post_params = self.sanitize_for_serialization(post_params) post_params = self.parameters_to_tuples(post_params, collection_formats) - post_params.extend(self.files_parameters(files)) + if files: + post_params.extend(self.files_parameters(files)) # auth setting self.update_params_for_auth( @@ -301,7 +303,12 @@ def response_deserialize( match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type) encoding = match.group(1) if match else "utf-8" response_text = response_data.data.decode(encoding) - return_data = self.deserialize(response_text, response_type) + if response_type in ["bytearray", "str"]: + return_data = self.__deserialize_primitive( + response_text, response_type + ) + else: + return_data = self.deserialize(response_text, response_type) finally: if not 200 <= response_data.status <= 299: raise ApiException.from_response( @@ -321,6 +328,7 @@ def sanitize_for_serialization(self, obj): """Builds a JSON POST object. If obj is None, return None. + If obj is SecretStr, return obj.get_secret_value() If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date convert to string in iso8601 format. @@ -333,6 +341,10 @@ def sanitize_for_serialization(self, obj): """ if obj is None: return None + elif isinstance(obj, Enum): + return obj.value + elif isinstance(obj, SecretStr): + return obj.get_secret_value() elif isinstance(obj, self.PRIMITIVE_TYPES): return obj elif isinstance(obj, list): @@ -350,7 +362,10 @@ def sanitize_for_serialization(self, obj): # and attributes which value is not None. # Convert attribute name to json key in # model definition for request. - obj_dict = obj.to_dict() + if hasattr(obj, "to_dict") and callable(getattr(obj, "to_dict")): + obj_dict = obj.to_dict() + else: + obj_dict = obj.__dict__ return { key: self.sanitize_for_serialization(val) for key, val in obj_dict.items() @@ -485,29 +500,25 @@ def parameters_to_url_query(self, params, collection_formats): return "&".join(["=".join(map(str, item)) for item in new_params]) - def files_parameters(self, files=None): + def files_parameters(self, files: Dict[str, Union[str, bytes]]): """Builds form parameters. :param files: File parameters. :return: Form parameters with files. """ params = [] - - if files: - for k, v in files.items(): - if not v: - continue - file_names = v if type(v) is list else [v] - for n in file_names: - with open(n, "rb") as f: - filename = os.path.basename(f.name) - filedata = f.read() - mimetype = ( - mimetypes.guess_type(filename)[0] - or "application/octet-stream" - ) - params.append(tuple([k, tuple([filename, filedata, mimetype])])) - + for k, v in files.items(): + if isinstance(v, str): + with open(v, "rb") as f: + filename = os.path.basename(f.name) + filedata = f.read() + elif isinstance(v, bytes): + filename = k + filedata = v + else: + raise ValueError("Unsupported file value") + mimetype = mimetypes.guess_type(filename)[0] or "application/octet-stream" + params.append(tuple([k, tuple([filename, filedata, mimetype])])) return params def select_header_accept(self, accepts: List[str]) -> Optional[str]: diff --git a/generator/README.md b/generator/README.md index 56d697e7..6492b73c 100644 --- a/generator/README.md +++ b/generator/README.md @@ -12,7 +12,7 @@ git clone https://github.com/didx-xyz/openapi-generator # Build OpenAPI generator JAR cd openapi-generator -git checkout cloudcontroller/0.9.0 # A snapshot of the openapi-generator version used to generate cloudcontroller +git checkout v7.5.0 # A tag of the openapi-generator version used to generate cloudcontroller mvn -B --no-snapshot-updates clean package -DskipTests=true -Dmaven.javadoc.skip=true -Djacoco.skip=true ``` @@ -23,5 +23,5 @@ mvn -B --no-snapshot-updates clean package -DskipTests=true -Dmaven.javadoc.skip cd aries-cloudcontroller-python pip install -r requirements.txt -r requirements.dev.txt --upgrade -./generator/scripts/generate-client.sh 0.9.0 # Or other ACA-Py version +./generator/scripts/generate-client.sh 0.11.0 # Or other ACA-Py version ``` diff --git a/generator/data/openapi.yml b/generator/data/openapi.yml index c8cab795..ecab23a7 100644 --- a/generator/data/openapi.yml +++ b/generator/data/openapi.yml @@ -131,7 +131,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -151,7 +151,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -177,7 +177,7 @@ paths: $ref: '#/components/schemas/PerformRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -198,7 +198,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -224,7 +224,7 @@ paths: $ref: '#/components/schemas/SendMenu' required: false responses: - 200: + '200': description: '' content: application/json: @@ -276,14 +276,14 @@ paths: type: string enum: - invitation - - abandoned - - response - start - - error - init - - completed + - abandoned - active - request + - response + - completed + - error - name: their_did in: query description: Their DID @@ -307,7 +307,7 @@ paths: - inviter - responder responses: - 200: + '200': description: '' content: application/json: @@ -347,7 +347,7 @@ paths: $ref: '#/components/schemas/CreateInvitationRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -367,7 +367,7 @@ paths: $ref: '#/components/schemas/ConnectionStaticRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -404,7 +404,7 @@ paths: $ref: '#/components/schemas/ReceiveInvitationRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -425,7 +425,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -444,7 +444,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -481,7 +481,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -507,7 +507,7 @@ paths: pattern: ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -527,7 +527,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -552,7 +552,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -577,7 +577,7 @@ paths: $ref: '#/components/schemas/ConnectionMetadataSetRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -604,7 +604,7 @@ paths: $ref: '#/components/schemas/SendMessage' required: false responses: - 200: + '200': description: '' content: application/json: @@ -631,7 +631,7 @@ paths: $ref: '#/components/schemas/PingRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -663,7 +663,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -693,7 +693,7 @@ paths: $ref: '#/components/schemas/CredentialDefinitionSendRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -743,7 +743,7 @@ paths: pattern: ^[0-9.]+$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -764,7 +764,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -785,7 +785,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -804,7 +804,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -836,7 +836,7 @@ paths: pattern: ^[0-9]*$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -856,7 +856,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -875,7 +875,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -895,7 +895,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -914,7 +914,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -946,7 +946,7 @@ paths: pattern: ^{.*}$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -984,7 +984,7 @@ paths: $ref: '#/components/schemas/W3CCredentialsListRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1045,7 +1045,7 @@ paths: schema: type: boolean responses: - 200: + '200': description: '' content: application/json: @@ -1087,7 +1087,7 @@ paths: $ref: '#/components/schemas/DIDXRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1119,7 +1119,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -1156,7 +1156,7 @@ paths: schema: type: boolean responses: - 200: + '200': description: '' content: application/json: @@ -1182,7 +1182,7 @@ paths: $ref: '#/components/schemas/DIDXRejectRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1212,7 +1212,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -1230,7 +1230,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -1259,7 +1259,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -1277,7 +1277,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -1296,7 +1296,7 @@ paths: $ref: '#/components/schemas/V20IssueCredSchemaCore' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1316,7 +1316,7 @@ paths: $ref: '#/components/schemas/V20CredOfferConnFreeRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1367,7 +1367,7 @@ paths: type: string format: uuid responses: - 200: + '200': description: '' content: application/json: @@ -1388,7 +1388,7 @@ paths: pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' type: string responses: - 200: + '200': description: '' content: application/json: @@ -1408,7 +1408,7 @@ paths: pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' type: string responses: - 200: + '200': description: '' content: application/json: @@ -1435,7 +1435,7 @@ paths: $ref: '#/components/schemas/V20CredIssueRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1463,7 +1463,7 @@ paths: $ref: '#/components/schemas/V20CredIssueProblemReportRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1491,7 +1491,7 @@ paths: $ref: '#/components/schemas/V20CredBoundOfferRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1519,7 +1519,7 @@ paths: $ref: '#/components/schemas/V20CredRequestRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1547,7 +1547,7 @@ paths: $ref: '#/components/schemas/V20CredStoreRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1567,7 +1567,7 @@ paths: $ref: '#/components/schemas/V20CredExFree' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1587,7 +1587,7 @@ paths: $ref: '#/components/schemas/V20CredOfferRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1607,7 +1607,7 @@ paths: $ref: '#/components/schemas/V20CredExFree' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1628,7 +1628,7 @@ paths: $ref: '#/components/schemas/V20CredRequestFree' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1649,7 +1649,7 @@ paths: $ref: '#/components/schemas/V10CredentialCreate' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1669,7 +1669,7 @@ paths: $ref: '#/components/schemas/V10CredentialConnFreeOfferRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1721,7 +1721,7 @@ paths: type: string format: uuid responses: - 200: + '200': description: '' content: application/json: @@ -1742,7 +1742,7 @@ paths: pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' type: string responses: - 200: + '200': description: '' content: application/json: @@ -1762,7 +1762,7 @@ paths: pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' type: string responses: - 200: + '200': description: '' content: application/json: @@ -1789,7 +1789,7 @@ paths: $ref: '#/components/schemas/V10CredentialIssueRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1817,7 +1817,7 @@ paths: $ref: '#/components/schemas/V10CredentialProblemReportRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1845,7 +1845,7 @@ paths: $ref: '#/components/schemas/V10CredentialBoundOfferRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1873,7 +1873,7 @@ paths: $ref: '#/components/schemas/V10CredentialExchangeAutoRemoveRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1901,7 +1901,7 @@ paths: $ref: '#/components/schemas/V10CredentialStoreRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1921,7 +1921,7 @@ paths: $ref: '#/components/schemas/V10CredentialProposalRequestMand' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1941,7 +1941,7 @@ paths: $ref: '#/components/schemas/V10CredentialFreeOfferRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1961,7 +1961,7 @@ paths: $ref: '#/components/schemas/V10CredentialProposalRequestOpt' required: false responses: - 200: + '200': description: '' content: application/json: @@ -1981,7 +1981,7 @@ paths: $ref: '#/components/schemas/SignRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2001,7 +2001,7 @@ paths: $ref: '#/components/schemas/VerifyRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2015,7 +2015,7 @@ paths: - ledger summary: Fetch the multiple ledger configuration currently in use responses: - 200: + '200': description: '' content: application/json: @@ -2044,7 +2044,7 @@ paths: - Profile - LinkedDomains responses: - 200: + '200': description: '' content: application/json: @@ -2065,7 +2065,7 @@ paths: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -2086,7 +2086,7 @@ paths: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -2099,7 +2099,7 @@ paths: - ledger summary: Fetch the current write ledger responses: - 200: + '200': description: '' content: application/json: @@ -2111,7 +2111,7 @@ paths: - ledger summary: Fetch list of available write ledgers responses: - 200: + '200': description: '' content: application/json: @@ -2164,7 +2164,7 @@ paths: - NETWORK_MONITOR - reset responses: - 200: + '200': description: '' content: application/json: @@ -2177,7 +2177,7 @@ paths: - ledger summary: Rotate key pair for public DID. responses: - 200: + '200': description: '' content: application/json: @@ -2190,7 +2190,7 @@ paths: - ledger summary: Fetch the current transaction author agreement, if any responses: - 200: + '200': description: '' content: application/json: @@ -2209,7 +2209,7 @@ paths: $ref: '#/components/schemas/TAAAccept' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2229,7 +2229,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -2241,7 +2241,7 @@ paths: - mediation summary: Get default mediator responses: - 200: + '200': description: '' content: application/json: @@ -2253,7 +2253,7 @@ paths: - mediation summary: Clear default mediator responses: - 201: + '201': description: '' content: application/json: @@ -2283,7 +2283,7 @@ paths: - client - server responses: - 200: + '200': description: '' content: application/json: @@ -2324,7 +2324,7 @@ paths: $ref: '#/components/schemas/KeylistQueryFilterRequest' required: false responses: - 201: + '201': description: '' content: application/json: @@ -2352,7 +2352,7 @@ paths: $ref: '#/components/schemas/KeylistUpdateRequest' required: false responses: - 201: + '201': description: '' content: application/json: @@ -2379,7 +2379,7 @@ paths: $ref: '#/components/schemas/MediationCreateRequest' required: false responses: - 201: + '201': description: '' content: application/json: @@ -2409,7 +2409,7 @@ paths: - granted - denied responses: - 200: + '200': description: '' content: application/json: @@ -2430,7 +2430,7 @@ paths: type: string format: uuid responses: - 200: + '200': description: '' content: application/json: @@ -2450,7 +2450,7 @@ paths: type: string format: uuid responses: - 200: + '200': description: '' content: application/json: @@ -2477,7 +2477,7 @@ paths: $ref: '#/components/schemas/AdminMediationDeny' required: false responses: - 201: + '201': description: '' content: application/json: @@ -2499,7 +2499,7 @@ paths: type: string format: uuid responses: - 201: + '201': description: '' content: application/json: @@ -2525,7 +2525,7 @@ paths: $ref: '#/components/schemas/MediationIdMatchInfo' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2546,7 +2546,7 @@ paths: type: string format: uuid responses: - 201: + '201': description: '' content: application/json: @@ -2565,7 +2565,7 @@ paths: $ref: '#/components/schemas/CreateWalletRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2586,7 +2586,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -2611,7 +2611,7 @@ paths: $ref: '#/components/schemas/UpdateWalletRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2638,7 +2638,7 @@ paths: $ref: '#/components/schemas/RemoveWalletRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2664,7 +2664,7 @@ paths: $ref: '#/components/schemas/CreateWalletTokenRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2684,7 +2684,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -2714,7 +2714,7 @@ paths: $ref: '#/components/schemas/InvitationCreateRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2756,7 +2756,7 @@ paths: $ref: '#/components/schemas/InvitationMessage' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2770,7 +2770,7 @@ paths: - server summary: Fetch the list of loaded plugins responses: - 200: + '200': description: '' content: application/json: @@ -2789,7 +2789,7 @@ paths: $ref: '#/components/schemas/V20PresCreateRequestRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2838,7 +2838,7 @@ paths: type: string format: uuid responses: - 200: + '200': description: '' content: application/json: @@ -2859,7 +2859,7 @@ paths: pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' type: string responses: - 200: + '200': description: '' content: application/json: @@ -2879,7 +2879,7 @@ paths: pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' type: string responses: - 200: + '200': description: '' content: application/json: @@ -2923,7 +2923,7 @@ paths: pattern: ^[0-9]*$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -2952,7 +2952,7 @@ paths: $ref: '#/components/schemas/V20PresProblemReportRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -2980,7 +2980,7 @@ paths: $ref: '#/components/schemas/V20PresSpecByFormatRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3008,7 +3008,7 @@ paths: $ref: '#/components/schemas/V20PresentationSendRequestToProposal' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3030,7 +3030,7 @@ paths: pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' type: string responses: - 200: + '200': description: '' content: application/json: @@ -3049,7 +3049,7 @@ paths: $ref: '#/components/schemas/V20PresProposalRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3069,7 +3069,7 @@ paths: $ref: '#/components/schemas/V20PresSendRequestRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3089,7 +3089,7 @@ paths: $ref: '#/components/schemas/V10PresentationCreateRequestRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3139,7 +3139,7 @@ paths: type: string format: uuid responses: - 200: + '200': description: '' content: application/json: @@ -3160,7 +3160,7 @@ paths: pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' type: string responses: - 200: + '200': description: '' content: application/json: @@ -3180,7 +3180,7 @@ paths: pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' type: string responses: - 200: + '200': description: '' content: application/json: @@ -3224,7 +3224,7 @@ paths: pattern: ^[0-9]*$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -3253,7 +3253,7 @@ paths: $ref: '#/components/schemas/V10PresentationProblemReportRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3281,7 +3281,7 @@ paths: $ref: '#/components/schemas/V10PresentationSendRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3309,7 +3309,7 @@ paths: $ref: '#/components/schemas/V10PresentationSendRequestToProposal' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3331,7 +3331,7 @@ paths: pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' type: string responses: - 200: + '200': description: '' content: application/json: @@ -3350,7 +3350,7 @@ paths: $ref: '#/components/schemas/V10PresentationProposalRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3370,7 +3370,7 @@ paths: $ref: '#/components/schemas/V10PresentationSendRequestRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3392,7 +3392,7 @@ paths: pattern: ^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -3413,7 +3413,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -3434,7 +3434,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -3452,7 +3452,7 @@ paths: $ref: '#/components/schemas/ClearPendingRevocationsRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3472,7 +3472,7 @@ paths: $ref: '#/components/schemas/RevRegCreateRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3505,7 +3505,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string responses: - 200: + '200': description: '' content: application/json: @@ -3524,7 +3524,7 @@ paths: $ref: '#/components/schemas/PublishRevocations' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3557,7 +3557,7 @@ paths: - full - decommissioned responses: - 200: + '200': description: '' content: application/json: @@ -3583,7 +3583,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string responses: - 200: + '200': description: '' content: application/json: @@ -3603,7 +3603,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string responses: - 200: + '200': description: '' content: application/json: @@ -3629,7 +3629,7 @@ paths: $ref: '#/components/schemas/RevRegUpdateTailsFileUri' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3661,7 +3661,7 @@ paths: schema: type: boolean responses: - 200: + '200': description: '' content: application/json: @@ -3692,7 +3692,7 @@ paths: schema: type: boolean responses: - 200: + '200': description: '' content: application/json: @@ -3719,7 +3719,7 @@ paths: schema: type: boolean responses: - 200: + '200': description: '' content: application/json: @@ -3739,7 +3739,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string responses: - 200: + '200': description: '' content: application/json: @@ -3760,7 +3760,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string responses: - 200: + '200': description: '' content: application/json: @@ -3780,7 +3780,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string responses: - 200: + '200': description: '' content: application/json: @@ -3812,7 +3812,7 @@ paths: - active - full responses: - 200: + '200': description: '' content: application/json: @@ -3833,7 +3833,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string responses: - 200: + '200': description: tails file content: application/octet-stream: @@ -3854,7 +3854,7 @@ paths: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string responses: - 200: + '200': description: '' content: application/json: @@ -3873,7 +3873,7 @@ paths: $ref: '#/components/schemas/RevokeRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3904,7 +3904,7 @@ paths: $ref: '#/components/schemas/SchemaSendRequest' required: false responses: - 200: + '200': description: '' content: application/json: @@ -3942,7 +3942,7 @@ paths: pattern: ^[0-9.]+$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -3963,7 +3963,7 @@ paths: pattern: ^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -3984,7 +3984,7 @@ paths: pattern: ^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -3997,7 +3997,7 @@ paths: - settings summary: Get the configurable settings associated with the profile. responses: - 200: + '200': description: '' content: application/json: @@ -4014,7 +4014,7 @@ paths: $ref: '#/components/schemas/UpdateProfileSettings' required: false responses: - 200: + '200': description: '' content: application/json: @@ -4027,7 +4027,7 @@ paths: - server summary: Shut down server responses: - 200: + '200': description: '' content: application/json: @@ -4040,7 +4040,7 @@ paths: - server summary: Fetch the server status responses: - 200: + '200': description: '' content: application/json: @@ -4053,7 +4053,7 @@ paths: - server summary: Fetch the server configuration responses: - 200: + '200': description: '' content: application/json: @@ -4066,7 +4066,7 @@ paths: - server summary: Liveliness check responses: - 200: + '200': description: '' content: application/json: @@ -4079,7 +4079,7 @@ paths: - server summary: Readiness check responses: - 200: + '200': description: '' content: application/json: @@ -4092,7 +4092,7 @@ paths: - server summary: Reset statistics responses: - 200: + '200': description: '' content: application/json: @@ -4112,7 +4112,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -4125,7 +4125,7 @@ paths: - endorse-transaction summary: Query transactions responses: - 200: + '200': description: '' content: application/json: @@ -4156,7 +4156,7 @@ paths: $ref: '#/components/schemas/Date' required: false responses: - 200: + '200': description: '' content: application/json: @@ -4188,7 +4188,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -4217,7 +4217,7 @@ paths: - TRANSACTION_ENDORSER - reset responses: - 200: + '200': description: '' content: application/json: @@ -4237,7 +4237,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -4257,7 +4257,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -4282,7 +4282,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -4302,7 +4302,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -4322,7 +4322,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -4374,7 +4374,7 @@ paths: pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -4393,7 +4393,7 @@ paths: $ref: '#/components/schemas/DIDCreate' required: false responses: - 200: + '200': description: '' content: application/json: @@ -4415,7 +4415,7 @@ paths: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -4428,7 +4428,7 @@ paths: - wallet summary: Fetch the current public DID responses: - 200: + '200': description: '' content: application/json: @@ -4463,7 +4463,7 @@ paths: schema: type: string responses: - 200: + '200': description: '' content: application/json: @@ -4484,7 +4484,7 @@ paths: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$ type: string responses: - 200: + '200': description: '' content: application/json: @@ -4503,7 +4503,7 @@ paths: $ref: '#/components/schemas/JWSCreate' required: false responses: - 200: + '200': description: '' content: application/json: @@ -4522,7 +4522,7 @@ paths: $ref: '#/components/schemas/JWSVerify' required: false responses: - 200: + '200': description: '' content: application/json: @@ -4541,7 +4541,7 @@ paths: $ref: '#/components/schemas/SDJWSCreate' required: false responses: - 200: + '200': description: '' content: application/json: @@ -4561,7 +4561,7 @@ paths: $ref: '#/components/schemas/SDJWSVerify' required: false responses: - 200: + '200': description: '' content: application/json: @@ -4591,7 +4591,7 @@ paths: $ref: '#/components/schemas/DIDEndpointWithType' required: false responses: - 200: + '200': description: '' content: application/json: @@ -6109,7 +6109,7 @@ components: pattern: ^-?[0-9]*$ type: string description: Attribute encoded value - example: -1 + example: '-1' raw: type: string description: Attribute raw value @@ -6304,7 +6304,7 @@ components: additionalProperties: pattern: ^-?[0-9]*$ type: string - example: -1 + example: '-1' v: pattern: ^[0-9]*$ type: string @@ -6813,7 +6813,7 @@ components: pattern: ^-?[0-9]*$ type: string description: Encoded value - example: -1 + example: '-1' raw: type: string description: Raw value @@ -8088,7 +8088,7 @@ components: pattern: ^-?[0-9]*$ type: string description: Encoded value - example: -1 + example: '-1' raw: type: string description: Raw value @@ -10846,3 +10846,4 @@ components: description: Bearer token. Be sure to preprend token with 'Bearer ' name: Authorization in: header +x-original-swagger-version: '2.0' diff --git a/generator/data/swagger.json b/generator/data/swagger.json index 95d584d3..22a03016 100644 --- a/generator/data/swagger.json +++ b/generator/data/swagger.json @@ -1 +1,12224 @@ -{"paths": {"/action-menu/{conn_id}/close": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Close the active menu associated with a connection", "produces": ["application/json"]}}, "/action-menu/{conn_id}/fetch": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuFetchResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Fetch the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/perform": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PerformRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Perform an action associated with the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Request the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/send-menu": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SendMenu"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Send an action menu to a connection", "produces": ["application/json"]}}, "/connections": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionList"}, "description": ""}}, "parameters": [{"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "connection_protocol", "required": false, "type": "string", "enum": ["connections/1.0", "didexchange/1.0"], "description": "Connection protocol used", "example": "connections/1.0"}, {"in": "query", "name": "invitation_key", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "invitation key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, {"in": "query", "name": "invitation_msg_id", "required": false, "type": "string", "format": "uuid", "description": "Identifier of the associated Invitation Mesage", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "My DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["invitation", "abandoned", "response", "start", "error", "init", "completed", "active", "request"], "description": "Connection state"}, {"in": "query", "name": "their_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "Their DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "their_public_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "Their Public DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "their_role", "required": false, "type": "string", "enum": ["invitee", "requester", "inviter", "responder"], "description": "Their role in the connection protocol", "example": "invitee"}], "tags": ["connection"], "summary": "Query agent-to-agent connections", "produces": ["application/json"]}}, "/connections/create-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/InvitationResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateInvitationRequest"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "multi_use", "required": false, "type": "boolean", "description": "Create invitation for multiple use (default false)"}, {"in": "query", "name": "public", "required": false, "type": "boolean", "description": "Create invitation from public DID (default false)"}], "tags": ["connection"], "summary": "Create a new connection invitation", "produces": ["application/json"]}}, "/connections/create-static": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionStaticResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ConnectionStaticRequest"}}], "tags": ["connection"], "summary": "Create a new static connection", "produces": ["application/json"]}}, "/connections/receive-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ReceiveInvitationRequest"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Receive a new connection invitation", "produces": ["application/json"]}}, "/connections/{conn_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Fetch a single connection record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Remove an existing connection record", "produces": ["application/json"]}}, "/connections/{conn_id}/accept-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "query", "name": "my_label", "required": false, "type": "string", "description": "Label for connection", "example": "Broker"}], "tags": ["connection"], "summary": "Accept a stored connection invitation", "produces": ["application/json"]}}, "/connections/{conn_id}/accept-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}], "tags": ["connection"], "summary": "Accept a stored connection request", "produces": ["application/json"]}}, "/connections/{conn_id}/endpoints": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/EndpointsResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Fetch connection remote endpoint", "produces": ["application/json"]}}, "/connections/{conn_id}/metadata": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionMetadata"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "key", "required": false, "type": "string", "description": "Key to retrieve."}], "tags": ["connection"], "summary": "Fetch connection metadata", "produces": ["application/json"]}, "post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionMetadata"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ConnectionMetadataSetRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Set connection metadata", "produces": ["application/json"]}}, "/connections/{conn_id}/send-message": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/BasicMessageModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SendMessage"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["basicmessage"], "summary": "Send a basic message to a connection", "produces": ["application/json"]}}, "/connections/{conn_id}/send-ping": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/PingRequestResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PingRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["trustping"], "summary": "Send a trust ping to a connection", "produces": ["application/json"]}}, "/connections/{conn_id}/start-introduction": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/IntroModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "target_connection_id", "required": true, "type": "string", "description": "Target connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "message", "required": false, "type": "string", "description": "Message", "example": "Allow me to introduce ..."}], "tags": ["introduction"], "summary": "Start an introduction between two connections", "produces": ["application/json"]}}, "/credential-definitions": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrCredentialDefinitionSendResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CredentialDefinitionSendRequest"}}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["credential-definition"], "summary": "Sends a credential definition to the ledger", "produces": ["application/json"]}}, "/credential-definitions/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionsCreatedResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_def_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition id", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, {"in": "query", "name": "issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "schema_id", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, {"in": "query", "name": "schema_issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "schema_name", "required": false, "type": "string", "description": "Schema name", "example": "membership"}, {"in": "query", "name": "schema_version", "required": false, "type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}], "tags": ["credential-definition"], "summary": "Search for matching credential definitions that agent originated", "produces": ["application/json"]}}, "/credential-definitions/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["credential-definition"], "summary": "Gets a credential definition from the ledger", "produces": ["application/json"]}}, "/credential-definitions/{cred_def_id}/write_record": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["credential-definition"], "summary": "Writes a credential definition non-secret record to the wallet", "produces": ["application/json"]}}, "/credential/mime-types/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AttributeMimeTypesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Get attribute MIME types from wallet", "produces": ["application/json"]}}, "/credential/revoked/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevokedResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "from", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Earliest epoch of revocation status interval of interest", "example": "0"}, {"in": "query", "name": "to", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Latest epoch of revocation status interval of interest", "example": "0"}], "tags": ["credentials"], "summary": "Query credential revocation status by id", "produces": ["application/json"]}}, "/credential/w3c/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/VCRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Fetch W3C credential from wallet by id", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/HolderModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Remove W3C credential from wallet by id", "produces": ["application/json"]}}, "/credential/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/IndyCredInfo"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Fetch credential from wallet by id", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/HolderModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Remove credential from wallet by id", "produces": ["application/json"]}}, "/credentials": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredInfoList"}, "description": ""}}, "parameters": [{"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}, {"in": "query", "name": "wql", "required": false, "type": "string", "pattern": "^{.*}$", "description": "(JSON) WQL query", "example": "{\"attr::name::value\": \"Alex\"}"}], "tags": ["credentials"], "summary": "Fetch credentials from wallet", "produces": ["application/json"]}}, "/credentials/w3c": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/VCRecordList"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/W3CCredentialsListRequest"}}, {"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}, {"in": "query", "name": "wql", "required": false, "type": "string", "pattern": "^{.*}$", "description": "(JSON) WQL query", "example": "{\"attr::name::value\": \"Alex\"}"}], "tags": ["credentials"], "summary": "Fetch W3C credentials from wallet", "produces": ["application/json"]}}, "/didexchange/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "query", "name": "their_public_did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "Qualified public DID to which to request connection", "example": "did:peer:WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias for connection", "example": "Barry"}, {"in": "query", "name": "goal", "required": false, "type": "string", "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", "example": "To issue a Faber College Graduate credential"}, {"in": "query", "name": "goal_code", "required": false, "type": "string", "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", "example": "issue-vc"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "query", "name": "my_label", "required": false, "type": "string", "description": "Label for connection request", "example": "Broker"}, {"in": "query", "name": "use_public_did", "required": false, "type": "boolean", "description": "Use public DID for this connection"}], "tags": ["did-exchange"], "summary": "Create and send a request against public DID's implicit invitation", "produces": ["application/json"]}}, "/didexchange/receive-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDXRequest"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias for connection", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}], "tags": ["did-exchange"], "summary": "Receive request against public DID's implicit invitation", "produces": ["application/json"]}}, "/didexchange/{conn_id}/accept-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "query", "name": "my_label", "required": false, "type": "string", "description": "Label for connection request", "example": "Broker"}], "tags": ["did-exchange"], "summary": "Accept a stored connection invitation", "produces": ["application/json"]}}, "/didexchange/{conn_id}/accept-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "query", "name": "use_public_did", "required": false, "type": "boolean", "description": "Use public DID for this connection"}], "tags": ["did-exchange"], "summary": "Accept a stored connection request", "produces": ["application/json"]}}, "/didexchange/{conn_id}/reject": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDXRejectRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["did-exchange"], "summary": "Abandon or reject a DID Exchange", "produces": ["application/json"]}}, "/discover-features-2.0/queries": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20DiscoveryExchangeResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier, if none specified, then the query will provide features for this agent.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "query_goal_code", "required": false, "type": "string", "description": "Goal-code feature-type query", "example": "*"}, {"in": "query", "name": "query_protocol", "required": false, "type": "string", "description": "Protocol feature-type query", "example": "*"}], "tags": ["discover-features v2.0"], "summary": "Query supported features", "produces": ["application/json"]}}, "/discover-features-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20DiscoveryExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["discover-features v2.0"], "summary": "Discover Features v2.0 records", "produces": ["application/json"]}}, "/discover-features/query": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10DiscoveryRecord"}, "description": ""}}, "parameters": [{"in": "query", "name": "comment", "required": false, "type": "string", "description": "Comment", "example": "test"}, {"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier, if none specified, then the query will provide features for this agent.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "query", "required": false, "type": "string", "description": "Protocol feature query", "example": "*"}], "tags": ["discover-features"], "summary": "Query supported features", "produces": ["application/json"]}}, "/discover-features/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10DiscoveryExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["discover-features"], "summary": "Discover Features records", "produces": ["application/json"]}}, "/issue-credential-2.0/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20IssueCredSchemaCore"}}], "tags": ["issue-credential v2.0"], "summary": "Create a credential record without sending (generally for use with Out-Of-Band)", "produces": ["application/json"]}}, "/issue-credential-2.0/create-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredOfferConnFreeRequest"}}], "tags": ["issue-credential v2.0"], "summary": "Create a credential offer, independent of any proposal or connection", "produces": ["application/json"]}}, "/issue-credential-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["issuer", "holder"], "description": "Role assigned in credential exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal-sent", "proposal-received", "offer-sent", "offer-received", "request-sent", "request-received", "credential-issued", "credential-received", "done", "credential-revoked", "abandoned"], "description": "Credential exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Fetch all credential exchange records", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Fetch a single credential exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Remove an existing credential exchange record", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/issue": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredIssueRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredIssueProblemReportRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send a problem report for credential exchange", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredBoundOfferRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential offer in reference to a proposal with preview", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredRequestRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential request", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/store": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredStoreRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Store a received credential", "produces": ["application/json"]}}, "/issue-credential-2.0/send": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredExFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential, automating entire flow", "produces": ["application/json"]}}, "/issue-credential-2.0/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredOfferRequest"}}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential offer, independent of any proposal", "produces": ["application/json"]}}, "/issue-credential-2.0/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredExFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential proposal", "produces": ["application/json"]}}, "/issue-credential-2.0/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredRequestFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request", "produces": ["application/json"]}}, "/issue-credential/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialCreate"}}], "tags": ["issue-credential v1.0"], "summary": "Create a credential record without sending (generally for use with Out-Of-Band)", "produces": ["application/json"]}}, "/issue-credential/create-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialConnFreeOfferRequest"}}], "tags": ["issue-credential v1.0"], "summary": "Create a credential offer, independent of any proposal or connection", "produces": ["application/json"]}}, "/issue-credential/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["issuer", "holder"], "description": "Role assigned in credential exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal_sent", "proposal_received", "offer_sent", "offer_received", "request_sent", "request_received", "credential_issued", "credential_received", "credential_acked", "credential_revoked", "abandoned"], "description": "Credential exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Fetch all credential exchange records", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Fetch a single credential exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Remove an existing credential exchange record", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/issue": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialIssueRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProblemReportRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send a problem report for credential exchange", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialBoundOfferRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential offer in reference to a proposal with preview", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialExchangeAutoRemoveRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send issuer a credential request", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/store": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialStoreRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Store a received credential", "produces": ["application/json"]}}, "/issue-credential/send": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProposalRequestMand"}}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential, automating entire flow", "produces": ["application/json"]}}, "/issue-credential/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialFreeOfferRequest"}}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential offer, independent of any proposal", "produces": ["application/json"]}}, "/issue-credential/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProposalRequestOpt"}}], "tags": ["issue-credential v1.0"], "summary": "Send issuer a credential proposal", "produces": ["application/json"]}}, "/jsonld/sign": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SignResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SignRequest"}}], "tags": ["jsonld"], "summary": "Sign a JSON-LD structure and return it", "produces": ["application/json"]}}, "/jsonld/verify": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/VerifyResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/VerifyRequest"}}], "tags": ["jsonld"], "summary": "Verify a JSON-LD structure.", "produces": ["application/json"]}}, "/ledger/config": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerConfigList"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the multiple ledger configuration currently in use", "produces": ["application/json"]}}, "/ledger/did-endpoint": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetDIDEndpointResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "endpoint_type", "required": false, "type": "string", "enum": ["Endpoint", "Profile", "LinkedDomains"], "description": "Endpoint type of interest (default 'Endpoint')", "example": "Endpoint"}], "tags": ["ledger"], "summary": "Get the endpoint for a DID from the ledger.", "produces": ["application/json"]}}, "/ledger/did-verkey": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetDIDVerkeyResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["ledger"], "summary": "Get the verkey for a DID from the ledger.", "produces": ["application/json"]}}, "/ledger/get-nym-role": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetNymRoleResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["ledger"], "summary": "Get the role from the NYM registration of a public DID.", "produces": ["application/json"]}}, "/ledger/get-write-ledger": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WriteLedger"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the current write ledger", "produces": ["application/json"]}}, "/ledger/get-write-ledgers": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConfigurableWriteLedgers"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch list of available write ledgers", "produces": ["application/json"]}}, "/ledger/register-nym": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrRegisterLedgerNymResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID to register", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "verkey", "required": true, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "reset"], "description": "Role"}], "tags": ["ledger"], "summary": "Send a NYM registration to the ledger.", "produces": ["application/json"]}}, "/ledger/rotate-public-did-keypair": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerModulesResult"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Rotate key pair for public DID.", "produces": ["application/json"]}}, "/ledger/taa": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TAAResult"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the current transaction author agreement, if any", "produces": ["application/json"]}}, "/ledger/taa/accept": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/TAAAccept"}}], "tags": ["ledger"], "summary": "Accept the transaction author agreement", "produces": ["application/json"]}}, "/ledger/{ledger_id}/set-write-ledger": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/WriteLedger"}, "description": ""}}, "parameters": [{"in": "path", "name": "ledger_id", "required": true, "type": "string"}], "tags": ["ledger"], "summary": "Set write ledger", "produces": ["application/json"]}}, "/mediation/default-mediator": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [], "tags": ["mediation"], "summary": "Get default mediator", "produces": ["application/json"]}, "delete": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [], "tags": ["mediation"], "summary": "Clear default mediator", "produces": ["application/json"]}}, "/mediation/keylists": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/Keylist"}, "description": ""}}, "parameters": [{"in": "query", "name": "conn_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier (optional)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "default": "server", "enum": ["client", "server"], "description": "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent"}], "tags": ["mediation"], "summary": "Retrieve keylists by connection or role", "produces": ["application/json"]}}, "/mediation/keylists/{mediation_id}/send-keylist-query": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/KeylistQuery"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/KeylistQueryFilterRequest"}}, {"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "paginate_limit", "required": false, "type": "integer", "format": "int32", "default": -1, "description": "limit number of results"}, {"in": "query", "name": "paginate_offset", "required": false, "type": "integer", "format": "int32", "default": 0, "description": "offset to use in pagination"}], "tags": ["mediation"], "summary": "Send keylist query to mediator", "produces": ["application/json"]}}, "/mediation/keylists/{mediation_id}/send-keylist-update": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/KeylistUpdate"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/KeylistUpdateRequest"}}, {"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Send keylist update to mediator", "produces": ["application/json"]}}, "/mediation/request/{conn_id}": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/MediationCreateRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Request mediation from connection", "produces": ["application/json"]}}, "/mediation/requests": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationList"}, "description": ""}}, "parameters": [{"in": "query", "name": "conn_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier (optional)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["request", "granted", "denied"], "description": "Mediation state (optional)", "example": "granted"}], "tags": ["mediation"], "summary": "Query mediation requests, returns list of all mediation records", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Retrieve mediation request record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Delete mediation request by ID", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}/deny": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationDeny"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/AdminMediationDeny"}}, {"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Deny a stored mediation request", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}/grant": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationGrant"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Grant received mediation", "produces": ["application/json"]}}, "/mediation/update-keylist/{conn_id}": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/KeylistUpdate"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/MediationIdMatchInfo"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Update keylist for a connection", "produces": ["application/json"]}}, "/mediation/{mediation_id}/default-mediator": {"put": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Set default mediator", "produces": ["application/json"]}}, "/multitenancy/wallet": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CreateWalletResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateWalletRequest"}}], "tags": ["multitenancy"], "summary": "Create a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "wallet_id", "required": true, "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["multitenancy"], "summary": "Get a single subwallet", "produces": ["application/json"]}, "put": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/UpdateWalletRequest"}}, {"in": "path", "name": "wallet_id", "required": true, "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["multitenancy"], "summary": "Update a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}/remove": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/MultitenantModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RemoveWalletRequest"}}, {"in": "path", "name": "wallet_id", "required": true, "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["multitenancy"], "summary": "Remove a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}/token": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CreateWalletTokenResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateWalletTokenRequest"}}, {"in": "path", "name": "wallet_id", "required": true, "type": "string"}], "tags": ["multitenancy"], "summary": "Get auth token for a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallets": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletList"}, "description": ""}}, "parameters": [{"in": "query", "name": "wallet_name", "required": false, "type": "string", "description": "Wallet name", "example": "MyNewWallet"}], "tags": ["multitenancy"], "summary": "Query subwallets", "produces": ["application/json"]}}, "/out-of-band/create-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/InvitationRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/InvitationCreateRequest"}}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "multi_use", "required": false, "type": "boolean", "description": "Create invitation for multiple use (default false)"}], "tags": ["out-of-band"], "summary": "Create a new connection invitation", "produces": ["application/json"]}}, "/out-of-band/receive-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/OobRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/InvitationMessage"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias for connection", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "use_existing_connection", "required": false, "type": "boolean", "description": "Use an existing connection, if possible"}], "tags": ["out-of-band"], "summary": "Receive a new connection invitation", "produces": ["application/json"]}}, "/plugins": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminModules"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the list of loaded plugins", "produces": ["application/json"]}}, "/present-proof-2.0/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresCreateRequestRequest"}}], "tags": ["present-proof v2.0"], "summary": "Creates a presentation request not bound to any proposal or connection", "produces": ["application/json"]}}, "/present-proof-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecordList"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["prover", "verifier"], "description": "Role assigned in presentation exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal-sent", "proposal-received", "request-sent", "request-received", "presentation-sent", "presentation-received", "done", "abandoned"], "description": "Presentation exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Fetch all present-proof exchange records", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Fetch a single presentation exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Remove an existing presentation exchange record", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/credentials": {"get": {"responses": {"200": {"schema": {"type": "array", "items": {"$ref": "#/definitions/IndyCredPrecis"}}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "extra_query", "required": false, "type": "string", "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", "description": "(JSON) object mapping referents to extra WQL queries", "example": "{\"0_drink_uuid\": {\"attr::drink::value\": \"martini\"}}"}, {"in": "query", "name": "referent", "required": false, "type": "string", "description": "Proof request referents of interest, comma-separated", "example": "1_name_uuid,2_score_uuid"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}], "tags": ["present-proof v2.0"], "summary": "Fetch credentials from wallet for presentation request", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresProblemReportRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Send a problem report for presentation exchange", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/send-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresSpecByFormatRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Sends a proof presentation", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresentationSendRequestToProposal"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Sends a presentation request in reference to a proposal", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/verify-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Verify a received presentation", "produces": ["application/json"]}}, "/present-proof-2.0/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresProposalRequest"}}], "tags": ["present-proof v2.0"], "summary": "Sends a presentation proposal", "produces": ["application/json"]}}, "/present-proof-2.0/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresSendRequestRequest"}}], "tags": ["present-proof v2.0"], "summary": "Sends a free presentation request not bound to any proposal", "produces": ["application/json"]}}, "/present-proof/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationCreateRequestRequest"}}], "tags": ["present-proof v1.0"], "summary": "Creates a presentation request not bound to any proposal or connection", "produces": ["application/json"]}}, "/present-proof/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchangeList"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["prover", "verifier"], "description": "Role assigned in presentation exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal_sent", "proposal_received", "request_sent", "request_received", "presentation_sent", "presentation_received", "verified", "presentation_acked", "abandoned"], "description": "Presentation exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Fetch all present-proof exchange records", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Fetch a single presentation exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Remove an existing presentation exchange record", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/credentials": {"get": {"responses": {"200": {"schema": {"type": "array", "items": {"$ref": "#/definitions/IndyCredPrecis"}}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "extra_query", "required": false, "type": "string", "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", "description": "(JSON) object mapping referents to extra WQL queries", "example": "{\"0_drink_uuid\": {\"attr::drink::value\": \"martini\"}}"}, {"in": "query", "name": "referent", "required": false, "type": "string", "description": "Proof request referents of interest, comma-separated", "example": "1_name_uuid,2_score_uuid"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}], "tags": ["present-proof v1.0"], "summary": "Fetch credentials for a presentation request from wallet", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationProblemReportRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Send a problem report for presentation exchange", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/send-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationSendRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Sends a proof presentation", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationSendRequestToProposal"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Sends a presentation request in reference to a proposal", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/verify-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Verify a received presentation", "produces": ["application/json"]}}, "/present-proof/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationProposalRequest"}}], "tags": ["present-proof v1.0"], "summary": "Sends a presentation proposal", "produces": ["application/json"]}}, "/present-proof/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationSendRequestRequest"}}], "tags": ["present-proof v1.0"], "summary": "Sends a free presentation request not bound to any proposal", "produces": ["application/json"]}}, "/resolver/resolve/{did}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ResolutionResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "did", "required": true, "type": "string", "pattern": "^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$", "description": "DID", "example": "did:ted:WgWxqztrNooG92RXvxSTWv"}], "tags": ["resolver"], "summary": "Retrieve doc for requested did", "produces": ["application/json"]}}, "/revocation/active-registry/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["revocation"], "summary": "Get current active revocation registry by credential definition id", "produces": ["application/json"]}}, "/revocation/active-registry/{cred_def_id}/rotate": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegsCreated"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["revocation"], "summary": "Rotate revocation registry", "produces": ["application/json"]}}, "/revocation/clear-pending-revocations": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/PublishRevocations"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ClearPendingRevocationsRequest"}}], "tags": ["revocation"], "summary": "Clear pending revocations", "produces": ["application/json"]}}, "/revocation/create-registry": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevRegCreateRequest"}}], "tags": ["revocation"], "summary": "Creates a new revocation registry", "produces": ["application/json"]}}, "/revocation/credential-record": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevRecordResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_ex_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "cred_rev_id", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Credential revocation identifier", "example": "12345"}, {"in": "query", "name": "rev_reg_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get credential revocation status", "produces": ["application/json"]}}, "/revocation/publish-revocations": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrPublishRevocationsResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PublishRevocations"}}], "tags": ["revocation"], "summary": "Publish pending revocations to ledger", "produces": ["application/json"]}}, "/revocation/registries/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegsCreated"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_def_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["init", "generated", "posted", "active", "full", "decommissioned"], "description": "Revocation registry state"}], "tags": ["revocation"], "summary": "Search for matching revocation registries that current agent created", "produces": ["application/json"]}}, "/revocation/registry/delete-tails-file": {"delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/TailsDeleteResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_def_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, {"in": "query", "name": "rev_reg_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Delete the tail files", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get revocation registry by revocation registry id", "produces": ["application/json"]}, "patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevRegUpdateTailsFileUri"}}, {"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Update revocation registry with new public URI to its tails file", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/definition": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrRevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["revocation"], "summary": "Send revocation registry definition to ledger", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/entry": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["revocation"], "summary": "Send revocation registry entry to ledger", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/fix-revocation-entry-state": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegWalletUpdatedResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, {"in": "query", "name": "apply_ledger_update", "required": true, "type": "boolean", "description": "Apply updated accumulator transaction to ledger"}], "tags": ["revocation"], "summary": "Fix revocation state in wallet and return number of updated entries", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/issued": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegIssuedResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get number of credentials issued against revocation registry", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/issued/details": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevRecordDetailsResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get details of credentials issued against revocation registry", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/issued/indy_recs": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevIndyRecordsResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get details of revoked credentials from ledger", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/set-state": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, {"in": "query", "name": "state", "required": true, "type": "string", "enum": ["init", "generated", "posted", "active", "full"], "description": "Revocation registry state to set"}], "tags": ["revocation"], "summary": "Set revocation registry state manually", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/tails-file": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Upload local tails file to server", "produces": ["application/json"]}, "get": {"responses": {"200": {"schema": {"type": "string", "format": "binary"}, "description": "tails file"}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Download tails file", "produces": ["application/octet-stream"]}}, "/revocation/revoke": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevokeRequest"}}], "tags": ["revocation"], "summary": "Revoke an issued credential", "produces": ["application/json"]}}, "/schemas": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrSchemaSendResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SchemaSendRequest"}}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["schema"], "summary": "Sends a schema to the ledger", "produces": ["application/json"]}}, "/schemas/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemasCreatedResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "schema_id", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, {"in": "query", "name": "schema_issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "schema_name", "required": false, "type": "string", "description": "Schema name", "example": "membership"}, {"in": "query", "name": "schema_version", "required": false, "type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}], "tags": ["schema"], "summary": "Search for matching schema that agent originated", "produces": ["application/json"]}}, "/schemas/{schema_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemaGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "schema_id", "required": true, "type": "string", "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}], "tags": ["schema"], "summary": "Gets a schema from the ledger", "produces": ["application/json"]}}, "/schemas/{schema_id}/write_record": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemaGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "schema_id", "required": true, "type": "string", "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}], "tags": ["schema"], "summary": "Writes a schema non-secret record to the wallet", "produces": ["application/json"]}}, "/settings": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/ProfileSettings"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/UpdateProfileSettings"}}], "tags": ["settings"], "summary": "Update configurable settings associated with the profile.", "produces": ["application/json"]}, "get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ProfileSettings"}, "description": ""}}, "parameters": [], "tags": ["settings"], "summary": "Get the configurable settings associated with the profile.", "produces": ["application/json"]}}, "/shutdown": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminShutdown"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Shut down server", "produces": ["application/json"]}}, "/status": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatus"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the server status", "produces": ["application/json"]}}, "/status/config": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminConfig"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the server configuration", "produces": ["application/json"]}}, "/status/live": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatusLiveliness"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Liveliness check", "produces": ["application/json"]}}, "/status/ready": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatusReadiness"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Readiness check", "produces": ["application/json"]}}, "/status/reset": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminReset"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Reset statistics", "produces": ["application/json"]}}, "/transaction/{tran_id}/resend": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Author to resend a particular transaction request", "produces": ["application/json"]}}, "/transactions": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionList"}, "description": ""}}, "parameters": [], "tags": ["endorse-transaction"], "summary": "Query transactions", "produces": ["application/json"]}}, "/transactions/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/Date"}}, {"in": "query", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "endorser_write_txn", "required": false, "type": "boolean", "description": "Endorser will write the transaction after endorsing it"}], "tags": ["endorse-transaction"], "summary": "For author to send a transaction request", "produces": ["application/json"]}}, "/transactions/{conn_id}/set-endorser-info": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/EndorserInfo"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "endorser_did", "required": true, "type": "string", "description": "Endorser DID"}, {"in": "query", "name": "endorser_name", "required": false, "type": "string", "description": "Endorser Name"}], "tags": ["endorse-transaction"], "summary": "Set Endorser Info", "produces": ["application/json"]}}, "/transactions/{conn_id}/set-endorser-role": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionJobs"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "transaction_my_job", "required": false, "type": "string", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "description": "Transaction related jobs"}], "tags": ["endorse-transaction"], "summary": "Set transaction jobs", "produces": ["application/json"]}}, "/transactions/{tran_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "Fetch a single transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/cancel": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Author to cancel a particular transaction request", "produces": ["application/json"]}}, "/transactions/{tran_id}/endorse": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "endorser_did", "required": false, "type": "string", "description": "Endorser DID"}], "tags": ["endorse-transaction"], "summary": "For Endorser to endorse a particular transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/refuse": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Endorser to refuse a particular transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/write": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Author / Endorser to write an endorsed transaction to the ledger", "produces": ["application/json"]}}, "/wallet/did": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDList"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "key_type", "required": false, "type": "string", "enum": ["ed25519", "bls12381g2"], "example": "ed25519", "description": "Key type to query for."}, {"in": "query", "name": "method", "required": false, "type": "string", "enum": ["key", "sov"], "example": "key", "description": "DID method to query for. e.g. sov to only fetch indy/sov DIDs"}, {"in": "query", "name": "posture", "required": false, "type": "string", "enum": ["public", "posted", "wallet_only"], "description": "Whether DID is current public DID, posted to ledger but current public DID, or local to the wallet", "example": "wallet_only"}, {"in": "query", "name": "verkey", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Verification key of interest", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}], "tags": ["wallet"], "summary": "List wallet DIDs", "produces": ["application/json"]}}, "/wallet/did/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDCreate"}}], "tags": ["wallet"], "summary": "Create a local DID", "produces": ["application/json"]}}, "/wallet/did/local/rotate-keypair": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv"}], "tags": ["wallet"], "summary": "Rotate keypair for a DID not posted to the ledger", "produces": ["application/json"]}}, "/wallet/did/public": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [], "tags": ["wallet"], "summary": "Fetch the current public DID", "produces": ["application/json"]}, "post": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "description": "Mediation identifier"}], "tags": ["wallet"], "summary": "Assign the current public DID", "produces": ["application/json"]}}, "/wallet/get-did-endpoint": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDEndpoint"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv"}], "tags": ["wallet"], "summary": "Query DID endpoint in wallet", "produces": ["application/json"]}}, "/wallet/jwt/sign": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/JWSCreate"}}], "tags": ["wallet"], "summary": "Create a EdDSA jws using did keys with a given payload", "produces": ["application/json"]}}, "/wallet/jwt/verify": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/JWSVerifyResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/JWSVerify"}}], "tags": ["wallet"], "summary": "Verify a EdDSA jws using did keys with a given JWS", "produces": ["application/json"]}}, "/wallet/sd-jwt/sign": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SDJWSCreate"}}], "tags": ["wallet"], "summary": "Create a EdDSA sd-jws using did keys with a given payload", "produces": ["application/json"]}}, "/wallet/sd-jwt/verify": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SDJWSVerifyResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SDJWSVerify"}}], "tags": ["wallet"], "summary": "Verify a EdDSA sd-jws using did keys with a given SD-JWS with optional key binding", "produces": ["application/json"]}}, "/wallet/set-did-endpoint": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDEndpointWithType"}}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["wallet"], "summary": "Update endpoint in wallet and on ledger if posted to it", "produces": ["application/json"]}}}, "info": {"title": "Aries Cloud Agent", "version": "v0.11.0"}, "swagger": "2.0", "definitions": {"AMLRecord": {"properties": {"aml": {"additionalProperties": {"type": "string"}, "type": "object"}, "amlContext": {"type": "string"}, "version": {"type": "string"}}, "type": "object"}, "ActionMenuFetchResult": {"properties": {"result": {"allOf": [{"$ref": "#/definitions/Menu"}], "description": "Action menu"}}, "type": "object"}, "ActionMenuModulesResult": {"properties": {}, "type": "object"}, "AdminConfig": {"properties": {"config": {"description": "Configuration settings", "type": "object"}}, "type": "object"}, "AdminMediationDeny": {"properties": {}, "type": "object"}, "AdminModules": {"properties": {"result": {"description": "List of admin modules", "items": {"description": "admin module", "type": "string"}, "type": "array"}}, "type": "object"}, "AdminReset": {"properties": {}, "type": "object"}, "AdminShutdown": {"properties": {}, "type": "object"}, "AdminStatus": {"properties": {"conductor": {"description": "Conductor statistics", "type": "object"}, "label": {"description": "Default label", "type": "string", "x-nullable": true}, "timing": {"description": "Timing results", "type": "object"}, "version": {"description": "Version code", "type": "string"}}, "type": "object"}, "AdminStatusLiveliness": {"properties": {"alive": {"description": "Liveliness status", "example": true, "type": "boolean"}}, "type": "object"}, "AdminStatusReadiness": {"properties": {"ready": {"description": "Readiness status", "example": true, "type": "boolean"}}, "type": "object"}, "AttachDecorator": {"properties": {"@id": {"description": "Attachment identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "byte_count": {"description": "Byte count of data included by reference", "example": 1234, "format": "int32", "type": "integer"}, "data": {"$ref": "#/definitions/AttachDecoratorData"}, "description": {"description": "Human-readable description of content", "example": "view from doorway, facing east, with lights off", "type": "string"}, "filename": {"description": "File name", "example": "IMG1092348.png", "type": "string"}, "lastmod_time": {"description": "Hint regarding last modification datetime, in ISO-8601 format", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "mime-type": {"description": "MIME type", "example": "image/png", "type": "string"}}, "required": ["data"], "type": "object"}, "AttachDecoratorData": {"properties": {"base64": {"description": "Base64-encoded data", "example": "ey4uLn0=", "pattern": "^[a-zA-Z0-9+/]*={0,2}$", "type": "string"}, "json": {"description": "JSON-serialized data", "example": "{\"sample\": \"content\"}"}, "jws": {"allOf": [{"$ref": "#/definitions/AttachDecoratorDataJWS"}], "description": "Detached Java Web Signature"}, "links": {"description": "List of hypertext links to data", "items": {"example": "https://link.to/data", "type": "string"}, "type": "array"}, "sha256": {"description": "SHA256 hash (binhex encoded) of content", "example": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb", "pattern": "^[a-fA-F0-9+/]{64}$", "type": "string"}}, "type": "object"}, "AttachDecoratorData1JWS": {"properties": {"header": {"$ref": "#/definitions/AttachDecoratorDataJWSHeader"}, "protected": {"description": "protected JWS header", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signature": {"description": "signature", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}}, "required": ["header", "signature"], "type": "object"}, "AttachDecoratorDataJWS": {"properties": {"header": {"$ref": "#/definitions/AttachDecoratorDataJWSHeader"}, "protected": {"description": "protected JWS header", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signature": {"description": "signature", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signatures": {"description": "List of signatures", "items": {"$ref": "#/definitions/AttachDecoratorData1JWS"}, "type": "array"}}, "type": "object"}, "AttachDecoratorDataJWSHeader": {"properties": {"kid": {"description": "Key identifier, in W3C did:key or DID URL format", "example": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4", "pattern": "^did:(?:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+|sov:[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}(;.*)?(\\?.*)?#.+)$", "type": "string"}}, "required": ["kid"], "type": "object"}, "AttachmentDef": {"properties": {"id": {"description": "Attachment identifier", "example": "attachment-0", "type": "string"}, "type": {"description": "Attachment type", "enum": ["credential-offer", "present-proof"], "example": "present-proof", "type": "string"}}, "type": "object"}, "AttributeMimeTypesResult": {"properties": {"results": {"additionalProperties": {"description": "MIME type", "type": "string"}, "type": "object", "x-nullable": true}}, "type": "object"}, "BasicMessageModuleResponse": {"properties": {}, "type": "object"}, "ClaimFormat": {"properties": {"jwt": {"type": "object"}, "jwt_vc": {"type": "object"}, "jwt_vp": {"type": "object"}, "ldp": {"type": "object"}, "ldp_vc": {"type": "object"}, "ldp_vp": {"type": "object"}}, "type": "object"}, "ClearPendingRevocationsRequest": {"properties": {"purge": {"additionalProperties": {"items": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "type": "array"}, "description": "Credential revocation ids by revocation registry id: omit for all, specify null or empty list for all pending per revocation registry", "type": "object"}}, "type": "object"}, "ConfigurableWriteLedgers": {"properties": {"write_ledgers": {"description": "List of configurable write ledgers identifiers", "items": {"description": "Ledgers identifiers", "type": "string"}, "type": "array"}}, "type": "object"}, "ConnRecord": {"properties": {"accept": {"description": "Connection acceptance: manual or auto", "enum": ["manual", "auto"], "example": "auto", "type": "string"}, "alias": {"description": "Optional alias to apply to connection for later use", "example": "Bob, providing quotes", "type": "string"}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "connection_protocol": {"description": "Connection protocol used", "enum": ["connections/1.0", "didexchange/1.0"], "example": "connections/1.0", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "error_msg": {"description": "Error message", "example": "No DIDDoc provided; cannot connect to public DID", "type": "string"}, "inbound_connection_id": {"description": "Inbound routing connection id to use", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation_key": {"description": "Public key for connection", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "invitation_mode": {"description": "Invitation mode", "enum": ["once", "multi", "static"], "example": "once", "type": "string"}, "invitation_msg_id": {"description": "ID of out-of-band invitation message", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "my_did": {"description": "Our DID for connection", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "request_id": {"description": "Connection request identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "rfc23_state": {"description": "State per RFC 23", "example": "invitation-sent", "readOnly": true, "type": "string"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "their_did": {"description": "Their DID for connection", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "their_label": {"description": "Their label for connection", "example": "Bob", "type": "string"}, "their_public_did": {"description": "Other agent's public DID for connection", "example": "2cpBmR3FqGKWi5EyUbpRY8", "type": "string"}, "their_role": {"description": "Their role in the connection protocol", "enum": ["invitee", "requester", "inviter", "responder"], "example": "requester", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "ConnectionInvitation": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "did": {"description": "DID for connection invitation", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "imageUrl": {"description": "Optional image URL for connection invitation", "example": "http://192.168.56.101/img/logo.jpg", "format": "url", "type": "string", "x-nullable": true}, "label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipientKeys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routingKeys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "serviceEndpoint": {"description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020", "type": "string"}}, "type": "object"}, "ConnectionList": {"properties": {"results": {"description": "List of connection records", "items": {"$ref": "#/definitions/ConnRecord"}, "type": "array"}}, "type": "object"}, "ConnectionMetadata": {"properties": {"results": {"description": "Dictionary of metadata associated with connection.", "type": "object"}}, "type": "object"}, "ConnectionMetadataSetRequest": {"properties": {"metadata": {"description": "Dictionary of metadata to set for connection.", "type": "object"}}, "required": ["metadata"], "type": "object"}, "ConnectionModuleResponse": {"properties": {}, "type": "object"}, "ConnectionStaticRequest": {"properties": {"alias": {"description": "Alias to assign to this connection", "type": "string"}, "my_did": {"description": "Local DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "my_seed": {"description": "Seed to use for the local DID", "type": "string"}, "their_did": {"description": "Remote DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "their_endpoint": {"description": "URL endpoint for other party", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "their_label": {"description": "Other party's label for this connection", "type": "string"}, "their_seed": {"description": "Seed to use for the remote DID", "type": "string"}, "their_verkey": {"description": "Remote verification key", "type": "string"}}, "type": "object"}, "ConnectionStaticResult": {"properties": {"my_did": {"description": "Local DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "my_endpoint": {"description": "My URL endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "my_verkey": {"description": "My verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "record": {"$ref": "#/definitions/ConnRecord"}, "their_did": {"description": "Remote DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "their_verkey": {"description": "Remote verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}}, "required": ["my_did", "my_endpoint", "my_verkey", "record", "their_did", "their_verkey"], "type": "object"}, "Constraints": {"properties": {"fields": {"items": {"$ref": "#/definitions/DIFField"}, "type": "array"}, "is_holder": {"items": {"$ref": "#/definitions/DIFHolder"}, "type": "array"}, "limit_disclosure": {"description": "LimitDisclosure", "type": "string"}, "status_active": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "status_revoked": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "status_suspended": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "subject_is_issuer": {"description": "SubjectIsIssuer", "enum": ["required", "preferred"], "type": "string"}}, "type": "object"}, "CreateInvitationRequest": {"properties": {"mediation_id": {"description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "metadata": {"description": "Optional metadata to attach to the connection created with the invitation", "type": "object"}, "my_label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipient_keys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routing_keys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "service_endpoint": {"description": "Connection endpoint", "example": "http://192.168.56.102:8020", "type": "string"}}, "type": "object"}, "CreateWalletRequest": {"properties": {"extra_settings": {"description": "Agent config key-value pairs", "type": "object"}, "image_url": {"description": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", "example": "https://aries.ca/images/sample.png", "type": "string"}, "key_management_mode": {"description": "Key management method to use for this wallet.", "enum": ["managed"], "example": "managed", "type": "string"}, "label": {"description": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", "example": "Alice", "type": "string"}, "wallet_dispatch_type": {"description": "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", "enum": ["default", "both", "base"], "example": "default", "type": "string"}, "wallet_key": {"description": "Master key used for key derivation.", "example": "MySecretKey123", "type": "string"}, "wallet_key_derivation": {"description": "Key derivation", "enum": ["ARGON2I_MOD", "ARGON2I_INT", "RAW"], "example": "RAW", "type": "string"}, "wallet_name": {"description": "Wallet name", "example": "MyNewWallet", "type": "string"}, "wallet_type": {"description": "Type of the wallet to create", "enum": ["askar", "in_memory", "indy"], "example": "indy", "type": "string"}, "wallet_webhook_urls": {"description": "List of Webhook URLs associated with this subwallet", "items": {"description": "Optional webhook URL to receive webhook messages", "example": "http://localhost:8022/webhooks", "type": "string"}, "type": "array"}}, "type": "object"}, "CreateWalletResponse": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "key_management_mode": {"description": "Mode regarding management of wallet key", "enum": ["managed", "unmanaged"], "type": "string"}, "settings": {"description": "Settings for this wallet.", "type": "object"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "token": {"description": "Authorization token to authenticate wallet requests", "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "wallet_id": {"description": "Wallet record ID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["key_management_mode", "wallet_id"], "type": "object"}, "CreateWalletTokenRequest": {"properties": {"wallet_key": {"description": "Master key used for key derivation. Only required for unamanged wallets.", "example": "MySecretKey123", "type": "string"}}, "type": "object"}, "CreateWalletTokenResponse": {"properties": {"token": {"description": "Authorization token to authenticate wallet requests", "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", "type": "string"}}, "type": "object"}, "CredAttrSpec": {"properties": {"mime-type": {"description": "MIME type: omit for (null) default", "example": "image/jpeg", "type": "string", "x-nullable": true}, "name": {"description": "Attribute name", "example": "favourite_drink", "type": "string"}, "value": {"description": "Attribute value: base64-encode if MIME type is present", "example": "martini", "type": "string"}}, "required": ["name", "value"], "type": "object"}, "CredDefValue": {"properties": {"primary": {"allOf": [{"$ref": "#/definitions/CredDefValuePrimary"}], "description": "Primary value for credential definition"}, "revocation": {"allOf": [{"$ref": "#/definitions/CredDefValueRevocation"}], "description": "Revocation value for credential definition"}}, "type": "object"}, "CredDefValuePrimary": {"properties": {"n": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "r": {"$ref": "#/definitions/Generated"}, "rctxt": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "s": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "z": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "CredDefValueRevocation": {"properties": {"g": {"example": "1 1F14F&ECB578F 2 095E45DDF417D", "type": "string"}, "g_dash": {"example": "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D", "type": "string"}, "h": {"example": "1 16675DAE54BFAE8 2 095E45DD417D", "type": "string"}, "h0": {"example": "1 21E5EF9476EAF18 2 095E45DDF417D", "type": "string"}, "h1": {"example": "1 236D1D99236090 2 095E45DDF417D", "type": "string"}, "h2": {"example": "1 1C3AE8D1F1E277 2 095E45DDF417D", "type": "string"}, "h_cap": {"example": "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000", "type": "string"}, "htilde": {"example": "1 1D8549E8C0F8 2 095E45DDF417D", "type": "string"}, "pk": {"example": "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D", "type": "string"}, "u": {"example": "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000", "type": "string"}, "y": {"example": "1 153558BD903312 2 095E45DDF417D 1 0000000000000000", "type": "string"}}, "type": "object"}, "CredInfoList": {"properties": {"results": {"items": {"$ref": "#/definitions/IndyCredInfo"}, "type": "array"}}, "type": "object"}, "CredRevIndyRecordsResult": {"properties": {"rev_reg_delta": {"description": "Indy revocation registry delta", "type": "object"}}, "type": "object"}, "CredRevRecordDetailsResult": {"properties": {"results": {"items": {"$ref": "#/definitions/IssuerCredRevRecord"}, "type": "array"}}, "type": "object"}, "CredRevRecordResult": {"properties": {"result": {"$ref": "#/definitions/IssuerCredRevRecord"}}, "type": "object"}, "CredRevokedResult": {"properties": {"revoked": {"description": "Whether credential is revoked on the ledger", "type": "boolean"}}, "type": "object"}, "Credential": {"properties": {"@context": {"description": "The JSON-LD context of the credential", "example": ["https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"], "items": {}, "type": "array"}, "credentialSubject": {"example": {"alumniOf": {"id": "did:example:c276e12ec21ebfeb1f712ebc6f1"}, "id": "did:example:ebfeb1f712ebc6f1c276e12ec21"}}, "expirationDate": {"description": "The expiration date", "example": "2010-01-01T19:23:24Z", "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", "type": "string"}, "id": {"example": "http://example.edu/credentials/1872", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}, "issuanceDate": {"description": "The issuance date", "example": "2010-01-01T19:23:24Z", "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", "type": "string"}, "issuer": {"description": "The JSON-LD Verifiable Credential Issuer. Either string of object with id field.", "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"}, "proof": {"allOf": [{"$ref": "#/definitions/LinkedDataProof"}], "description": "The proof of the credential", "example": {"created": "2019-12-11T03:50:55", "jws": "eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ", "proofPurpose": "assertionMethod", "type": "Ed25519Signature2018", "verificationMethod": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"}}, "type": {"description": "The JSON-LD type of the credential", "example": ["VerifiableCredential", "AlumniCredential"], "items": {"type": "string"}, "type": "array"}}, "required": ["@context", "credentialSubject", "issuanceDate", "issuer", "type"], "type": "object"}, "CredentialDefinition": {"properties": {"id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "schemaId": {"description": "Schema identifier within credential definition identifier", "example": "20", "type": "string"}, "tag": {"description": "Tag within credential definition identifier", "example": "tag", "type": "string"}, "type": {"default": "CL", "description": "Signature type: CL for Camenisch-Lysyanskaya", "example": "CL"}, "value": {"allOf": [{"$ref": "#/definitions/CredDefValue"}], "description": "Credential definition primary and revocation values"}, "ver": {"description": "Node protocol version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "CredentialDefinitionGetResult": {"properties": {"credential_definition": {"$ref": "#/definitions/CredentialDefinition"}}, "type": "object"}, "CredentialDefinitionSendRequest": {"properties": {"revocation_registry_size": {"description": "Revocation registry size", "example": 1000, "format": "int32", "maximum": 32768, "minimum": 4, "type": "integer"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "support_revocation": {"description": "Revocation supported flag", "type": "boolean"}, "tag": {"description": "Credential definition identifier tag", "example": "default", "type": "string"}}, "type": "object"}, "CredentialDefinitionSendResult": {"properties": {"credential_definition_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}}, "type": "object"}, "CredentialDefinitionsCreatedResult": {"properties": {"credential_definition_ids": {"items": {"description": "Credential definition identifiers", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "type": "array"}}, "type": "object"}, "CredentialOffer": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"$ref": "#/definitions/CredentialPreview"}, "offers~attach": {"items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["offers~attach"], "type": "object"}, "CredentialPreview": {"properties": {"@type": {"description": "Message type identifier", "example": "issue-credential/1.0/credential-preview", "type": "string"}, "attributes": {"items": {"$ref": "#/definitions/CredAttrSpec"}, "type": "array"}}, "required": ["attributes"], "type": "object"}, "CredentialProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "cred_def_id": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "issuer_did": {"example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"type": "string"}, "schema_version": {"example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "CredentialStatusOptions": {"properties": {"type": {"description": "Credential status method type to use for the credential. Should match status method registered in the Verifiable Credential Extension Registry", "example": "CredentialStatusList2017", "type": "string"}}, "required": ["type"], "type": "object"}, "DID": {"properties": {"did": {"description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "key_type": {"description": "Key type associated with the DID", "enum": ["ed25519", "bls12381g2"], "example": "ed25519", "type": "string"}, "method": {"description": "Did method associated with the DID", "example": "sov", "type": "string"}, "posture": {"description": "Whether DID is current public DID, posted to ledger but not current public DID, or local to the wallet", "enum": ["public", "posted", "wallet_only"], "example": "wallet_only", "type": "string"}, "verkey": {"description": "Public verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}}, "type": "object"}, "DIDCreate": {"properties": {"method": {"description": "Method for the requested DID.Supported methods are 'key', 'sov', and any other registered method.", "example": "sov", "type": "string"}, "options": {"allOf": [{"$ref": "#/definitions/DIDCreateOptions"}], "description": "To define a key type and/or a did depending on chosen DID method."}, "seed": {"description": "Optional seed to use for DID, Must beenabled in configuration before use.", "example": "000000000000000000000000Trustee1", "type": "string"}}, "type": "object"}, "DIDCreateOptions": {"properties": {"did": {"description": "Specify final value of the did (including did:: prefix)if the method supports or requires so.", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "key_type": {"description": "Key type to use for the DID keypair. Validated with the chosen DID method's supported key types.", "enum": ["ed25519", "bls12381g2"], "example": "ed25519", "type": "string"}}, "required": ["key_type"], "type": "object"}, "DIDEndpoint": {"properties": {"did": {"description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "endpoint": {"description": "Endpoint to set (omit to delete)", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}}, "required": ["did"], "type": "object"}, "DIDEndpointWithType": {"properties": {"did": {"description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "endpoint": {"description": "Endpoint to set (omit to delete)", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "endpoint_type": {"description": "Endpoint type to set (default 'Endpoint'); affects only public or posted DIDs", "enum": ["Endpoint", "Profile", "LinkedDomains"], "example": "Endpoint", "type": "string"}}, "required": ["did"], "type": "object"}, "DIDList": {"properties": {"results": {"description": "DID list", "items": {"$ref": "#/definitions/DID"}, "type": "array"}}, "type": "object"}, "DIDResult": {"properties": {"result": {"$ref": "#/definitions/DID"}}, "type": "object"}, "DIDXRejectRequest": {"properties": {"reason": {"description": "Reason for rejecting the DID Exchange", "example": "Request rejected", "type": "string"}}, "type": "object"}, "DIDXRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "did": {"description": "DID of exchange", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "did_doc~attach": {"allOf": [{"$ref": "#/definitions/AttachDecorator"}], "description": "As signed attachment, DID Doc associated with DID"}, "goal": {"description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", "example": "To issue a Faber College Graduate credential", "type": "string"}, "goal_code": {"description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", "example": "issue-vc", "type": "string"}, "label": {"description": "Label for DID exchange request", "example": "Request to connect with Bob", "type": "string"}}, "required": ["label"], "type": "object"}, "DIFField": {"properties": {"filter": {"$ref": "#/definitions/Filter"}, "id": {"description": "ID", "type": "string"}, "path": {"items": {"description": "Path", "type": "string"}, "type": "array"}, "predicate": {"description": "Preference", "enum": ["required", "preferred"], "type": "string"}, "purpose": {"description": "Purpose", "type": "string"}}, "type": "object"}, "DIFHolder": {"properties": {"directive": {"description": "Preference", "enum": ["required", "preferred"], "type": "string"}, "field_id": {"items": {"description": "FieldID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "type": "array"}}, "type": "object"}, "DIFOptions": {"properties": {"challenge": {"description": "Challenge protect against replay attack", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "domain": {"description": "Domain protect against replay attack", "example": "4jt78h47fh47", "type": "string"}}, "type": "object"}, "DIFPresSpec": {"properties": {"issuer_id": {"description": "Issuer identifier to sign the presentation, if different from current public DID", "type": "string"}, "presentation_definition": {"$ref": "#/definitions/PresentationDefinition"}, "record_ids": {"description": "Mapping of input_descriptor id to list of stored W3C credential record_id", "example": {"": ["", ""], "": [""]}, "type": "object"}, "reveal_doc": {"description": "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", "example": {"@context": ["https://www.w3.org/2018/credentials/v1", "https://w3id.org/security/bbs/v1"], "@explicit": true, "@requireAll": true, "credentialSubject": {"@explicit": true, "@requireAll": true, "Observation": [{"effectiveDateTime": {}, "@explicit": true, "@requireAll": true}]}, "issuanceDate": {}, "issuer": {}, "type": ["VerifiableCredential", "LabReport"]}, "type": "object"}}, "type": "object"}, "DIFProofProposal": {"properties": {"input_descriptors": {"items": {"$ref": "#/definitions/InputDescriptors"}, "type": "array"}, "options": {"$ref": "#/definitions/DIFOptions"}}, "type": "object"}, "DIFProofRequest": {"properties": {"options": {"$ref": "#/definitions/DIFOptions"}, "presentation_definition": {"$ref": "#/definitions/PresentationDefinition"}}, "required": ["presentation_definition"], "type": "object"}, "Date": {"properties": {"expires_time": {"description": "Expiry Date", "example": "2021-03-29T05:22:19Z", "format": "date-time", "type": "string"}}, "required": ["expires_time"], "type": "object"}, "Disclose": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "protocols": {"description": "List of protocol descriptors", "items": {"$ref": "#/definitions/ProtocolDescriptor"}, "type": "array"}}, "required": ["protocols"], "type": "object"}, "Disclosures": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "disclosures": {"description": "List of protocol or goal_code descriptors", "items": {}, "type": "array"}}, "required": ["disclosures"], "type": "object"}, "Doc": {"properties": {"credential": {"description": "Credential to sign", "type": "object"}, "options": {"allOf": [{"$ref": "#/definitions/SignatureOptions"}], "description": "Signature options"}}, "required": ["credential", "options"], "type": "object"}, "EndorserInfo": {"properties": {"endorser_did": {"description": "Endorser DID", "type": "string"}, "endorser_name": {"description": "Endorser Name", "type": "string"}}, "required": ["endorser_did"], "type": "object"}, "EndpointsResult": {"properties": {"my_endpoint": {"description": "My endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "their_endpoint": {"description": "Their endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}}, "type": "object"}, "Filter": {"properties": {"const": {"description": "Const"}, "enum": {"items": {"description": "Enum"}, "type": "array"}, "exclusiveMaximum": {"description": "ExclusiveMaximum"}, "exclusiveMinimum": {"description": "ExclusiveMinimum"}, "format": {"description": "Format", "type": "string"}, "maxLength": {"description": "Max Length", "example": 1234, "format": "int32", "type": "integer"}, "maximum": {"description": "Maximum"}, "minLength": {"description": "Min Length", "example": 1234, "format": "int32", "type": "integer"}, "minimum": {"description": "Minimum"}, "not": {"description": "Not", "example": false, "type": "boolean"}, "pattern": {"description": "Pattern", "type": "string"}, "type": {"description": "Type", "type": "string"}}, "type": "object"}, "Generated": {"properties": {"master_secret": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "number": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "remainder": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "GetDIDEndpointResponse": {"properties": {"endpoint": {"description": "Full verification key", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string", "x-nullable": true}}, "type": "object"}, "GetDIDVerkeyResponse": {"properties": {"verkey": {"description": "Full verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string", "x-nullable": true}}, "type": "object"}, "GetNymRoleResponse": {"properties": {"role": {"description": "Ledger role", "enum": ["STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "USER", "ROLE_REMOVE"], "example": "ENDORSER", "type": "string"}}, "type": "object"}, "HolderModuleResponse": {"properties": {}, "type": "object"}, "IndyAttrValue": {"properties": {"encoded": {"description": "Attribute encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Attribute raw value", "type": "string"}}, "required": ["encoded", "raw"], "type": "object"}, "IndyCredAbstract": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "key_correctness_proof": {"allOf": [{"$ref": "#/definitions/IndyKeyCorrectnessProof"}], "description": "Key correctness proof"}, "nonce": {"description": "Nonce in credential abstract", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "required": ["cred_def_id", "key_correctness_proof", "nonce", "schema_id"], "type": "object"}, "IndyCredInfo": {"properties": {"attrs": {"additionalProperties": {"example": "alice", "type": "string"}, "description": "Attribute names and value", "type": "object"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string", "x-nullable": true}, "referent": {"description": "Wallet referent", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyCredPrecis": {"properties": {"cred_info": {"allOf": [{"$ref": "#/definitions/IndyCredInfo"}], "description": "Credential info"}, "interval": {"allOf": [{"$ref": "#/definitions/IndyNonRevocationInterval"}], "description": "Non-revocation interval from presentation request"}, "presentation_referents": {"items": {"description": "presentation referent", "example": "1_age_uuid", "type": "string"}, "type": "array"}}, "type": "object"}, "IndyCredRequest": {"properties": {"blinded_ms": {"description": "Blinded master secret", "type": "object"}, "blinded_ms_correctness_proof": {"description": "Blinded master secret correctness proof", "type": "object"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "nonce": {"description": "Nonce in credential request", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "prover_did": {"description": "Prover DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}}, "required": ["blinded_ms", "blinded_ms_correctness_proof", "cred_def_id", "nonce", "prover_did"], "type": "object"}, "IndyCredential": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "rev_reg": {"description": "Revocation registry state", "type": "object", "x-nullable": true}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "signature": {"description": "Credential signature", "type": "object"}, "signature_correctness_proof": {"description": "Credential signature correctness proof", "type": "object"}, "values": {"additionalProperties": {"allOf": [{"$ref": "#/definitions/IndyAttrValue"}], "description": "Attribute value"}, "description": "Credential attributes", "type": "object"}, "witness": {"description": "Witness for revocation proof", "type": "object", "x-nullable": true}}, "required": ["cred_def_id", "schema_id", "signature", "signature_correctness_proof", "values"], "type": "object"}, "IndyEQProof": {"properties": {"a_prime": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "e": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "m": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "m2": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "revealed_attrs": {"additionalProperties": {"example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "type": "object"}, "v": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "IndyGEProof": {"properties": {"alpha": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "mj": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "predicate": {"$ref": "#/definitions/IndyGEProofPred"}, "r": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "t": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "u": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}}, "type": "object"}, "IndyGEProofPred": {"properties": {"attr_name": {"description": "Attribute name, indy-canonicalized", "type": "string"}, "p_type": {"description": "Predicate type", "enum": ["LT", "LE", "GE", "GT"], "type": "string"}, "value": {"description": "Predicate threshold value", "format": "int32", "type": "integer"}}, "type": "object"}, "IndyKeyCorrectnessProof": {"properties": {"c": {"description": "c in key correctness proof", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "xr_cap": {"description": "xr_cap in key correctness proof", "items": {"description": "xr_cap components in key correctness proof", "items": {"description": "xr_cap component values in key correctness proof", "type": "string"}, "type": "array"}, "type": "array"}, "xz_cap": {"description": "xz_cap in key correctness proof", "example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "required": ["c", "xr_cap", "xz_cap"], "type": "object"}, "IndyNonRevocProof": {"properties": {"c_list": {"additionalProperties": {"type": "string"}, "type": "object"}, "x_list": {"additionalProperties": {"type": "string"}, "type": "object"}}, "type": "object"}, "IndyNonRevocationInterval": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyPresAttrSpec": {"properties": {"cred_def_id": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "mime-type": {"description": "MIME type (default null)", "example": "image/jpeg", "type": "string"}, "name": {"description": "Attribute name", "example": "favourite_drink", "type": "string"}, "referent": {"description": "Credential referent", "example": "0", "type": "string"}, "value": {"description": "Attribute value", "example": "martini", "type": "string"}}, "required": ["name"], "type": "object"}, "IndyPresPredSpec": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "name": {"description": "Attribute name", "example": "high_score", "type": "string"}, "predicate": {"description": "Predicate type ('<', '<=', '>=', or '>')", "enum": ["<", "<=", ">=", ">"], "example": ">=", "type": "string"}, "threshold": {"description": "Threshold value", "format": "int32", "type": "integer"}}, "required": ["name", "predicate", "threshold"], "type": "object"}, "IndyPresPreview": {"properties": {"@type": {"description": "Message type identifier", "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/present-proof/1.0/presentation-preview", "type": "string"}, "attributes": {"items": {"$ref": "#/definitions/IndyPresAttrSpec"}, "type": "array"}, "predicates": {"items": {"$ref": "#/definitions/IndyPresPredSpec"}, "type": "array"}}, "required": ["attributes", "predicates"], "type": "object"}, "IndyPresSpec": {"properties": {"requested_attributes": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedAttr"}, "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers", "type": "object"}, "requested_predicates": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedPred"}, "description": "Nested object mapping proof request predicate referents to requested-predicate specifiers", "type": "object"}, "self_attested_attributes": {"additionalProperties": {"description": "Self-attested attribute values to use in requested-credentials structure for proof construction", "example": "self_attested_value", "type": "string"}, "description": "Self-attested attributes to build into proof", "type": "object"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["requested_attributes", "requested_predicates", "self_attested_attributes"], "type": "object"}, "IndyPrimaryProof": {"properties": {"eq_proof": {"allOf": [{"$ref": "#/definitions/IndyEQProof"}], "description": "Indy equality proof", "x-nullable": true}, "ge_proofs": {"description": "Indy GE proofs", "items": {"$ref": "#/definitions/IndyGEProof"}, "type": "array", "x-nullable": true}}, "type": "object"}, "IndyProof": {"properties": {"identifiers": {"description": "Indy proof.identifiers content", "items": {"$ref": "#/definitions/IndyProofIdentifier"}, "type": "array"}, "proof": {"allOf": [{"$ref": "#/definitions/IndyProofProof"}], "description": "Indy proof.proof content"}, "requested_proof": {"allOf": [{"$ref": "#/definitions/IndyProofRequestedProof"}], "description": "Indy proof.requested_proof content"}}, "type": "object"}, "IndyProofIdentifier": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "timestamp": {"description": "Timestamp epoch", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer", "x-nullable": true}}, "type": "object"}, "IndyProofProof": {"properties": {"aggregated_proof": {"allOf": [{"$ref": "#/definitions/IndyProofProofAggregatedProof"}], "description": "Indy proof aggregated proof"}, "proofs": {"description": "Indy proof proofs", "items": {"$ref": "#/definitions/IndyProofProofProofsProof"}, "type": "array"}}, "type": "object"}, "IndyProofProofAggregatedProof": {"properties": {"c_hash": {"description": "c_hash value", "type": "string"}, "c_list": {"description": "c_list value", "items": {"items": {"format": "int32", "type": "integer"}, "type": "array"}, "type": "array"}}, "type": "object"}, "IndyProofProofProofsProof": {"properties": {"non_revoc_proof": {"allOf": [{"$ref": "#/definitions/IndyNonRevocProof"}], "description": "Indy non-revocation proof", "x-nullable": true}, "primary_proof": {"allOf": [{"$ref": "#/definitions/IndyPrimaryProof"}], "description": "Indy primary proof"}}, "type": "object"}, "IndyProofReqAttrSpec": {"properties": {"name": {"description": "Attribute name", "example": "favouriteDrink", "type": "string"}, "names": {"description": "Attribute name group", "items": {"example": "age", "type": "string"}, "type": "array"}, "non_revoked": {"allOf": [{"$ref": "#/definitions/IndyProofReqAttrSpecNonRevoked"}], "x-nullable": true}, "restrictions": {"description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "items": {"additionalProperties": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "type": "string"}, "type": "object"}, "type": "array"}}, "type": "object"}, "IndyProofReqAttrSpecNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofReqPredSpec": {"properties": {"name": {"description": "Attribute name", "example": "index", "type": "string"}, "non_revoked": {"allOf": [{"$ref": "#/definitions/IndyProofReqPredSpecNonRevoked"}], "x-nullable": true}, "p_type": {"description": "Predicate type ('<', '<=', '>=', or '>')", "enum": ["<", "<=", ">=", ">"], "example": ">=", "type": "string"}, "p_value": {"description": "Threshold value", "format": "int32", "type": "integer"}, "restrictions": {"description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "items": {"additionalProperties": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "type": "string"}, "type": "object"}, "type": "array"}}, "required": ["name", "p_type", "p_value"], "type": "object"}, "IndyProofReqPredSpecNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofRequest": {"properties": {"name": {"description": "Proof request name", "example": "Proof request", "type": "string"}, "non_revoked": {"allOf": [{"$ref": "#/definitions/IndyProofRequestNonRevoked"}], "x-nullable": true}, "nonce": {"description": "Nonce", "example": "1", "pattern": "^[1-9][0-9]*$", "type": "string"}, "requested_attributes": {"additionalProperties": {"$ref": "#/definitions/IndyProofReqAttrSpec"}, "description": "Requested attribute specifications of proof request", "type": "object"}, "requested_predicates": {"additionalProperties": {"$ref": "#/definitions/IndyProofReqPredSpec"}, "description": "Requested predicate specifications of proof request", "type": "object"}, "version": {"description": "Proof request version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "required": ["requested_attributes", "requested_predicates"], "type": "object"}, "IndyProofRequestNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofRequestedProof": {"properties": {"predicates": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofPredicate"}, "description": "Proof requested proof predicates.", "type": "object"}, "revealed_attr_groups": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofRevealedAttrGroup"}, "description": "Proof requested proof revealed attribute groups", "type": "object", "x-nullable": true}, "revealed_attrs": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofRevealedAttr"}, "description": "Proof requested proof revealed attributes", "type": "object", "x-nullable": true}, "self_attested_attrs": {"description": "Proof requested proof self-attested attributes", "type": "object"}, "unrevealed_attrs": {"description": "Unrevealed attributes", "type": "object"}}, "type": "object"}, "IndyProofRequestedProofPredicate": {"properties": {"sub_proof_index": {"description": "Sub-proof index", "format": "int32", "type": "integer"}}, "type": "object"}, "IndyProofRequestedProofRevealedAttr": {"properties": {"encoded": {"description": "Encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Raw value", "type": "string"}, "sub_proof_index": {"description": "Sub-proof index", "format": "int32", "type": "integer"}}, "type": "object"}, "IndyProofRequestedProofRevealedAttrGroup": {"properties": {"sub_proof_index": {"description": "Sub-proof index", "format": "int32", "type": "integer"}, "values": {"additionalProperties": {"$ref": "#/definitions/RawEncoded"}, "description": "Indy proof requested proof revealed attr groups group value", "type": "object"}}, "type": "object"}, "IndyRequestedCredsRequestedAttr": {"properties": {"cred_id": {"description": "Wallet credential identifier (typically but not necessarily a UUID)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "revealed": {"description": "Whether to reveal attribute in proof (default true)", "type": "boolean"}}, "required": ["cred_id"], "type": "object"}, "IndyRequestedCredsRequestedPred": {"properties": {"cred_id": {"description": "Wallet credential identifier (typically but not necessarily a UUID)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "timestamp": {"description": "Epoch timestamp of interest for non-revocation proof", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "required": ["cred_id"], "type": "object"}, "IndyRevRegDef": {"properties": {"credDefId": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "id": {"description": "Indy revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "revocDefType": {"description": "Revocation registry type (specify CL_ACCUM)", "enum": ["CL_ACCUM"], "example": "CL_ACCUM", "type": "string"}, "tag": {"description": "Revocation registry tag", "type": "string"}, "value": {"allOf": [{"$ref": "#/definitions/IndyRevRegDefValue"}], "description": "Revocation registry definition value"}, "ver": {"description": "Version of revocation registry definition", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyRevRegDefValue": {"properties": {"issuanceType": {"description": "Issuance type", "enum": ["ISSUANCE_ON_DEMAND", "ISSUANCE_BY_DEFAULT"], "type": "string"}, "maxCredNum": {"description": "Maximum number of credentials; registry size", "example": 10, "format": "int32", "minimum": 1, "type": "integer"}, "publicKeys": {"allOf": [{"$ref": "#/definitions/IndyRevRegDefValuePublicKeys"}], "description": "Public keys"}, "tailsHash": {"description": "Tails hash value", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "tailsLocation": {"description": "Tails file location", "type": "string"}}, "type": "object"}, "IndyRevRegDefValuePublicKeys": {"properties": {"accumKey": {"$ref": "#/definitions/IndyRevRegDefValuePublicKeysAccumKey"}}, "type": "object"}, "IndyRevRegDefValuePublicKeysAccumKey": {"properties": {"z": {"description": "Value for z", "example": "1 120F522F81E6B7 1 09F7A59005C4939854", "type": "string"}}, "type": "object"}, "IndyRevRegEntry": {"properties": {"value": {"allOf": [{"$ref": "#/definitions/IndyRevRegEntryValue"}], "description": "Revocation registry entry value"}, "ver": {"description": "Version of revocation registry entry", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyRevRegEntryValue": {"properties": {"accum": {"description": "Accumulator value", "example": "21 11792B036AED0AAA12A4 4 298B2571FFC63A737", "type": "string"}, "prevAccum": {"description": "Previous accumulator value", "example": "21 137AC810975E4 6 76F0384B6F23", "type": "string"}, "revoked": {"description": "Revoked credential revocation identifiers", "items": {"format": "int32", "type": "integer"}, "type": "array"}}, "type": "object"}, "InputDescriptors": {"properties": {"constraints": {"$ref": "#/definitions/Constraints"}, "group": {"items": {"description": "Group", "type": "string"}, "type": "array"}, "id": {"description": "ID", "type": "string"}, "metadata": {"description": "Metadata dictionary", "type": "object"}, "name": {"description": "Name", "type": "string"}, "purpose": {"description": "Purpose", "type": "string"}, "schema": {"allOf": [{"$ref": "#/definitions/SchemasInputDescriptorFilter"}], "description": "Accepts a list of schema or a dict containing filters like oneof_filter.", "example": {"oneof_filter": [[{"uri": "https://www.w3.org/Test1#Test1"}, {"uri": "https://www.w3.org/Test2#Test2"}], {"oneof_filter": [[{"uri": "https://www.w3.org/Test1#Test1"}], [{"uri": "https://www.w3.org/Test2#Test2"}]]}]}}}, "type": "object"}, "IntroModuleResponse": {"properties": {}, "type": "object"}, "InvitationCreateRequest": {"properties": {"accept": {"description": "List of mime type in order of preference that should be use in responding to the message", "example": ["didcomm/aip1", "didcomm/aip2;env=rfc19"], "items": {"type": "string"}, "type": "array"}, "alias": {"description": "Alias for connection", "example": "Barry", "type": "string"}, "attachments": {"description": "Optional invitation attachments", "items": {"$ref": "#/definitions/AttachmentDef"}, "type": "array"}, "goal": {"description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", "example": "To issue a Faber College Graduate credential", "type": "string"}, "goal_code": {"description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", "example": "issue-vc", "type": "string"}, "handshake_protocols": {"items": {"description": "Handshake protocol to specify in invitation", "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0", "type": "string"}, "type": "array"}, "mediation_id": {"description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "metadata": {"description": "Optional metadata to attach to the connection created with the invitation", "type": "object"}, "my_label": {"description": "Label for connection invitation", "example": "Invitation to Barry", "type": "string"}, "protocol_version": {"description": "OOB protocol version", "example": "1.1", "type": "string"}, "use_public_did": {"description": "Whether to use public DID in invitation", "example": false, "type": "boolean"}}, "type": "object"}, "InvitationMessage": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "accept": {"description": "List of mime type in order of preference", "example": ["didcomm/aip1", "didcomm/aip2;env=rfc19"], "items": {"type": "string"}, "type": "array"}, "goal": {"description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", "example": "To issue a Faber College Graduate credential", "type": "string"}, "goal_code": {"description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", "example": "issue-vc", "type": "string"}, "handshake_protocols": {"items": {"description": "Handshake protocol", "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0", "type": "string"}, "type": "array"}, "imageUrl": {"description": "Optional image URL for out-of-band invitation", "example": "http://192.168.56.101/img/logo.jpg", "format": "url", "type": "string", "x-nullable": true}, "label": {"description": "Optional label", "example": "Bob", "type": "string"}, "requests~attach": {"description": "Optional request attachment", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}, "services": {"example": [{"did": "WgWxqztrNooG92RXvxSTWv", "id": "string", "recipientKeys": ["did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"], "routingKeys": ["did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"], "serviceEndpoint": "http://192.168.56.101:8020", "type": "string"}, "did:sov:WgWxqztrNooG92RXvxSTWv"], "items": {"description": "Either a DIDComm service object (as per RFC0067) or a DID string."}, "type": "array"}}, "type": "object"}, "InvitationRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "invi_msg_id": {"description": "Invitation message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation": {"allOf": [{"$ref": "#/definitions/InvitationMessage"}], "description": "Out of band invitation message"}, "invitation_id": {"description": "Invitation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation_url": {"description": "Invitation message URL", "example": "https://example.com/endpoint?c_i=eyJAdHlwZSI6ICIuLi4iLCAiLi4uIjogIi4uLiJ9XX0=", "type": "string"}, "oob_id": {"description": "Out of band record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "state": {"description": "Out of band message exchange state", "example": "await_response", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "InvitationResult": {"properties": {"connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation": {"$ref": "#/definitions/ConnectionInvitation"}, "invitation_url": {"description": "Invitation URL", "example": "http://192.168.56.101:8020/invite?c_i=eyJAdHlwZSI6Li4ufQ==", "type": "string"}}, "type": "object"}, "IssueCredentialModuleResponse": {"properties": {}, "type": "object"}, "IssuerCredRevRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "cred_ex_id": {"description": "Credential exchange record identifier at credential issue", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_ex_version": {"description": "Credential exchange version", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "record_id": {"description": "Issuer credential revocation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "state": {"description": "Issue credential revocation record state", "example": "issued", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "IssuerRevRegRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "error_msg": {"description": "Error message", "example": "Revocation registry undefined", "type": "string"}, "issuer_did": {"description": "Issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "max_cred_num": {"description": "Maximum number of credentials for revocation registry", "example": 1000, "format": "int32", "type": "integer"}, "pending_pub": {"description": "Credential revocation identifier for credential revoked and pending publication to ledger", "items": {"example": "23", "type": "string"}, "type": "array"}, "record_id": {"description": "Issuer revocation registry record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "revoc_def_type": {"description": "Revocation registry type (specify CL_ACCUM)", "enum": ["CL_ACCUM"], "example": "CL_ACCUM", "type": "string"}, "revoc_reg_def": {"allOf": [{"$ref": "#/definitions/IndyRevRegDef"}], "description": "Revocation registry definition"}, "revoc_reg_entry": {"allOf": [{"$ref": "#/definitions/IndyRevRegEntry"}], "description": "Revocation registry entry"}, "revoc_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "state": {"description": "Issue revocation registry record state", "example": "active", "type": "string"}, "tag": {"description": "Tag within issuer revocation registry identifier", "type": "string"}, "tails_hash": {"description": "Tails hash", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "tails_local_path": {"description": "Local path to tails file", "type": "string"}, "tails_public_uri": {"description": "Public URI for tails file", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "JWSCreate": {"properties": {"did": {"description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "headers": {"type": "object"}, "payload": {"type": "object"}, "verificationMethod": {"description": "Information used for proof verification", "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}}, "required": ["payload"], "type": "object"}, "JWSVerify": {"properties": {"jwt": {"example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", "pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+$", "type": "string"}}, "type": "object"}, "JWSVerifyResponse": {"properties": {"error": {"description": "Error text", "type": "string"}, "headers": {"description": "Headers from verified JWT.", "type": "object"}, "kid": {"description": "kid of signer", "type": "string"}, "payload": {"description": "Payload from verified JWT", "type": "object"}, "valid": {"type": "boolean"}}, "required": ["headers", "kid", "payload", "valid"], "type": "object"}, "Keylist": {"properties": {"results": {"description": "List of keylist records", "items": {"$ref": "#/definitions/RouteRecord"}, "type": "array"}}, "type": "object"}, "KeylistQuery": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "filter": {"description": "Query dictionary object", "example": {"filter": {}}, "type": "object"}, "paginate": {"allOf": [{"$ref": "#/definitions/KeylistQueryPaginate"}], "description": "Pagination info"}}, "type": "object"}, "KeylistQueryFilterRequest": {"properties": {"filter": {"description": "Filter for keylist query", "type": "object"}}, "type": "object"}, "KeylistQueryPaginate": {"properties": {"limit": {"description": "Limit for keylist query", "example": 30, "format": "int32", "type": "integer"}, "offset": {"description": "Offset value for query", "example": 0, "format": "int32", "type": "integer"}}, "type": "object"}, "KeylistUpdate": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "updates": {"description": "List of update rules", "items": {"$ref": "#/definitions/KeylistUpdateRule"}, "type": "array"}}, "type": "object"}, "KeylistUpdateRequest": {"properties": {"updates": {"items": {"$ref": "#/definitions/KeylistUpdateRule"}, "type": "array"}}, "type": "object"}, "KeylistUpdateRule": {"properties": {"action": {"description": "Action for specific key", "enum": ["add", "remove"], "example": "add", "type": "string"}, "recipient_key": {"description": "Key to remove or add", "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$|^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}}, "required": ["action", "recipient_key"], "type": "object"}, "LDProofVCDetail": {"properties": {"credential": {"allOf": [{"$ref": "#/definitions/Credential"}], "description": "Detail of the JSON-LD Credential to be issued", "example": {"@context": ["https://www.w3.org/2018/credentials/v1", "https://w3id.org/citizenship/v1"], "credentialSubject": {"familyName": "SMITH", "gender": "Male", "givenName": "JOHN", "type": ["PermanentResident", "Person"]}, "description": "Government of Example Permanent Resident Card.", "identifier": "83627465", "issuanceDate": "2019-12-03T12:19:52Z", "issuer": "did:key:z6MkmjY8GnV5i9YTDtPETC2uUAW6ejw3nk5mXF5yci5ab7th", "name": "Permanent Resident Card", "type": ["VerifiableCredential", "PermanentResidentCard"]}}, "options": {"allOf": [{"$ref": "#/definitions/LDProofVCDetailOptions"}], "description": "Options for specifying how the linked data proof is created.", "example": {"proofType": "Ed25519Signature2018"}}}, "required": ["credential", "options"], "type": "object"}, "LDProofVCDetailOptions": {"properties": {"challenge": {"description": "A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created": {"description": "The date and time of the proof (with a maximum accuracy in seconds). Defaults to current system time", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "credentialStatus": {"allOf": [{"$ref": "#/definitions/CredentialStatusOptions"}], "description": "The credential status mechanism to use for the credential. Omitting the property indicates the issued credential will not include a credential status"}, "domain": {"description": "The intended domain of validity for the proof", "example": "example.com", "type": "string"}, "proofPurpose": {"description": "The proof purpose used for the proof. Should match proof purposes registered in the Linked Data Proofs Specification", "example": "assertionMethod", "type": "string"}, "proofType": {"description": "The proof type used for the proof. Should match suites registered in the Linked Data Cryptographic Suite Registry", "example": "Ed25519Signature2018", "type": "string"}}, "required": ["proofType"], "type": "object"}, "LedgerConfigInstance": {"properties": {"genesis_file": {"description": "genesis_file", "type": "string"}, "genesis_transactions": {"description": "genesis_transactions", "type": "string"}, "genesis_url": {"description": "genesis_url", "type": "string"}, "id": {"description": "ledger_id", "type": "string"}, "is_production": {"description": "is_production", "type": "boolean"}}, "type": "object"}, "LedgerConfigList": {"properties": {"ledger_config_list": {"items": {"$ref": "#/definitions/LedgerConfigInstance"}, "type": "array"}}, "required": ["ledger_config_list"], "type": "object"}, "LedgerModulesResult": {"properties": {}, "type": "object"}, "LinkedDataProof": {"properties": {"challenge": {"description": "Associates a challenge with a proof, for use with a proofPurpose such as authentication", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created": {"description": "The string value of an ISO8601 combined date and time string generated by the Signature Algorithm", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "domain": {"description": "A string value specifying the restricted domain of the signature.", "example": "example.com", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}, "jws": {"description": "Associates a Detached Json Web Signature with a proof", "example": "eyJhbGciOiAiRWREUc2UsICJjcml0IjogWyJiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQ1Ch6YBKY7UBAjg6iBX5qBQ", "type": "string"}, "nonce": {"description": "The nonce", "example": "CF69iO3nfvqRsRBNElE8b4wO39SyJHPM7Gg1nExltW5vSfQA1lvDCR/zXX1To0/4NLo==", "type": "string"}, "proofPurpose": {"description": "Proof purpose", "example": "assertionMethod", "type": "string"}, "proofValue": {"description": "The proof value of a proof", "example": "sy1AahqbzJQ63n9RtekmwzqZeVj494VppdAVJBnMYrTwft6cLJJGeTSSxCCJ6HKnRtwE7jjDh6sB2z2AAiZY9BBnCD8wUVgwqH3qchGRCuC2RugA4eQ9fUrR4Yuycac3caiaaay", "type": "string"}, "type": {"description": "Identifies the digital signature suite that was used to create the signature", "example": "Ed25519Signature2018", "type": "string"}, "verificationMethod": {"description": "Information used for proof verification", "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}}, "required": ["created", "proofPurpose", "type", "verificationMethod"], "type": "object"}, "MediationCreateRequest": {"properties": {}, "type": "object"}, "MediationDeny": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}}, "type": "object"}, "MediationGrant": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "endpoint": {"description": "endpoint on which messages destined for the recipient are received.", "example": "http://192.168.56.102:8020/", "type": "string"}, "routing_keys": {"items": {"description": "Keys to use for forward message packaging", "type": "string"}, "type": "array"}}, "type": "object"}, "MediationIdMatchInfo": {"properties": {"mediation_id": {"description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid", "type": "string"}}, "type": "object"}, "MediationList": {"properties": {"results": {"description": "List of mediation records", "items": {"$ref": "#/definitions/MediationRecord"}, "type": "array"}}, "type": "object"}, "MediationRecord": {"properties": {"connection_id": {"type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "endpoint": {"type": "string"}, "mediation_id": {"type": "string"}, "mediator_terms": {"items": {"type": "string"}, "type": "array"}, "recipient_terms": {"items": {"type": "string"}, "type": "array"}, "role": {"type": "string"}, "routing_keys": {"items": {"example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$", "type": "string"}, "type": "array"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "required": ["connection_id", "role"], "type": "object"}, "Menu": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "description": {"description": "Introductory text for the menu", "example": "This menu presents options", "type": "string"}, "errormsg": {"description": "An optional error message to display in menu header", "example": "Error: item not found", "type": "string"}, "options": {"description": "List of menu options", "items": {"$ref": "#/definitions/MenuOption"}, "type": "array"}, "title": {"description": "Menu title", "example": "My Menu", "type": "string"}}, "required": ["options"], "type": "object"}, "MenuForm": {"properties": {"description": {"description": "Additional descriptive text for menu form", "example": "Window preference settings", "type": "string"}, "params": {"description": "List of form parameters", "items": {"$ref": "#/definitions/MenuFormParam"}, "type": "array"}, "submit-label": {"description": "Alternative label for form submit button", "example": "Send", "type": "string"}, "title": {"description": "Menu form title", "example": "Preferences", "type": "string"}}, "type": "object"}, "MenuFormParam": {"properties": {"default": {"description": "Default parameter value", "example": "0", "type": "string"}, "description": {"description": "Additional descriptive text for menu form parameter", "example": "Delay in seconds before starting", "type": "string"}, "name": {"description": "Menu parameter name", "example": "delay", "type": "string"}, "required": {"description": "Whether parameter is required", "example": "False", "type": "boolean"}, "title": {"description": "Menu parameter title", "example": "Delay in seconds", "type": "string"}, "type": {"description": "Menu form parameter input type", "example": "int", "type": "string"}}, "required": ["name", "title"], "type": "object"}, "MenuJson": {"properties": {"description": {"description": "Introductory text for the menu", "example": "User preferences for window settings", "type": "string"}, "errormsg": {"description": "Optional error message to display in menu header", "example": "Error: item not present", "type": "string"}, "options": {"description": "List of menu options", "items": {"$ref": "#/definitions/MenuOption"}, "type": "array"}, "title": {"description": "Menu title", "example": "My Menu", "type": "string"}}, "required": ["options"], "type": "object"}, "MenuOption": {"properties": {"description": {"description": "Additional descriptive text for menu option", "example": "Window display preferences", "type": "string"}, "disabled": {"description": "Whether to show option as disabled", "example": "False", "type": "boolean"}, "form": {"$ref": "#/definitions/MenuForm"}, "name": {"description": "Menu option name (unique identifier)", "example": "window_prefs", "type": "string"}, "title": {"description": "Menu option title", "example": "Window Preferences", "type": "string"}}, "required": ["name", "title"], "type": "object"}, "MultitenantModuleResponse": {"properties": {}, "type": "object"}, "OobRecord": {"properties": {"attach_thread_id": {"description": "Connection record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "connection_id": {"description": "Connection record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "invi_msg_id": {"description": "Invitation message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation": {"allOf": [{"$ref": "#/definitions/InvitationMessage"}], "description": "Out of band invitation message"}, "oob_id": {"description": "Oob record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "our_recipient_key": {"description": "Recipient key used for oob invitation", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "role": {"description": "OOB Role", "enum": ["sender", "receiver"], "example": "receiver", "type": "string"}, "state": {"description": "Out of band message exchange state", "enum": ["initial", "prepare-response", "await-response", "reuse-not-accepted", "reuse-accepted", "done", "deleted"], "example": "await-response", "type": "string"}, "their_service": {"$ref": "#/definitions/ServiceDecorator"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "required": ["invi_msg_id", "invitation", "oob_id", "state"], "type": "object"}, "PerformRequest": {"properties": {"name": {"description": "Menu option name", "example": "Query", "type": "string"}, "params": {"additionalProperties": {"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "description": "Input parameter values", "type": "object"}}, "type": "object"}, "PingRequest": {"properties": {"comment": {"description": "Comment for the ping message", "type": "string", "x-nullable": true}}, "type": "object"}, "PingRequestResponse": {"properties": {"thread_id": {"description": "Thread ID of the ping message", "type": "string"}}, "type": "object"}, "PresentationDefinition": {"properties": {"format": {"$ref": "#/definitions/ClaimFormat"}, "id": {"description": "Unique Resource Identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "input_descriptors": {"items": {"$ref": "#/definitions/InputDescriptors"}, "type": "array"}, "name": {"description": "Human-friendly name that describes what the presentation definition pertains to", "type": "string"}, "purpose": {"description": "Describes the purpose for which the Presentation Definition's inputs are being requested", "type": "string"}, "submission_requirements": {"items": {"$ref": "#/definitions/SubmissionRequirements"}, "type": "array"}}, "type": "object"}, "PresentationProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "presentation_proposal": {"$ref": "#/definitions/IndyPresPreview"}}, "required": ["presentation_proposal"], "type": "object"}, "PresentationRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "request_presentations~attach": {"items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["request_presentations~attach"], "type": "object"}, "ProfileSettings": {"properties": {"settings": {"description": "Profile settings dict", "example": {"debug.invite_public": true, "log.level": "INFO", "public_invites": false}, "type": "object"}}, "type": "object"}, "ProtocolDescriptor": {"properties": {"pid": {"type": "string"}, "roles": {"description": "List of roles", "items": {"description": "Role: requester or responder", "example": "requester", "type": "string"}, "type": "array", "x-nullable": true}}, "required": ["pid"], "type": "object"}, "PublishRevocations": {"properties": {"rrid2crid": {"additionalProperties": {"items": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "type": "array"}, "description": "Credential revocation ids by revocation registry id", "type": "object"}}, "type": "object"}, "Queries": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "queries": {"items": {"$ref": "#/definitions/QueryItem"}, "type": "array"}}, "type": "object"}, "Query": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"type": "string", "x-nullable": true}, "query": {"type": "string"}}, "required": ["query"], "type": "object"}, "QueryItem": {"properties": {"feature-type": {"description": "feature type", "enum": ["protocol", "goal-code"], "type": "string"}, "match": {"description": "match", "type": "string"}}, "required": ["feature-type", "match"], "type": "object"}, "RawEncoded": {"properties": {"encoded": {"description": "Encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Raw value", "type": "string"}}, "type": "object"}, "ReceiveInvitationRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "did": {"description": "DID for connection invitation", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "imageUrl": {"description": "Optional image URL for connection invitation", "example": "http://192.168.56.101/img/logo.jpg", "format": "url", "type": "string", "x-nullable": true}, "label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipientKeys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routingKeys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "serviceEndpoint": {"description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020", "type": "string"}}, "type": "object"}, "RemoveWalletRequest": {"properties": {"wallet_key": {"description": "Master key used for key derivation. Only required for unmanaged wallets.", "example": "MySecretKey123", "type": "string"}}, "type": "object"}, "ResolutionResult": {"properties": {"did_document": {"description": "DID Document", "type": "object"}, "metadata": {"description": "Resolution metadata", "type": "object"}}, "required": ["did_document", "metadata"], "type": "object"}, "RevRegCreateRequest": {"properties": {"credential_definition_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "max_cred_num": {"description": "Revocation registry size", "example": 1000, "format": "int32", "maximum": 32768, "minimum": 4, "type": "integer"}}, "type": "object"}, "RevRegIssuedResult": {"properties": {"result": {"description": "Number of credentials issued against revocation registry", "example": 0, "format": "int32", "minimum": 0, "type": "integer"}}, "type": "object"}, "RevRegResult": {"properties": {"result": {"$ref": "#/definitions/IssuerRevRegRecord"}}, "type": "object"}, "RevRegUpdateTailsFileUri": {"properties": {"tails_public_uri": {"description": "Public URI to the tails file", "example": "http://192.168.56.133:6543/revocation/registry/WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0/tails-file", "format": "url", "type": "string"}}, "required": ["tails_public_uri"], "type": "object"}, "RevRegWalletUpdatedResult": {"properties": {"accum_calculated": {"description": "Calculated accumulator for phantom revocations", "type": "object"}, "accum_fixed": {"description": "Applied ledger transaction to fix revocations", "type": "object"}, "rev_reg_delta": {"description": "Indy revocation registry delta", "type": "object"}}, "type": "object"}, "RevRegsCreated": {"properties": {"rev_reg_ids": {"items": {"description": "Revocation registry identifiers", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "type": "array"}}, "type": "object"}, "RevocationModuleResponse": {"properties": {}, "type": "object"}, "RevokeRequest": {"properties": {"comment": {"description": "Optional comment to include in revocation notification", "type": "string"}, "connection_id": {"description": "Connection ID to which the revocation notification will be sent; required if notify is true", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "cred_ex_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "notify": {"description": "Send a notification to the credential recipient", "type": "boolean"}, "notify_version": {"description": "Specify which version of the revocation notification should be sent", "enum": ["v1_0", "v2_0"], "type": "string"}, "publish": {"description": "(True) publish revocation to ledger immediately, or (default, False) mark it pending", "type": "boolean"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "thread_id": {"description": "Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true", "type": "string"}}, "type": "object"}, "RouteRecord": {"properties": {"connection_id": {"type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "recipient_key": {"type": "string"}, "record_id": {"type": "string"}, "role": {"type": "string"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "wallet_id": {"type": "string"}}, "required": ["recipient_key"], "type": "object"}, "SDJWSCreate": {"properties": {"did": {"description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "headers": {"type": "object"}, "non_sd_list": {"items": {"example": ["name", "address", "address.street_address", "nationalities[1:3]"], "pattern": "[a-z0-9:\\[\\]_\\.@?\\(\\)]", "type": "string"}, "type": "array"}, "payload": {"type": "object"}, "verificationMethod": {"description": "Information used for proof verification", "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}}, "required": ["payload"], "type": "object"}, "SDJWSVerify": {"properties": {"sd_jwt": {"example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk~WyJEM3BUSFdCYWNRcFdpREc2TWZKLUZnIiwgIkRFIl0~WyJPMTFySVRjRTdHcXExYW9oRkd0aDh3IiwgIlNBIl0~WyJkVmEzX1JlTGNsWTU0R1FHZm5oWlRnIiwgInVwZGF0ZWRfYXQiLCAxNTcwMDAwMDAwXQ", "pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+(?:~[a-zA-Z0-9._-]+)*~?$", "type": "string"}}, "type": "object"}, "SDJWSVerifyResponse": {"properties": {"disclosures": {"description": "Disclosure arrays associated with the SD-JWT", "example": [["fx1iT_mETjGiC-JzRARnVg", "name", "Alice"], ["n4-t3mlh8jSS6yMIT7QHnA", "street_address", {"_sd": ["kLZrLK7enwfqeOzJ9-Ss88YS3mhjOAEk9lr_ix2Heng"]}]], "items": {"items": {}, "type": "array"}, "type": "array"}, "error": {"description": "Error text", "type": "string"}, "headers": {"description": "Headers from verified JWT.", "type": "object"}, "kid": {"description": "kid of signer", "type": "string"}, "payload": {"description": "Payload from verified JWT", "type": "object"}, "valid": {"type": "boolean"}}, "required": ["headers", "kid", "payload", "valid"], "type": "object"}, "Schema": {"properties": {"attrNames": {"description": "Schema attribute names", "items": {"description": "Attribute name", "example": "score", "type": "string"}, "type": "array"}, "id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "name": {"description": "Schema name", "example": "schema_name", "type": "string"}, "seqNo": {"description": "Schema sequence number", "example": 10, "format": "int32", "minimum": 1, "type": "integer"}, "ver": {"description": "Node protocol version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}, "version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "SchemaGetResult": {"properties": {"schema": {"$ref": "#/definitions/Schema"}}, "type": "object"}, "SchemaInputDescriptor": {"properties": {"required": {"description": "Required", "type": "boolean"}, "uri": {"description": "URI", "type": "string"}}, "type": "object"}, "SchemaSendRequest": {"properties": {"attributes": {"description": "List of schema attributes", "items": {"description": "attribute name", "example": "score", "type": "string"}, "type": "array"}, "schema_name": {"description": "Schema name", "example": "prefs", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "required": ["attributes", "schema_name", "schema_version"], "type": "object"}, "SchemaSendResult": {"properties": {"schema": {"allOf": [{"$ref": "#/definitions/Schema"}], "description": "Schema definition"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "required": ["schema_id"], "type": "object"}, "SchemasCreatedResult": {"properties": {"schema_ids": {"items": {"description": "Schema identifiers", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "type": "array"}}, "type": "object"}, "SchemasInputDescriptorFilter": {"properties": {"oneof_filter": {"description": "oneOf", "type": "boolean"}, "uri_groups": {"items": {"items": {"$ref": "#/definitions/SchemaInputDescriptor"}, "type": "array"}, "type": "array"}}, "type": "object"}, "SendMenu": {"properties": {"menu": {"allOf": [{"$ref": "#/definitions/MenuJson"}], "description": "Menu to send to connection"}}, "required": ["menu"], "type": "object"}, "SendMessage": {"properties": {"content": {"description": "Message content", "example": "Hello", "type": "string"}}, "type": "object"}, "ServiceDecorator": {"properties": {"recipientKeys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routingKeys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "serviceEndpoint": {"description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020", "type": "string"}}, "required": ["recipientKeys", "serviceEndpoint"], "type": "object"}, "SignRequest": {"properties": {"doc": {"$ref": "#/definitions/Doc"}, "verkey": {"description": "Verkey to use for signing", "type": "string"}}, "required": ["doc", "verkey"], "type": "object"}, "SignResponse": {"properties": {"error": {"description": "Error text", "type": "string"}, "signed_doc": {"description": "Signed document", "type": "object"}}, "type": "object"}, "SignatureOptions": {"properties": {"challenge": {"type": "string"}, "domain": {"type": "string"}, "proofPurpose": {"type": "string"}, "type": {"type": "string"}, "verificationMethod": {"type": "string"}}, "required": ["proofPurpose", "verificationMethod"], "type": "object"}, "SignedDoc": {"properties": {"proof": {"allOf": [{"$ref": "#/definitions/SignatureOptions"}], "description": "Linked data proof"}}, "required": ["proof"], "type": "object"}, "SubmissionRequirements": {"properties": {"count": {"description": "Count Value", "example": 1234, "format": "int32", "type": "integer"}, "from": {"description": "From", "type": "string"}, "from_nested": {"items": {"$ref": "#/definitions/SubmissionRequirements"}, "type": "array"}, "max": {"description": "Max Value", "example": 1234, "format": "int32", "type": "integer"}, "min": {"description": "Min Value", "example": 1234, "format": "int32", "type": "integer"}, "name": {"description": "Name", "type": "string"}, "purpose": {"description": "Purpose", "type": "string"}, "rule": {"description": "Selection", "enum": ["all", "pick"], "type": "string"}}, "type": "object"}, "TAAAccept": {"properties": {"mechanism": {"type": "string"}, "text": {"type": "string"}, "version": {"type": "string"}}, "type": "object"}, "TAAAcceptance": {"properties": {"mechanism": {"type": "string"}, "time": {"example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "TAAInfo": {"properties": {"aml_record": {"$ref": "#/definitions/AMLRecord"}, "taa_accepted": {"$ref": "#/definitions/TAAAcceptance"}, "taa_record": {"$ref": "#/definitions/TAARecord"}, "taa_required": {"type": "boolean"}}, "type": "object"}, "TAARecord": {"properties": {"digest": {"type": "string"}, "text": {"type": "string"}, "version": {"type": "string"}}, "type": "object"}, "TAAResult": {"properties": {"result": {"$ref": "#/definitions/TAAInfo"}}, "type": "object"}, "TailsDeleteResponse": {"properties": {"message": {"type": "string"}}, "type": "object"}, "TransactionJobs": {"properties": {"transaction_my_job": {"description": "My transaction related job", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "type": "string"}, "transaction_their_job": {"description": "Their transaction related job", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "type": "string"}}, "type": "object"}, "TransactionList": {"properties": {"results": {"description": "List of transaction records", "items": {"$ref": "#/definitions/TransactionRecord"}, "type": "array"}}, "type": "object"}, "TransactionRecord": {"properties": {"_type": {"description": "Transaction type", "example": "101", "type": "string"}, "connection_id": {"description": "The connection identifier for thie particular transaction record", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "endorser_write_txn": {"description": "If True, Endorser will write the transaction after endorsing it", "example": true, "type": "boolean"}, "formats": {"items": {"additionalProperties": {"type": "string"}, "example": {"attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "dif/endorse-transaction/request@v1.0"}, "type": "object"}, "type": "array"}, "messages_attach": {"items": {"example": {"@id": "143c458d-1b1c-40c7-ab85-4d16808ddf0a", "data": {"json": "{\"endorser\": \"V4SGRU86Z58d6TV7PBUe6f\",\"identifier\": \"LjgpST2rjsoxYegQDRm7EL\",\"operation\": {\"data\": {\"attr_names\": [\"first_name\", \"last_name\"],\"name\": \"test_schema\",\"version\": \"2.1\",},\"type\": \"101\",},\"protocolVersion\": 2,\"reqId\": 1597766666168851000,\"signatures\": {\"LjgpST2rjsox\": \"4ATKMn6Y9sTgwqaGTm7py2c2M8x1EVDTWKZArwyuPgjU\"}, \"taaAcceptance\": {\"mechanism\": \"manual\",\"taaDigest\": \"f50fe2c2ab977006761d36bd6f23e4c6a7e0fc2feb9f62\",\"time\": 1597708800,}}"}, "mime-type": "application/json"}, "type": "object"}, "type": "array"}, "meta_data": {"example": {"context": {"param1": "param1_value", "param2": "param2_value"}, "post_process": [{"topic": "topic_value", "other": "other_value"}]}, "type": "object"}, "signature_request": {"items": {"example": {"author_goal_code": "aries.transaction.ledger.write", "context": "did:sov", "method": "add-signature", "signature_type": "", "signer_goal_code": "aries.transaction.endorse"}, "type": "object"}, "type": "array"}, "signature_response": {"items": {"example": {"context": "did:sov", "message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "method": "add-signature", "signer_goal_code": "aries.transaction.refuse"}, "type": "object"}, "type": "array"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "thread_id": {"description": "Thread Identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "timing": {"example": {"expires_time": "2020-12-13T17:29:06+0000"}, "type": "object"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "transaction_id": {"description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "TxnOrCredentialDefinitionSendResult": {"properties": {"sent": {"$ref": "#/definitions/CredentialDefinitionSendResult"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Credential definition transaction to endorse"}}, "type": "object"}, "TxnOrPublishRevocationsResult": {"properties": {"sent": {"$ref": "#/definitions/PublishRevocations"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Revocation registry revocations transaction to endorse"}}, "type": "object"}, "TxnOrRegisterLedgerNymResponse": {"properties": {"success": {"description": "Success of nym registration operation", "example": true, "type": "boolean"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "DID transaction to endorse"}}, "type": "object"}, "TxnOrRevRegResult": {"properties": {"sent": {"$ref": "#/definitions/RevRegResult"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Revocation registry definition transaction to endorse"}}, "type": "object"}, "TxnOrSchemaSendResult": {"properties": {"sent": {"allOf": [{"$ref": "#/definitions/SchemaSendResult"}], "description": "Content sent"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Schema transaction to endorse"}}, "type": "object"}, "UpdateProfileSettings": {"properties": {"extra_settings": {"description": "Agent config key-value pairs", "example": {"ACAPY_INVITE_PUBLIC": true, "log-level": "INFO", "public-invites": false}, "type": "object"}}, "type": "object"}, "UpdateWalletRequest": {"properties": {"extra_settings": {"description": "Agent config key-value pairs", "type": "object"}, "image_url": {"description": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", "example": "https://aries.ca/images/sample.png", "type": "string"}, "label": {"description": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", "example": "Alice", "type": "string"}, "wallet_dispatch_type": {"description": "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", "enum": ["default", "both", "base"], "example": "default", "type": "string"}, "wallet_webhook_urls": {"description": "List of Webhook URLs associated with this subwallet", "items": {"description": "Optional webhook URL to receive webhook messages", "example": "http://localhost:8022/webhooks", "type": "string"}, "type": "array"}}, "type": "object"}, "V10CredentialBoundOfferRequest": {"properties": {"counter_proposal": {"allOf": [{"$ref": "#/definitions/CredentialProposal"}], "description": "Optional counter-proposal"}}, "type": "object"}, "V10CredentialConnFreeOfferRequest": {"properties": {"auto_issue": {"description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_preview": {"$ref": "#/definitions/CredentialPreview"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["cred_def_id", "credential_preview"], "type": "object"}, "V10CredentialCreate": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "issuer_did": {"description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"description": "Schema name", "example": "preferences", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["credential_proposal"], "type": "object"}, "V10CredentialExchange": {"properties": {"auto_issue": {"description": "Issuer choice to issue to request in this credential exchange", "example": false, "type": "boolean"}, "auto_offer": {"description": "Holder choice to accept offer in this credential exchange", "example": false, "type": "boolean"}, "auto_remove": {"description": "Issuer choice to remove this credential exchange record when complete", "example": false, "type": "boolean"}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "credential": {"allOf": [{"$ref": "#/definitions/IndyCredInfo"}], "description": "Credential as stored"}, "credential_definition_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_exchange_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "credential_id": {"description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "credential_offer": {"allOf": [{"$ref": "#/definitions/IndyCredAbstract"}], "description": "(Indy) credential offer"}, "credential_offer_dict": {"allOf": [{"$ref": "#/definitions/CredentialOffer"}], "description": "Credential offer message"}, "credential_proposal_dict": {"allOf": [{"$ref": "#/definitions/CredentialProposal"}], "description": "Credential proposal message"}, "credential_request": {"allOf": [{"$ref": "#/definitions/IndyCredRequest"}], "description": "(Indy) credential request"}, "credential_request_metadata": {"description": "(Indy) credential request metadata", "type": "object"}, "error_msg": {"description": "Error message", "example": "Credential definition identifier is not set in proposal", "type": "string"}, "initiator": {"description": "Issue-credential exchange initiator: self or external", "enum": ["self", "external"], "example": "self", "type": "string"}, "parent_thread_id": {"description": "Parent thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "raw_credential": {"allOf": [{"$ref": "#/definitions/IndyCredential"}], "description": "Credential as received, prior to storage in holder wallet"}, "revoc_reg_id": {"description": "Revocation registry identifier", "type": "string"}, "revocation_id": {"description": "Credential identifier within revocation registry", "type": "string"}, "role": {"description": "Issue-credential exchange role: holder or issuer", "enum": ["holder", "issuer"], "example": "issuer", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "state": {"description": "Issue-credential exchange state", "example": "credential_acked", "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V10CredentialExchangeAutoRemoveRequest": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}}, "type": "object"}, "V10CredentialExchangeListResult": {"properties": {"results": {"description": "Aries#0036 v1.0 credential exchange records", "items": {"$ref": "#/definitions/V10CredentialExchange"}, "type": "array"}}, "type": "object"}, "V10CredentialFreeOfferRequest": {"properties": {"auto_issue": {"description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_preview": {"$ref": "#/definitions/CredentialPreview"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["connection_id", "cred_def_id", "credential_preview"], "type": "object"}, "V10CredentialIssueRequest": {"properties": {"comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}}, "type": "object"}, "V10CredentialProblemReportRequest": {"properties": {"description": {"type": "string"}}, "required": ["description"], "type": "object"}, "V10CredentialProposalRequestMand": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "issuer_did": {"description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"description": "Schema name", "example": "preferences", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["connection_id", "credential_proposal"], "type": "object"}, "V10CredentialProposalRequestOpt": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "issuer_did": {"description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"description": "Schema name", "example": "preferences", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["connection_id"], "type": "object"}, "V10CredentialStoreRequest": {"properties": {"credential_id": {"type": "string"}}, "type": "object"}, "V10DiscoveryExchangeListResult": {"properties": {"results": {"items": {"allOf": [{"$ref": "#/definitions/V10DiscoveryRecord"}], "description": "Discover Features v1.0 exchange record"}, "type": "array"}}, "type": "object"}, "V10DiscoveryRecord": {"properties": {"connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "disclose": {"allOf": [{"$ref": "#/definitions/Disclose"}], "description": "Disclose message"}, "discovery_exchange_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "query_msg": {"allOf": [{"$ref": "#/definitions/Query"}], "description": "Query message"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V10PresentProofModuleResponse": {"properties": {}, "type": "object"}, "V10PresentationCreateRequestRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "comment": {"type": "string", "x-nullable": true}, "proof_request": {"$ref": "#/definitions/IndyProofRequest"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["proof_request"], "type": "object"}, "V10PresentationExchange": {"properties": {"auto_present": {"description": "Prover choice to auto-present proof as verifier requests", "example": false, "type": "boolean"}, "auto_remove": {"description": "Verifier choice to remove this presentation exchange record when complete", "example": false, "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "type": "boolean"}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "error_msg": {"description": "Error message", "example": "Invalid structure", "type": "string"}, "initiator": {"description": "Present-proof exchange initiator: self or external", "enum": ["self", "external"], "example": "self", "type": "string"}, "presentation": {"allOf": [{"$ref": "#/definitions/IndyProof"}], "description": "(Indy) presentation (also known as proof)"}, "presentation_exchange_id": {"description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "presentation_proposal_dict": {"allOf": [{"$ref": "#/definitions/PresentationProposal"}], "description": "Presentation proposal message"}, "presentation_request": {"allOf": [{"$ref": "#/definitions/IndyProofRequest"}], "description": "(Indy) presentation request (also known as proof request)"}, "presentation_request_dict": {"allOf": [{"$ref": "#/definitions/PresentationRequest"}], "description": "Presentation request message"}, "role": {"description": "Present-proof exchange role: prover or verifier", "enum": ["prover", "verifier"], "example": "prover", "type": "string"}, "state": {"description": "Present-proof exchange state", "example": "verified", "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "verified": {"description": "Whether presentation is verified: true or false", "enum": ["true", "false"], "example": "true", "type": "string"}, "verified_msgs": {"items": {"description": "Proof verification warning or error information", "type": "string"}, "type": "array"}}, "type": "object"}, "V10PresentationExchangeList": {"properties": {"results": {"description": "Aries RFC 37 v1.0 presentation exchange records", "items": {"$ref": "#/definitions/V10PresentationExchange"}, "type": "array"}}, "type": "object"}, "V10PresentationProblemReportRequest": {"properties": {"description": {"type": "string"}}, "required": ["description"], "type": "object"}, "V10PresentationProposalRequest": {"properties": {"auto_present": {"description": "Whether to respond automatically to presentation requests, building and presenting requested proof", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid", "type": "string"}, "presentation_proposal": {"$ref": "#/definitions/IndyPresPreview"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["connection_id", "presentation_proposal"], "type": "object"}, "V10PresentationSendRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "requested_attributes": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedAttr"}, "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers", "type": "object"}, "requested_predicates": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedPred"}, "description": "Nested object mapping proof request predicate referents to requested-predicate specifiers", "type": "object"}, "self_attested_attributes": {"additionalProperties": {"description": "Self-attested attribute values to use in requested-credentials structure for proof construction", "example": "self_attested_value", "type": "string"}, "description": "Self-attested attributes to build into proof", "type": "object"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["requested_attributes", "requested_predicates", "self_attested_attributes"], "type": "object"}, "V10PresentationSendRequestRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "comment": {"type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid", "type": "string"}, "proof_request": {"$ref": "#/definitions/IndyProofRequest"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["connection_id", "proof_request"], "type": "object"}, "V10PresentationSendRequestToProposal": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "type": "object"}, "V20CredAttrSpec": {"properties": {"mime-type": {"description": "MIME type: omit for (null) default", "example": "image/jpeg", "type": "string", "x-nullable": true}, "name": {"description": "Attribute name", "example": "favourite_drink", "type": "string"}, "value": {"description": "Attribute value: base64-encode if MIME type is present", "example": "martini", "type": "string"}}, "required": ["name", "value"], "type": "object"}, "V20CredBoundOfferRequest": {"properties": {"counter_preview": {"allOf": [{"$ref": "#/definitions/V20CredPreview"}], "description": "Optional content for counter-proposal"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilter"}], "description": "Credential specification criteria by format"}}, "type": "object"}, "V20CredExFree": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid", "type": "string"}, "credential_preview": {"$ref": "#/definitions/V20CredPreview"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilter"}], "description": "Credential specification criteria by format"}, "replacement_id": {"description": "Optional identifier used to manage credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string", "x-nullable": true}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "verification_method": {"description": "For ld-proofs. Verification method for signing.", "type": "string", "x-nullable": true}}, "required": ["connection_id", "filter"], "type": "object"}, "V20CredExRecord": {"properties": {"auto_issue": {"description": "Issuer choice to issue to request in this credential exchange", "example": false, "type": "boolean"}, "auto_offer": {"description": "Holder choice to accept offer in this credential exchange", "example": false, "type": "boolean"}, "auto_remove": {"description": "Issuer choice to remove this credential exchange record when complete", "example": false, "type": "boolean"}, "by_format": {"allOf": [{"$ref": "#/definitions/V20CredExRecordByFormat"}], "description": "Attachment content by format for proposal, offer, request, and issue", "readOnly": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_ex_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_issue": {"allOf": [{"$ref": "#/definitions/V20CredIssue"}], "description": "Serialized credential issue message"}, "cred_offer": {"allOf": [{"$ref": "#/definitions/V20CredOffer"}], "description": "Credential offer message"}, "cred_preview": {"allOf": [{"$ref": "#/definitions/V20CredPreview"}], "description": "Credential preview from credential proposal", "readOnly": true}, "cred_proposal": {"allOf": [{"$ref": "#/definitions/V20CredProposal"}], "description": "Credential proposal message"}, "cred_request": {"allOf": [{"$ref": "#/definitions/V20CredRequest"}], "description": "Serialized credential request message"}, "error_msg": {"description": "Error message", "example": "The front fell off", "type": "string"}, "initiator": {"description": "Issue-credential exchange initiator: self or external", "enum": ["self", "external"], "example": "self", "type": "string"}, "parent_thread_id": {"description": "Parent thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "role": {"description": "Issue-credential exchange role: holder or issuer", "enum": ["issuer", "holder"], "example": "issuer", "type": "string"}, "state": {"description": "Issue-credential exchange state", "enum": ["proposal-sent", "proposal-received", "offer-sent", "offer-received", "request-sent", "request-received", "credential-issued", "credential-received", "done", "credential-revoked", "abandoned", "deleted"], "example": "done", "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V20CredExRecordByFormat": {"properties": {"cred_issue": {"type": "object"}, "cred_offer": {"type": "object"}, "cred_proposal": {"type": "object"}, "cred_request": {"type": "object"}}, "type": "object"}, "V20CredExRecordDetail": {"properties": {"cred_ex_record": {"allOf": [{"$ref": "#/definitions/V20CredExRecord"}], "description": "Credential exchange record"}, "indy": {"$ref": "#/definitions/V20CredExRecordIndy"}, "ld_proof": {"$ref": "#/definitions/V20CredExRecordLDProof"}}, "type": "object"}, "V20CredExRecordIndy": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_ex_id": {"description": "Corresponding v2.0 credential exchange record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_ex_indy_id": {"description": "Record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_id_stored": {"description": "Credential identifier stored in wallet", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_request_metadata": {"description": "Credential request metadata for indy holder", "type": "object"}, "cred_rev_id": {"description": "Credential revocation identifier within revocation registry", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V20CredExRecordLDProof": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_ex_id": {"description": "Corresponding v2.0 credential exchange record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_ex_ld_proof_id": {"description": "Record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_id_stored": {"description": "Credential identifier stored in wallet", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V20CredExRecordListResult": {"properties": {"results": {"description": "Credential exchange records and corresponding detail records", "items": {"$ref": "#/definitions/V20CredExRecordDetail"}, "type": "array"}}, "type": "object"}, "V20CredFilter": {"properties": {"indy": {"allOf": [{"$ref": "#/definitions/V20CredFilterIndy"}], "description": "Credential filter for indy"}, "ld_proof": {"allOf": [{"$ref": "#/definitions/LDProofVCDetail"}], "description": "Credential filter for linked data proof"}}, "type": "object"}, "V20CredFilterIndy": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "issuer_did": {"description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"description": "Schema name", "example": "preferences", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "V20CredFilterLDProof": {"properties": {"ld_proof": {"allOf": [{"$ref": "#/definitions/LDProofVCDetail"}], "description": "Credential filter for linked data proof"}}, "required": ["ld_proof"], "type": "object"}, "V20CredFormat": {"properties": {"attach_id": {"description": "Attachment identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "format": {"description": "Attachment format specifier", "example": "aries/ld-proof-vc-detail@v1.0", "type": "string"}}, "required": ["attach_id", "format"], "type": "object"}, "V20CredIssue": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credentials~attach": {"description": "Credential attachments", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}, "formats": {"description": "Acceptable attachment formats", "items": {"$ref": "#/definitions/V20CredFormat"}, "type": "array"}, "replacement_id": {"description": "Issuer-unique identifier to coordinate credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["credentials~attach", "formats"], "type": "object"}, "V20CredIssueProblemReportRequest": {"properties": {"description": {"type": "string"}}, "required": ["description"], "type": "object"}, "V20CredIssueRequest": {"properties": {"comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}}, "type": "object"}, "V20CredOffer": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"$ref": "#/definitions/V20CredPreview"}, "formats": {"description": "Acceptable credential formats", "items": {"$ref": "#/definitions/V20CredFormat"}, "type": "array"}, "offers~attach": {"description": "Offer attachments", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}, "replacement_id": {"description": "Issuer-unique identifier to coordinate credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["formats", "offers~attach"], "type": "object"}, "V20CredOfferConnFreeRequest": {"properties": {"auto_issue": {"description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"$ref": "#/definitions/V20CredPreview"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilter"}], "description": "Credential specification criteria by format"}, "replacement_id": {"description": "Optional identifier used to manage credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string", "x-nullable": true}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["filter"], "type": "object"}, "V20CredOfferRequest": {"properties": {"auto_issue": {"description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid", "type": "string"}, "credential_preview": {"$ref": "#/definitions/V20CredPreview"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilter"}], "description": "Credential specification criteria by format"}, "replacement_id": {"description": "Optional identifier used to manage credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string", "x-nullable": true}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["connection_id", "filter"], "type": "object"}, "V20CredPreview": {"properties": {"@type": {"description": "Message type identifier", "example": "issue-credential/2.0/credential-preview", "type": "string"}, "attributes": {"items": {"$ref": "#/definitions/V20CredAttrSpec"}, "type": "array"}}, "required": ["attributes"], "type": "object"}, "V20CredProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"allOf": [{"$ref": "#/definitions/V20CredPreview"}], "description": "Credential preview"}, "filters~attach": {"description": "Credential filter per acceptable format on corresponding identifier", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}, "formats": {"description": "Attachment formats", "items": {"$ref": "#/definitions/V20CredFormat"}, "type": "array"}}, "required": ["filters~attach", "formats"], "type": "object"}, "V20CredRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "formats": {"description": "Acceptable attachment formats", "items": {"$ref": "#/definitions/V20CredFormat"}, "type": "array"}, "requests~attach": {"description": "Request attachments", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["formats", "requests~attach"], "type": "object"}, "V20CredRequestFree": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid", "type": "string"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilterLDProof"}], "description": "Credential specification criteria by format"}, "holder_did": {"description": "Holder DID to substitute for the credentialSubject.id", "example": "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", "type": "string", "x-nullable": true}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["connection_id", "filter"], "type": "object"}, "V20CredRequestRequest": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "holder_did": {"description": "Holder DID to substitute for the credentialSubject.id", "example": "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", "type": "string", "x-nullable": true}}, "type": "object"}, "V20CredStoreRequest": {"properties": {"credential_id": {"type": "string"}}, "type": "object"}, "V20DiscoveryExchangeListResult": {"properties": {"results": {"items": {"allOf": [{"$ref": "#/definitions/V20DiscoveryRecord"}], "description": "Discover Features v2.0 exchange record"}, "type": "array"}}, "type": "object"}, "V20DiscoveryExchangeResult": {"properties": {"results": {"allOf": [{"$ref": "#/definitions/V20DiscoveryRecord"}], "description": "Discover Features v2.0 exchange record"}}, "type": "object"}, "V20DiscoveryRecord": {"properties": {"connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "disclosures": {"allOf": [{"$ref": "#/definitions/Disclosures"}], "description": "Disclosures message"}, "discovery_exchange_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "queries_msg": {"allOf": [{"$ref": "#/definitions/Queries"}], "description": "Queries message"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V20IssueCredSchemaCore": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"$ref": "#/definitions/V20CredPreview"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilter"}], "description": "Credential specification criteria by format"}, "replacement_id": {"description": "Optional identifier used to manage credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string", "x-nullable": true}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["filter"], "type": "object"}, "V20IssueCredentialModuleResponse": {"properties": {}, "type": "object"}, "V20Pres": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "formats": {"description": "Acceptable attachment formats", "items": {"$ref": "#/definitions/V20PresFormat"}, "type": "array"}, "presentations~attach": {"items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["formats", "presentations~attach"], "type": "object"}, "V20PresCreateRequestRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "comment": {"type": "string", "x-nullable": true}, "presentation_request": {"$ref": "#/definitions/V20PresRequestByFormat"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["presentation_request"], "type": "object"}, "V20PresExRecord": {"properties": {"auto_present": {"description": "Prover choice to auto-present proof as verifier requests", "example": false, "type": "boolean"}, "auto_remove": {"description": "Verifier choice to remove this presentation exchange record when complete", "example": false, "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "type": "boolean"}, "by_format": {"allOf": [{"$ref": "#/definitions/V20PresExRecordByFormat"}], "description": "Attachment content by format for proposal, request, and presentation", "readOnly": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "error_msg": {"description": "Error message", "example": "Invalid structure", "type": "string"}, "initiator": {"description": "Present-proof exchange initiator: self or external", "enum": ["self", "external"], "example": "self", "type": "string"}, "pres": {"allOf": [{"$ref": "#/definitions/V20Pres"}], "description": "Presentation message"}, "pres_ex_id": {"description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "pres_proposal": {"allOf": [{"$ref": "#/definitions/V20PresProposal"}], "description": "Presentation proposal message"}, "pres_request": {"allOf": [{"$ref": "#/definitions/V20PresRequest"}], "description": "Presentation request message"}, "role": {"description": "Present-proof exchange role: prover or verifier", "enum": ["prover", "verifier"], "example": "prover", "type": "string"}, "state": {"description": "Present-proof exchange state", "enum": ["proposal-sent", "proposal-received", "request-sent", "request-received", "presentation-sent", "presentation-received", "done", "abandoned", "deleted"], "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "verified": {"description": "Whether presentation is verified: 'true' or 'false'", "enum": ["true", "false"], "example": "true", "type": "string"}, "verified_msgs": {"items": {"description": "Proof verification warning or error information", "type": "string"}, "type": "array"}}, "type": "object"}, "V20PresExRecordByFormat": {"properties": {"pres": {"type": "object"}, "pres_proposal": {"type": "object"}, "pres_request": {"type": "object"}}, "type": "object"}, "V20PresExRecordList": {"properties": {"results": {"description": "Presentation exchange records", "items": {"$ref": "#/definitions/V20PresExRecord"}, "type": "array"}}, "type": "object"}, "V20PresFormat": {"properties": {"attach_id": {"description": "Attachment identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "format": {"description": "Attachment format specifier", "example": "dif/presentation-exchange/submission@v1.0", "type": "string"}}, "required": ["attach_id", "format"], "type": "object"}, "V20PresProblemReportRequest": {"properties": {"description": {"type": "string"}}, "required": ["description"], "type": "object"}, "V20PresProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string"}, "formats": {"items": {"$ref": "#/definitions/V20PresFormat"}, "type": "array"}, "proposals~attach": {"description": "Attachment per acceptable format on corresponding identifier", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["formats", "proposals~attach"], "type": "object"}, "V20PresProposalByFormat": {"properties": {"dif": {"allOf": [{"$ref": "#/definitions/DIFProofProposal"}], "description": "Presentation proposal for DIF"}, "indy": {"allOf": [{"$ref": "#/definitions/IndyProofRequest"}], "description": "Presentation proposal for indy"}}, "type": "object"}, "V20PresProposalRequest": {"properties": {"auto_present": {"description": "Whether to respond automatically to presentation requests, building and presenting requested proof", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid", "type": "string"}, "presentation_proposal": {"$ref": "#/definitions/V20PresProposalByFormat"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["connection_id", "presentation_proposal"], "type": "object"}, "V20PresRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string"}, "formats": {"items": {"$ref": "#/definitions/V20PresFormat"}, "type": "array"}, "request_presentations~attach": {"description": "Attachment per acceptable format on corresponding identifier", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}, "will_confirm": {"description": "Whether verifier will send confirmation ack", "type": "boolean"}}, "required": ["formats", "request_presentations~attach"], "type": "object"}, "V20PresRequestByFormat": {"properties": {"dif": {"allOf": [{"$ref": "#/definitions/DIFProofRequest"}], "description": "Presentation request for DIF"}, "indy": {"allOf": [{"$ref": "#/definitions/IndyProofRequest"}], "description": "Presentation request for indy"}}, "type": "object"}, "V20PresSendRequestRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "comment": {"type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "uuid", "type": "string"}, "presentation_request": {"$ref": "#/definitions/V20PresRequestByFormat"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["connection_id", "presentation_request"], "type": "object"}, "V20PresSpecByFormatRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "dif": {"allOf": [{"$ref": "#/definitions/DIFPresSpec"}], "description": "Optional Presentation specification for DIF, overrides the PresentionExchange record's PresRequest"}, "indy": {"allOf": [{"$ref": "#/definitions/IndyPresSpec"}], "description": "Presentation specification for indy"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "type": "object"}, "V20PresentProofModuleResponse": {"properties": {}, "type": "object"}, "V20PresentationSendRequestToProposal": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "type": "object"}, "VCRecord": {"properties": {"contexts": {"items": {"description": "Context", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "cred_tags": {"additionalProperties": {"description": "Retrieval tag value", "type": "string"}, "type": "object"}, "cred_value": {"description": "(JSON-serializable) credential value", "type": "object"}, "expanded_types": {"items": {"description": "JSON-LD expanded type extracted from type and context", "example": "https://w3id.org/citizenship#PermanentResidentCard", "type": "string"}, "type": "array"}, "given_id": {"description": "Credential identifier", "example": "http://example.edu/credentials/3732", "type": "string"}, "issuer_id": {"description": "Issuer identifier", "example": "https://example.edu/issuers/14", "type": "string"}, "proof_types": {"items": {"description": "Signature suite used for proof", "example": "Ed25519Signature2018", "type": "string"}, "type": "array"}, "record_id": {"description": "Record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "schema_ids": {"items": {"description": "Schema identifier", "example": "https://example.org/examples/degree.json", "type": "string"}, "type": "array"}, "subject_ids": {"items": {"description": "Subject identifier", "example": "did:example:ebfeb1f712ebc6f1c276e12ec21", "type": "string"}, "type": "array"}}, "type": "object"}, "VCRecordList": {"properties": {"results": {"items": {"$ref": "#/definitions/VCRecord"}, "type": "array"}}, "type": "object"}, "VerifyRequest": {"properties": {"doc": {"allOf": [{"$ref": "#/definitions/SignedDoc"}], "description": "Signed document"}, "verkey": {"description": "Verkey to use for doc verification", "type": "string"}}, "required": ["doc"], "type": "object"}, "VerifyResponse": {"properties": {"error": {"description": "Error text", "type": "string"}, "valid": {"type": "boolean"}}, "required": ["valid"], "type": "object"}, "W3CCredentialsListRequest": {"properties": {"contexts": {"items": {"description": "Credential context to match", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "given_id": {"description": "Given credential id to match", "type": "string"}, "issuer_id": {"description": "Credential issuer identifier to match", "type": "string"}, "max_results": {"description": "Maximum number of results to return", "format": "int32", "type": "integer"}, "proof_types": {"items": {"description": "Signature suite used for proof", "example": "Ed25519Signature2018", "type": "string"}, "type": "array"}, "schema_ids": {"description": "Schema identifiers, all of which to match", "items": {"description": "Credential schema identifier", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "subject_ids": {"description": "Subject identifiers, all of which to match", "items": {"description": "Subject identifier", "type": "string"}, "type": "array"}, "tag_query": {"additionalProperties": {"description": "Tag value", "type": "string"}, "description": "Tag filter", "type": "object"}, "types": {"items": {"description": "Credential type to match", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}}, "type": "object"}, "WalletList": {"properties": {"results": {"description": "List of wallet records", "items": {"$ref": "#/definitions/WalletRecord"}, "type": "array"}}, "type": "object"}, "WalletModuleResponse": {"properties": {}, "type": "object"}, "WalletRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "key_management_mode": {"description": "Mode regarding management of wallet key", "enum": ["managed", "unmanaged"], "type": "string"}, "settings": {"description": "Settings for this wallet.", "type": "object"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "wallet_id": {"description": "Wallet record ID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["key_management_mode", "wallet_id"], "type": "object"}, "WriteLedger": {"properties": {"ledger_id": {"type": "string"}}, "type": "object"}}, "securityDefinitions": {"AuthorizationHeader": {"type": "apiKey", "in": "header", "name": "Authorization", "description": "Bearer token. Be sure to preprend token with 'Bearer '"}}, "security": [{"AuthorizationHeader": []}], "tags": [{"name": "action-menu", "description": "Menu interaction over connection"}, {"name": "basicmessage", "description": "Simple messaging", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0095-basic-message"}}, {"name": "connection", "description": "Connection management", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/9b0aaa39df7e8bd434126c4b33c097aae78d65bf/features/0160-connection-protocol"}}, {"name": "credential-definition", "description": "Credential definition operations", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#cred_def"}}, {"name": "credentials", "description": "Holder credential management", "externalDocs": {"description": "Overview", "url": "https://w3c.github.io/vc-data-model/#credentials"}}, {"name": "did-exchange", "description": "Connection management via DID exchange", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/25464a5c8f8a17b14edaa4310393df6094ace7b0/features/0023-did-exchange"}}, {"name": "discover-features", "description": "Feature discovery", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0031-discover-features"}}, {"name": "discover-features v2.0", "description": "Feature discovery v2", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0557-discover-features-v2"}}, {"name": "endorse-transaction", "description": "Endorse a Transaction"}, {"name": "introduction", "description": "Introduction of known parties"}, {"name": "issue-credential v1.0", "description": "Credential issue v1.0", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/bb42a6c35e0d5543718fb36dd099551ab192f7b0/features/0036-issue-credential"}}, {"name": "issue-credential v2.0", "description": "Credential issue v2.0", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/cd27fc64aa2805f756a118043d7c880354353047/features/0453-issue-credential-v2"}}, {"name": "jsonld", "description": "Sign and verify json-ld data", "externalDocs": {"description": "Specification", "url": "https://tools.ietf.org/html/rfc7515"}}, {"name": "ledger", "description": "Interaction with ledger", "externalDocs": {"description": "Overview", "url": "https://hyperledger-indy.readthedocs.io/projects/plenum/en/latest/storage.html#ledger"}}, {"name": "mediation", "description": "Mediation management", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/fa8dc4ea1e667eb07db8f9ffeaf074a4455697c0/features/0211-route-coordination"}}, {"name": "multitenancy", "description": "Multitenant wallet management"}, {"name": "out-of-band", "description": "Out-of-band connections", "externalDocs": {"description": "Design", "url": "https://github.com/hyperledger/aries-rfcs/tree/2da7fc4ee043effa3a9960150e7ba8c9a4628b68/features/0434-outofband"}}, {"name": "present-proof v1.0", "description": "Proof presentation v1.0", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/4fae574c03f9f1013db30bf2c0c676b1122f7149/features/0037-present-proof"}}, {"name": "present-proof v2.0", "description": "Proof presentation v2.0", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/eace815c3e8598d4a8dd7881d8c731fdb2bcc0aa/features/0454-present-proof-v2"}}, {"name": "resolver", "description": "did resolver interface.", "externalDocs": {"description": "Specification"}}, {"name": "revocation", "description": "Revocation registry management", "externalDocs": {"description": "Overview", "url": "https://github.com/hyperledger/indy-hipe/tree/master/text/0011-cred-revocation"}}, {"name": "schema", "description": "Schema operations", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#schema"}}, {"name": "settings", "description": "Agent settings interface."}, {"name": "trustping", "description": "Trust-ping over connection", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0048-trust-ping"}}, {"name": "wallet", "description": "DID and tag policy management", "externalDocs": {"description": "Design", "url": "https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage"}}]} \ No newline at end of file +{ + "paths": { + "/action-menu/{conn_id}/close": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ActionMenuModulesResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["action-menu"], + "summary": "Close the active menu associated with a connection", + "produces": ["application/json"] + } + }, + "/action-menu/{conn_id}/fetch": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ActionMenuFetchResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["action-menu"], + "summary": "Fetch the active menu", + "produces": ["application/json"] + } + }, + "/action-menu/{conn_id}/perform": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ActionMenuModulesResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/PerformRequest" } + }, + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["action-menu"], + "summary": "Perform an action associated with the active menu", + "produces": ["application/json"] + } + }, + "/action-menu/{conn_id}/request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ActionMenuModulesResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["action-menu"], + "summary": "Request the active menu", + "produces": ["application/json"] + } + }, + "/action-menu/{conn_id}/send-menu": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ActionMenuModulesResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/SendMenu" } + }, + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["action-menu"], + "summary": "Send an action menu to a connection", + "produces": ["application/json"] + } + }, + "/connections": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnectionList" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "alias", + "required": false, + "type": "string", + "description": "Alias", + "example": "Barry" + }, + { + "in": "query", + "name": "connection_protocol", + "required": false, + "type": "string", + "enum": ["connections/1.0", "didexchange/1.0"], + "description": "Connection protocol used", + "example": "connections/1.0" + }, + { + "in": "query", + "name": "invitation_key", + "required": false, + "type": "string", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "description": "invitation key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV" + }, + { + "in": "query", + "name": "invitation_msg_id", + "required": false, + "type": "string", + "format": "uuid", + "description": "Identifier of the associated Invitation Mesage", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "my_did", + "required": false, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "description": "My DID", + "example": "WgWxqztrNooG92RXvxSTWv" + }, + { + "in": "query", + "name": "state", + "required": false, + "type": "string", + "enum": [ + "invitation", + "start", + "init", + "abandoned", + "active", + "request", + "response", + "completed", + "error" + ], + "description": "Connection state" + }, + { + "in": "query", + "name": "their_did", + "required": false, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "description": "Their DID", + "example": "WgWxqztrNooG92RXvxSTWv" + }, + { + "in": "query", + "name": "their_public_did", + "required": false, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "description": "Their Public DID", + "example": "WgWxqztrNooG92RXvxSTWv" + }, + { + "in": "query", + "name": "their_role", + "required": false, + "type": "string", + "enum": ["invitee", "requester", "inviter", "responder"], + "description": "Their role in the connection protocol", + "example": "invitee" + } + ], + "tags": ["connection"], + "summary": "Query agent-to-agent connections", + "produces": ["application/json"] + } + }, + "/connections/create-invitation": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/InvitationResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/CreateInvitationRequest" } + }, + { + "in": "query", + "name": "alias", + "required": false, + "type": "string", + "description": "Alias", + "example": "Barry" + }, + { + "in": "query", + "name": "auto_accept", + "required": false, + "type": "boolean", + "description": "Auto-accept connection (defaults to configuration)" + }, + { + "in": "query", + "name": "multi_use", + "required": false, + "type": "boolean", + "description": "Create invitation for multiple use (default false)" + }, + { + "in": "query", + "name": "public", + "required": false, + "type": "boolean", + "description": "Create invitation from public DID (default false)" + } + ], + "tags": ["connection"], + "summary": "Create a new connection invitation", + "produces": ["application/json"] + } + }, + "/connections/create-static": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnectionStaticResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/ConnectionStaticRequest" } + } + ], + "tags": ["connection"], + "summary": "Create a new static connection", + "produces": ["application/json"] + } + }, + "/connections/receive-invitation": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/ReceiveInvitationRequest" } + }, + { + "in": "query", + "name": "alias", + "required": false, + "type": "string", + "description": "Alias", + "example": "Barry" + }, + { + "in": "query", + "name": "auto_accept", + "required": false, + "type": "boolean", + "description": "Auto-accept connection (defaults to configuration)" + }, + { + "in": "query", + "name": "mediation_id", + "required": false, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Identifier for active mediation record to be used", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["connection"], + "summary": "Receive a new connection invitation", + "produces": ["application/json"] + } + }, + "/connections/{conn_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["connection"], + "summary": "Fetch a single connection record", + "produces": ["application/json"] + }, + "delete": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnectionModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["connection"], + "summary": "Remove an existing connection record", + "produces": ["application/json"] + } + }, + "/connections/{conn_id}/accept-invitation": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "mediation_id", + "required": false, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Identifier for active mediation record to be used", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "my_endpoint", + "required": false, + "type": "string", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "description": "My URL endpoint", + "example": "https://myhost:8021" + }, + { + "in": "query", + "name": "my_label", + "required": false, + "type": "string", + "description": "Label for connection", + "example": "Broker" + } + ], + "tags": ["connection"], + "summary": "Accept a stored connection invitation", + "produces": ["application/json"] + } + }, + "/connections/{conn_id}/accept-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "my_endpoint", + "required": false, + "type": "string", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "description": "My URL endpoint", + "example": "https://myhost:8021" + } + ], + "tags": ["connection"], + "summary": "Accept a stored connection request", + "produces": ["application/json"] + } + }, + "/connections/{conn_id}/endpoints": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/EndpointsResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["connection"], + "summary": "Fetch connection remote endpoint", + "produces": ["application/json"] + } + }, + "/connections/{conn_id}/metadata": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnectionMetadata" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "key", + "required": false, + "type": "string", + "description": "Key to retrieve." + } + ], + "tags": ["connection"], + "summary": "Fetch connection metadata", + "produces": ["application/json"] + }, + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnectionMetadata" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/ConnectionMetadataSetRequest" } + }, + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["connection"], + "summary": "Set connection metadata", + "produces": ["application/json"] + } + }, + "/connections/{conn_id}/send-message": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/BasicMessageModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/SendMessage" } + }, + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["basicmessage"], + "summary": "Send a basic message to a connection", + "produces": ["application/json"] + } + }, + "/connections/{conn_id}/send-ping": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/PingRequestResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/PingRequest" } + }, + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["trustping"], + "summary": "Send a trust ping to a connection", + "produces": ["application/json"] + } + }, + "/connections/{conn_id}/start-introduction": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/IntroModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "target_connection_id", + "required": true, + "type": "string", + "description": "Target connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "message", + "required": false, + "type": "string", + "description": "Message", + "example": "Allow me to introduce ..." + } + ], + "tags": ["introduction"], + "summary": "Start an introduction between two connections", + "produces": ["application/json"] + } + }, + "/credential-definitions": { + "post": { + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/TxnOrCredentialDefinitionSendResult" + }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/CredentialDefinitionSendRequest" + } + }, + { + "in": "query", + "name": "conn_id", + "required": false, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "create_transaction_for_endorser", + "required": false, + "type": "boolean", + "description": "Create Transaction For Endorser's signature" + } + ], + "tags": ["credential-definition"], + "summary": "Sends a credential definition to the ledger", + "produces": ["application/json"] + } + }, + "/credential-definitions/created": { + "get": { + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/CredentialDefinitionsCreatedResult" + }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "cred_def_id", + "required": false, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "description": "Credential definition id", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag" + }, + { + "in": "query", + "name": "issuer_did", + "required": false, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "description": "Issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv" + }, + { + "in": "query", + "name": "schema_id", + "required": false, + "type": "string", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0" + }, + { + "in": "query", + "name": "schema_issuer_did", + "required": false, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "description": "Schema issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv" + }, + { + "in": "query", + "name": "schema_name", + "required": false, + "type": "string", + "description": "Schema name", + "example": "membership" + }, + { + "in": "query", + "name": "schema_version", + "required": false, + "type": "string", + "pattern": "^[0-9.]+$", + "description": "Schema version", + "example": "1.0" + } + ], + "tags": ["credential-definition"], + "summary": "Search for matching credential definitions that agent originated", + "produces": ["application/json"] + } + }, + "/credential-definitions/{cred_def_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/CredentialDefinitionGetResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "cred_def_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag" + } + ], + "tags": ["credential-definition"], + "summary": "Gets a credential definition from the ledger", + "produces": ["application/json"] + } + }, + "/credential-definitions/{cred_def_id}/write_record": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/CredentialDefinitionGetResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "cred_def_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag" + } + ], + "tags": ["credential-definition"], + "summary": "Writes a credential definition non-secret record to the wallet", + "produces": ["application/json"] + } + }, + "/credential/mime-types/{credential_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/AttributeMimeTypesResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "credential_id", + "required": true, + "type": "string", + "description": "Credential identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["credentials"], + "summary": "Get attribute MIME types from wallet", + "produces": ["application/json"] + } + }, + "/credential/revoked/{credential_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/CredRevokedResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "credential_id", + "required": true, + "type": "string", + "description": "Credential identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "from", + "required": false, + "type": "string", + "pattern": "^[0-9]*$", + "description": "Earliest epoch of revocation status interval of interest", + "example": "0" + }, + { + "in": "query", + "name": "to", + "required": false, + "type": "string", + "pattern": "^[0-9]*$", + "description": "Latest epoch of revocation status interval of interest", + "example": "0" + } + ], + "tags": ["credentials"], + "summary": "Query credential revocation status by id", + "produces": ["application/json"] + } + }, + "/credential/w3c/{credential_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/VCRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "credential_id", + "required": true, + "type": "string", + "description": "Credential identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["credentials"], + "summary": "Fetch W3C credential from wallet by id", + "produces": ["application/json"] + }, + "delete": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/HolderModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "credential_id", + "required": true, + "type": "string", + "description": "Credential identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["credentials"], + "summary": "Remove W3C credential from wallet by id", + "produces": ["application/json"] + } + }, + "/credential/{credential_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/IndyCredInfo" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "credential_id", + "required": true, + "type": "string", + "description": "Credential identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["credentials"], + "summary": "Fetch credential from wallet by id", + "produces": ["application/json"] + }, + "delete": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/HolderModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "credential_id", + "required": true, + "type": "string", + "description": "Credential identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["credentials"], + "summary": "Remove credential from wallet by id", + "produces": ["application/json"] + } + }, + "/credentials": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/CredInfoList" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "count", + "required": false, + "type": "string", + "pattern": "^[1-9][0-9]*$", + "description": "Maximum number to retrieve", + "example": "1" + }, + { + "in": "query", + "name": "start", + "required": false, + "type": "string", + "pattern": "^[0-9]*$", + "description": "Start index", + "example": "0" + }, + { + "in": "query", + "name": "wql", + "required": false, + "type": "string", + "pattern": "^{.*}$", + "description": "(JSON) WQL query", + "example": "{\"attr::name::value\": \"Alex\"}" + } + ], + "tags": ["credentials"], + "summary": "Fetch credentials from wallet", + "produces": ["application/json"] + } + }, + "/credentials/w3c": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/VCRecordList" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/W3CCredentialsListRequest" } + }, + { + "in": "query", + "name": "count", + "required": false, + "type": "string", + "pattern": "^[1-9][0-9]*$", + "description": "Maximum number to retrieve", + "example": "1" + }, + { + "in": "query", + "name": "start", + "required": false, + "type": "string", + "pattern": "^[0-9]*$", + "description": "Start index", + "example": "0" + }, + { + "in": "query", + "name": "wql", + "required": false, + "type": "string", + "pattern": "^{.*}$", + "description": "(JSON) WQL query", + "example": "{\"attr::name::value\": \"Alex\"}" + } + ], + "tags": ["credentials"], + "summary": "Fetch W3C credentials from wallet", + "produces": ["application/json"] + } + }, + "/didexchange/create-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "their_public_did", + "required": true, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "description": "Qualified public DID to which to request connection", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv" + }, + { + "in": "query", + "name": "alias", + "required": false, + "type": "string", + "description": "Alias for connection", + "example": "Barry" + }, + { + "in": "query", + "name": "goal", + "required": false, + "type": "string", + "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", + "example": "To issue a Faber College Graduate credential" + }, + { + "in": "query", + "name": "goal_code", + "required": false, + "type": "string", + "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", + "example": "issue-vc" + }, + { + "in": "query", + "name": "mediation_id", + "required": false, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Identifier for active mediation record to be used", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "my_endpoint", + "required": false, + "type": "string", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "description": "My URL endpoint", + "example": "https://myhost:8021" + }, + { + "in": "query", + "name": "my_label", + "required": false, + "type": "string", + "description": "Label for connection request", + "example": "Broker" + }, + { + "in": "query", + "name": "use_public_did", + "required": false, + "type": "boolean", + "description": "Use public DID for this connection" + } + ], + "tags": ["did-exchange"], + "summary": "Create and send a request against public DID's implicit invitation", + "produces": ["application/json"] + } + }, + "/didexchange/receive-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/DIDXRequest" } + }, + { + "in": "query", + "name": "alias", + "required": false, + "type": "string", + "description": "Alias for connection", + "example": "Barry" + }, + { + "in": "query", + "name": "auto_accept", + "required": false, + "type": "boolean", + "description": "Auto-accept connection (defaults to configuration)" + }, + { + "in": "query", + "name": "mediation_id", + "required": false, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Identifier for active mediation record to be used", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "my_endpoint", + "required": false, + "type": "string", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "description": "My URL endpoint", + "example": "https://myhost:8021" + } + ], + "tags": ["did-exchange"], + "summary": "Receive request against public DID's implicit invitation", + "produces": ["application/json"] + } + }, + "/didexchange/{conn_id}/accept-invitation": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "my_endpoint", + "required": false, + "type": "string", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "description": "My URL endpoint", + "example": "https://myhost:8021" + }, + { + "in": "query", + "name": "my_label", + "required": false, + "type": "string", + "description": "Label for connection request", + "example": "Broker" + } + ], + "tags": ["did-exchange"], + "summary": "Accept a stored connection invitation", + "produces": ["application/json"] + } + }, + "/didexchange/{conn_id}/accept-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "mediation_id", + "required": false, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Identifier for active mediation record to be used", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "my_endpoint", + "required": false, + "type": "string", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "description": "My URL endpoint", + "example": "https://myhost:8021" + }, + { + "in": "query", + "name": "use_public_did", + "required": false, + "type": "boolean", + "description": "Use public DID for this connection" + } + ], + "tags": ["did-exchange"], + "summary": "Accept a stored connection request", + "produces": ["application/json"] + } + }, + "/didexchange/{conn_id}/reject": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConnRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/DIDXRejectRequest" } + }, + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["did-exchange"], + "summary": "Abandon or reject a DID Exchange", + "produces": ["application/json"] + } + }, + "/discover-features-2.0/queries": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20DiscoveryExchangeResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "connection_id", + "required": false, + "type": "string", + "description": "Connection identifier, if none specified, then the query will provide features for this agent.", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "query_goal_code", + "required": false, + "type": "string", + "description": "Goal-code feature-type query", + "example": "*" + }, + { + "in": "query", + "name": "query_protocol", + "required": false, + "type": "string", + "description": "Protocol feature-type query", + "example": "*" + } + ], + "tags": ["discover-features v2.0"], + "summary": "Query supported features", + "produces": ["application/json"] + } + }, + "/discover-features-2.0/records": { + "get": { + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/V20DiscoveryExchangeListResult" + }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "connection_id", + "required": false, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["discover-features v2.0"], + "summary": "Discover Features v2.0 records", + "produces": ["application/json"] + } + }, + "/discover-features/query": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10DiscoveryRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "comment", + "required": false, + "type": "string", + "description": "Comment", + "example": "test" + }, + { + "in": "query", + "name": "connection_id", + "required": false, + "type": "string", + "description": "Connection identifier, if none specified, then the query will provide features for this agent.", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "query", + "required": false, + "type": "string", + "description": "Protocol feature query", + "example": "*" + } + ], + "tags": ["discover-features"], + "summary": "Query supported features", + "produces": ["application/json"] + } + }, + "/discover-features/records": { + "get": { + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/V10DiscoveryExchangeListResult" + }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "connection_id", + "required": false, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["discover-features"], + "summary": "Discover Features records", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/create": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20IssueCredSchemaCore" } + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Create a credential record without sending (generally for use with Out-Of-Band)", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/create-offer": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20CredOfferConnFreeRequest" } + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Create a credential offer, independent of any proposal or connection", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/records": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecordListResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "connection_id", + "required": false, + "type": "string", + "format": "uuid", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "role", + "required": false, + "type": "string", + "enum": ["issuer", "holder"], + "description": "Role assigned in credential exchange" + }, + { + "in": "query", + "name": "state", + "required": false, + "type": "string", + "enum": [ + "proposal-sent", + "proposal-received", + "offer-sent", + "offer-received", + "request-sent", + "request-received", + "credential-issued", + "credential-received", + "done", + "credential-revoked", + "abandoned" + ], + "description": "Credential exchange state" + }, + { + "in": "query", + "name": "thread_id", + "required": false, + "type": "string", + "format": "uuid", + "description": "Thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Fetch all credential exchange records", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/records/{cred_ex_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecordDetail" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Fetch a single credential exchange record", + "produces": ["application/json"] + }, + "delete": { + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/V20IssueCredentialModuleResponse" + }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Remove an existing credential exchange record", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/records/{cred_ex_id}/issue": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecordDetail" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20CredIssueRequest" } + }, + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Send holder a credential", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/records/{cred_ex_id}/problem-report": { + "post": { + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/V20IssueCredentialModuleResponse" + }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/V20CredIssueProblemReportRequest" + } + }, + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Send a problem report for credential exchange", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/records/{cred_ex_id}/send-offer": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20CredBoundOfferRequest" } + }, + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Send holder a credential offer in reference to a proposal with preview", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/records/{cred_ex_id}/send-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20CredRequestRequest" } + }, + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Send issuer a credential request", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/records/{cred_ex_id}/store": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecordDetail" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20CredStoreRequest" } + }, + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Store a received credential", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/send": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20CredExFree" } + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Send holder a credential, automating entire flow", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/send-offer": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20CredOfferRequest" } + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Send holder a credential offer, independent of any proposal", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/send-proposal": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20CredExFree" } + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Send issuer a credential proposal", + "produces": ["application/json"] + } + }, + "/issue-credential-2.0/send-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20CredExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20CredRequestFree" } + } + ], + "tags": ["issue-credential v2.0"], + "summary": "Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request", + "produces": ["application/json"] + } + }, + "/issue-credential/create": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V10CredentialCreate" } + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Create a credential record without sending (generally for use with Out-Of-Band)", + "produces": ["application/json"] + } + }, + "/issue-credential/create-offer": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/V10CredentialConnFreeOfferRequest" + } + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Create a credential offer, independent of any proposal or connection", + "produces": ["application/json"] + } + }, + "/issue-credential/records": { + "get": { + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/V10CredentialExchangeListResult" + }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "connection_id", + "required": false, + "type": "string", + "format": "uuid", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "role", + "required": false, + "type": "string", + "enum": ["issuer", "holder"], + "description": "Role assigned in credential exchange" + }, + { + "in": "query", + "name": "state", + "required": false, + "type": "string", + "enum": [ + "proposal_sent", + "proposal_received", + "offer_sent", + "offer_received", + "request_sent", + "request_received", + "credential_issued", + "credential_received", + "credential_acked", + "credential_revoked", + "abandoned" + ], + "description": "Credential exchange state" + }, + { + "in": "query", + "name": "thread_id", + "required": false, + "type": "string", + "format": "uuid", + "description": "Thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Fetch all credential exchange records", + "produces": ["application/json"] + } + }, + "/issue-credential/records/{cred_ex_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Fetch a single credential exchange record", + "produces": ["application/json"] + }, + "delete": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/IssueCredentialModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Remove an existing credential exchange record", + "produces": ["application/json"] + } + }, + "/issue-credential/records/{cred_ex_id}/issue": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V10CredentialIssueRequest" } + }, + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Send holder a credential", + "produces": ["application/json"] + } + }, + "/issue-credential/records/{cred_ex_id}/problem-report": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/IssueCredentialModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/V10CredentialProblemReportRequest" + } + }, + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Send a problem report for credential exchange", + "produces": ["application/json"] + } + }, + "/issue-credential/records/{cred_ex_id}/send-offer": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V10CredentialBoundOfferRequest" } + }, + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Send holder a credential offer in reference to a proposal with preview", + "produces": ["application/json"] + } + }, + "/issue-credential/records/{cred_ex_id}/send-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/V10CredentialExchangeAutoRemoveRequest" + } + }, + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Send issuer a credential request", + "produces": ["application/json"] + } + }, + "/issue-credential/records/{cred_ex_id}/store": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V10CredentialStoreRequest" } + }, + { + "in": "path", + "name": "cred_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Store a received credential", + "produces": ["application/json"] + } + }, + "/issue-credential/send": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/V10CredentialProposalRequestMand" + } + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Send holder a credential, automating entire flow", + "produces": ["application/json"] + } + }, + "/issue-credential/send-offer": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V10CredentialFreeOfferRequest" } + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Send holder a credential offer, independent of any proposal", + "produces": ["application/json"] + } + }, + "/issue-credential/send-proposal": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/V10CredentialProposalRequestOpt" + } + } + ], + "tags": ["issue-credential v1.0"], + "summary": "Send issuer a credential proposal", + "produces": ["application/json"] + } + }, + "/jsonld/sign": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/SignResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/SignRequest" } + } + ], + "tags": ["jsonld"], + "summary": "Sign a JSON-LD structure and return it", + "produces": ["application/json"] + } + }, + "/jsonld/verify": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/VerifyResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/VerifyRequest" } + } + ], + "tags": ["jsonld"], + "summary": "Verify a JSON-LD structure.", + "produces": ["application/json"] + } + }, + "/ledger/config": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/LedgerConfigList" }, + "description": "" + } + }, + "parameters": [], + "tags": ["ledger"], + "summary": "Fetch the multiple ledger configuration currently in use", + "produces": ["application/json"] + } + }, + "/ledger/did-endpoint": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/GetDIDEndpointResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "did", + "required": true, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "description": "DID of interest", + "example": "WgWxqztrNooG92RXvxSTWv" + }, + { + "in": "query", + "name": "endpoint_type", + "required": false, + "type": "string", + "enum": ["Endpoint", "Profile", "LinkedDomains"], + "description": "Endpoint type of interest (default 'Endpoint')", + "example": "Endpoint" + } + ], + "tags": ["ledger"], + "summary": "Get the endpoint for a DID from the ledger.", + "produces": ["application/json"] + } + }, + "/ledger/did-verkey": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/GetDIDVerkeyResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "did", + "required": true, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "description": "DID of interest", + "example": "WgWxqztrNooG92RXvxSTWv" + } + ], + "tags": ["ledger"], + "summary": "Get the verkey for a DID from the ledger.", + "produces": ["application/json"] + } + }, + "/ledger/get-nym-role": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/GetNymRoleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "did", + "required": true, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "description": "DID of interest", + "example": "WgWxqztrNooG92RXvxSTWv" + } + ], + "tags": ["ledger"], + "summary": "Get the role from the NYM registration of a public DID.", + "produces": ["application/json"] + } + }, + "/ledger/get-write-ledger": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/WriteLedger" }, + "description": "" + } + }, + "parameters": [], + "tags": ["ledger"], + "summary": "Fetch the current write ledger", + "produces": ["application/json"] + } + }, + "/ledger/get-write-ledgers": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ConfigurableWriteLedgers" }, + "description": "" + } + }, + "parameters": [], + "tags": ["ledger"], + "summary": "Fetch list of available write ledgers", + "produces": ["application/json"] + } + }, + "/ledger/register-nym": { + "post": { + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/TxnOrRegisterLedgerNymResponse" + }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "did", + "required": true, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "description": "DID to register", + "example": "WgWxqztrNooG92RXvxSTWv" + }, + { + "in": "query", + "name": "verkey", + "required": true, + "type": "string", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "description": "Verification key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV" + }, + { + "in": "query", + "name": "alias", + "required": false, + "type": "string", + "description": "Alias", + "example": "Barry" + }, + { + "in": "query", + "name": "conn_id", + "required": false, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "create_transaction_for_endorser", + "required": false, + "type": "boolean", + "description": "Create Transaction For Endorser's signature" + }, + { + "in": "query", + "name": "role", + "required": false, + "type": "string", + "enum": [ + "STEWARD", + "TRUSTEE", + "ENDORSER", + "NETWORK_MONITOR", + "reset" + ], + "description": "Role" + } + ], + "tags": ["ledger"], + "summary": "Send a NYM registration to the ledger.", + "produces": ["application/json"] + } + }, + "/ledger/rotate-public-did-keypair": { + "patch": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/LedgerModulesResult" }, + "description": "" + } + }, + "parameters": [], + "tags": ["ledger"], + "summary": "Rotate key pair for public DID.", + "produces": ["application/json"] + } + }, + "/ledger/taa": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TAAResult" }, + "description": "" + } + }, + "parameters": [], + "tags": ["ledger"], + "summary": "Fetch the current transaction author agreement, if any", + "produces": ["application/json"] + } + }, + "/ledger/taa/accept": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/LedgerModulesResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/TAAAccept" } + } + ], + "tags": ["ledger"], + "summary": "Accept the transaction author agreement", + "produces": ["application/json"] + } + }, + "/ledger/{ledger_id}/set-write-ledger": { + "put": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/WriteLedger" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "ledger_id", + "required": true, + "type": "string" + } + ], + "tags": ["ledger"], + "summary": "Set write ledger", + "produces": ["application/json"] + } + }, + "/mediation/default-mediator": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/MediationRecord" }, + "description": "" + } + }, + "parameters": [], + "tags": ["mediation"], + "summary": "Get default mediator", + "produces": ["application/json"] + }, + "delete": { + "responses": { + "201": { + "schema": { "$ref": "#/definitions/MediationRecord" }, + "description": "" + } + }, + "parameters": [], + "tags": ["mediation"], + "summary": "Clear default mediator", + "produces": ["application/json"] + } + }, + "/mediation/keylists": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/Keylist" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "conn_id", + "required": false, + "type": "string", + "format": "uuid", + "description": "Connection identifier (optional)", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "role", + "required": false, + "type": "string", + "default": "server", + "enum": ["client", "server"], + "description": "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent" + } + ], + "tags": ["mediation"], + "summary": "Retrieve keylists by connection or role", + "produces": ["application/json"] + } + }, + "/mediation/keylists/{mediation_id}/send-keylist-query": { + "post": { + "responses": { + "201": { + "schema": { "$ref": "#/definitions/KeylistQuery" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/KeylistQueryFilterRequest" } + }, + { + "in": "path", + "name": "mediation_id", + "required": true, + "type": "string", + "format": "uuid", + "description": "Mediation record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "paginate_limit", + "required": false, + "type": "integer", + "format": "int32", + "default": -1, + "description": "limit number of results" + }, + { + "in": "query", + "name": "paginate_offset", + "required": false, + "type": "integer", + "format": "int32", + "default": 0, + "description": "offset to use in pagination" + } + ], + "tags": ["mediation"], + "summary": "Send keylist query to mediator", + "produces": ["application/json"] + } + }, + "/mediation/keylists/{mediation_id}/send-keylist-update": { + "post": { + "responses": { + "201": { + "schema": { "$ref": "#/definitions/KeylistUpdate" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/KeylistUpdateRequest" } + }, + { + "in": "path", + "name": "mediation_id", + "required": true, + "type": "string", + "format": "uuid", + "description": "Mediation record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["mediation"], + "summary": "Send keylist update to mediator", + "produces": ["application/json"] + } + }, + "/mediation/request/{conn_id}": { + "post": { + "responses": { + "201": { + "schema": { "$ref": "#/definitions/MediationRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/MediationCreateRequest" } + }, + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["mediation"], + "summary": "Request mediation from connection", + "produces": ["application/json"] + } + }, + "/mediation/requests": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/MediationList" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "conn_id", + "required": false, + "type": "string", + "format": "uuid", + "description": "Connection identifier (optional)", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "state", + "required": false, + "type": "string", + "enum": ["request", "granted", "denied"], + "description": "Mediation state (optional)", + "example": "granted" + } + ], + "tags": ["mediation"], + "summary": "Query mediation requests, returns list of all mediation records", + "produces": ["application/json"] + } + }, + "/mediation/requests/{mediation_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/MediationRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "mediation_id", + "required": true, + "type": "string", + "format": "uuid", + "description": "Mediation record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["mediation"], + "summary": "Retrieve mediation request record", + "produces": ["application/json"] + }, + "delete": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/MediationRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "mediation_id", + "required": true, + "type": "string", + "format": "uuid", + "description": "Mediation record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["mediation"], + "summary": "Delete mediation request by ID", + "produces": ["application/json"] + } + }, + "/mediation/requests/{mediation_id}/deny": { + "post": { + "responses": { + "201": { + "schema": { "$ref": "#/definitions/MediationDeny" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/AdminMediationDeny" } + }, + { + "in": "path", + "name": "mediation_id", + "required": true, + "type": "string", + "format": "uuid", + "description": "Mediation record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["mediation"], + "summary": "Deny a stored mediation request", + "produces": ["application/json"] + } + }, + "/mediation/requests/{mediation_id}/grant": { + "post": { + "responses": { + "201": { + "schema": { "$ref": "#/definitions/MediationGrant" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "mediation_id", + "required": true, + "type": "string", + "format": "uuid", + "description": "Mediation record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["mediation"], + "summary": "Grant received mediation", + "produces": ["application/json"] + } + }, + "/mediation/update-keylist/{conn_id}": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/KeylistUpdate" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/MediationIdMatchInfo" } + }, + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["mediation"], + "summary": "Update keylist for a connection", + "produces": ["application/json"] + } + }, + "/mediation/{mediation_id}/default-mediator": { + "put": { + "responses": { + "201": { + "schema": { "$ref": "#/definitions/MediationRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "mediation_id", + "required": true, + "type": "string", + "format": "uuid", + "description": "Mediation record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["mediation"], + "summary": "Set default mediator", + "produces": ["application/json"] + } + }, + "/multitenancy/wallet": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/CreateWalletResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/CreateWalletRequest" } + } + ], + "tags": ["multitenancy"], + "summary": "Create a subwallet", + "produces": ["application/json"] + } + }, + "/multitenancy/wallet/{wallet_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/WalletRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "wallet_id", + "required": true, + "type": "string", + "description": "Subwallet identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["multitenancy"], + "summary": "Get a single subwallet", + "produces": ["application/json"] + }, + "put": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/WalletRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/UpdateWalletRequest" } + }, + { + "in": "path", + "name": "wallet_id", + "required": true, + "type": "string", + "description": "Subwallet identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["multitenancy"], + "summary": "Update a subwallet", + "produces": ["application/json"] + } + }, + "/multitenancy/wallet/{wallet_id}/remove": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/MultitenantModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/RemoveWalletRequest" } + }, + { + "in": "path", + "name": "wallet_id", + "required": true, + "type": "string", + "description": "Subwallet identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["multitenancy"], + "summary": "Remove a subwallet", + "produces": ["application/json"] + } + }, + "/multitenancy/wallet/{wallet_id}/token": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/CreateWalletTokenResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/CreateWalletTokenRequest" } + }, + { + "in": "path", + "name": "wallet_id", + "required": true, + "type": "string" + } + ], + "tags": ["multitenancy"], + "summary": "Get auth token for a subwallet", + "produces": ["application/json"] + } + }, + "/multitenancy/wallets": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/WalletList" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "wallet_name", + "required": false, + "type": "string", + "description": "Wallet name", + "example": "MyNewWallet" + } + ], + "tags": ["multitenancy"], + "summary": "Query subwallets", + "produces": ["application/json"] + } + }, + "/out-of-band/create-invitation": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/InvitationRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/InvitationCreateRequest" } + }, + { + "in": "query", + "name": "auto_accept", + "required": false, + "type": "boolean", + "description": "Auto-accept connection (defaults to configuration)" + }, + { + "in": "query", + "name": "multi_use", + "required": false, + "type": "boolean", + "description": "Create invitation for multiple use (default false)" + } + ], + "tags": ["out-of-band"], + "summary": "Create a new connection invitation", + "produces": ["application/json"] + } + }, + "/out-of-band/receive-invitation": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/OobRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/InvitationMessage" } + }, + { + "in": "query", + "name": "alias", + "required": false, + "type": "string", + "description": "Alias for connection", + "example": "Barry" + }, + { + "in": "query", + "name": "auto_accept", + "required": false, + "type": "boolean", + "description": "Auto-accept connection (defaults to configuration)" + }, + { + "in": "query", + "name": "mediation_id", + "required": false, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Identifier for active mediation record to be used", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "use_existing_connection", + "required": false, + "type": "boolean", + "description": "Use an existing connection, if possible" + } + ], + "tags": ["out-of-band"], + "summary": "Receive a new connection invitation", + "produces": ["application/json"] + } + }, + "/plugins": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/AdminModules" }, + "description": "" + } + }, + "parameters": [], + "tags": ["server"], + "summary": "Fetch the list of loaded plugins", + "produces": ["application/json"] + } + }, + "/present-proof-2.0/create-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20PresCreateRequestRequest" } + } + ], + "tags": ["present-proof v2.0"], + "summary": "Creates a presentation request not bound to any proposal or connection", + "produces": ["application/json"] + } + }, + "/present-proof-2.0/records": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20PresExRecordList" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "connection_id", + "required": false, + "type": "string", + "format": "uuid", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "role", + "required": false, + "type": "string", + "enum": ["prover", "verifier"], + "description": "Role assigned in presentation exchange" + }, + { + "in": "query", + "name": "state", + "required": false, + "type": "string", + "enum": [ + "proposal-sent", + "proposal-received", + "request-sent", + "request-received", + "presentation-sent", + "presentation-received", + "done", + "abandoned" + ], + "description": "Presentation exchange state" + }, + { + "in": "query", + "name": "thread_id", + "required": false, + "type": "string", + "format": "uuid", + "description": "Thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v2.0"], + "summary": "Fetch all present-proof exchange records", + "produces": ["application/json"] + } + }, + "/present-proof-2.0/records/{pres_ex_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v2.0"], + "summary": "Fetch a single presentation exchange record", + "produces": ["application/json"] + }, + "delete": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20PresentProofModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v2.0"], + "summary": "Remove an existing presentation exchange record", + "produces": ["application/json"] + } + }, + "/present-proof-2.0/records/{pres_ex_id}/credentials": { + "get": { + "responses": { + "200": { + "schema": { + "type": "array", + "items": { "$ref": "#/definitions/IndyCredPrecis" } + }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "count", + "required": false, + "type": "string", + "pattern": "^[1-9][0-9]*$", + "description": "Maximum number to retrieve", + "example": "1" + }, + { + "in": "query", + "name": "extra_query", + "required": false, + "type": "string", + "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", + "description": "(JSON) object mapping referents to extra WQL queries", + "example": "{\"0_drink_uuid\": {\"attr::drink::value\": \"martini\"}}" + }, + { + "in": "query", + "name": "referent", + "required": false, + "type": "string", + "description": "Proof request referents of interest, comma-separated", + "example": "1_name_uuid,2_score_uuid" + }, + { + "in": "query", + "name": "start", + "required": false, + "type": "string", + "pattern": "^[0-9]*$", + "description": "Start index", + "example": "0" + } + ], + "tags": ["present-proof v2.0"], + "summary": "Fetch credentials from wallet for presentation request", + "produces": ["application/json"] + } + }, + "/present-proof-2.0/records/{pres_ex_id}/problem-report": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20PresentProofModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20PresProblemReportRequest" } + }, + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v2.0"], + "summary": "Send a problem report for presentation exchange", + "produces": ["application/json"] + } + }, + "/present-proof-2.0/records/{pres_ex_id}/send-presentation": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20PresSpecByFormatRequest" } + }, + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v2.0"], + "summary": "Sends a proof presentation", + "produces": ["application/json"] + } + }, + "/present-proof-2.0/records/{pres_ex_id}/send-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/V20PresentationSendRequestToProposal" + } + }, + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v2.0"], + "summary": "Sends a presentation request in reference to a proposal", + "produces": ["application/json"] + } + }, + "/present-proof-2.0/records/{pres_ex_id}/verify-presentation": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v2.0"], + "summary": "Verify a received presentation", + "produces": ["application/json"] + } + }, + "/present-proof-2.0/send-proposal": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20PresProposalRequest" } + } + ], + "tags": ["present-proof v2.0"], + "summary": "Sends a presentation proposal", + "produces": ["application/json"] + } + }, + "/present-proof-2.0/send-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V20PresSendRequestRequest" } + } + ], + "tags": ["present-proof v2.0"], + "summary": "Sends a free presentation request not bound to any proposal", + "produces": ["application/json"] + } + }, + "/present-proof/create-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/V10PresentationCreateRequestRequest" + } + } + ], + "tags": ["present-proof v1.0"], + "summary": "Creates a presentation request not bound to any proposal or connection", + "produces": ["application/json"] + } + }, + "/present-proof/records": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10PresentationExchangeList" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "connection_id", + "required": false, + "type": "string", + "format": "uuid", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "role", + "required": false, + "type": "string", + "enum": ["prover", "verifier"], + "description": "Role assigned in presentation exchange" + }, + { + "in": "query", + "name": "state", + "required": false, + "type": "string", + "enum": [ + "proposal_sent", + "proposal_received", + "request_sent", + "request_received", + "presentation_sent", + "presentation_received", + "verified", + "presentation_acked", + "abandoned" + ], + "description": "Presentation exchange state" + }, + { + "in": "query", + "name": "thread_id", + "required": false, + "type": "string", + "format": "uuid", + "description": "Thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v1.0"], + "summary": "Fetch all present-proof exchange records", + "produces": ["application/json"] + } + }, + "/present-proof/records/{pres_ex_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v1.0"], + "summary": "Fetch a single presentation exchange record", + "produces": ["application/json"] + }, + "delete": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10PresentProofModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v1.0"], + "summary": "Remove an existing presentation exchange record", + "produces": ["application/json"] + } + }, + "/present-proof/records/{pres_ex_id}/credentials": { + "get": { + "responses": { + "200": { + "schema": { + "type": "array", + "items": { "$ref": "#/definitions/IndyCredPrecis" } + }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "count", + "required": false, + "type": "string", + "pattern": "^[1-9][0-9]*$", + "description": "Maximum number to retrieve", + "example": "1" + }, + { + "in": "query", + "name": "extra_query", + "required": false, + "type": "string", + "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", + "description": "(JSON) object mapping referents to extra WQL queries", + "example": "{\"0_drink_uuid\": {\"attr::drink::value\": \"martini\"}}" + }, + { + "in": "query", + "name": "referent", + "required": false, + "type": "string", + "description": "Proof request referents of interest, comma-separated", + "example": "1_name_uuid,2_score_uuid" + }, + { + "in": "query", + "name": "start", + "required": false, + "type": "string", + "pattern": "^[0-9]*$", + "description": "Start index", + "example": "0" + } + ], + "tags": ["present-proof v1.0"], + "summary": "Fetch credentials for a presentation request from wallet", + "produces": ["application/json"] + } + }, + "/present-proof/records/{pres_ex_id}/problem-report": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10PresentProofModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/V10PresentationProblemReportRequest" + } + }, + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v1.0"], + "summary": "Send a problem report for presentation exchange", + "produces": ["application/json"] + } + }, + "/present-proof/records/{pres_ex_id}/send-presentation": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V10PresentationSendRequest" } + }, + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v1.0"], + "summary": "Sends a proof presentation", + "produces": ["application/json"] + } + }, + "/present-proof/records/{pres_ex_id}/send-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/V10PresentationSendRequestToProposal" + } + }, + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v1.0"], + "summary": "Sends a presentation request in reference to a proposal", + "produces": ["application/json"] + } + }, + "/present-proof/records/{pres_ex_id}/verify-presentation": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "pres_ex_id", + "required": true, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["present-proof v1.0"], + "summary": "Verify a received presentation", + "produces": ["application/json"] + } + }, + "/present-proof/send-proposal": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/V10PresentationProposalRequest" } + } + ], + "tags": ["present-proof v1.0"], + "summary": "Sends a presentation proposal", + "produces": ["application/json"] + } + }, + "/present-proof/send-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { + "$ref": "#/definitions/V10PresentationSendRequestRequest" + } + } + ], + "tags": ["present-proof v1.0"], + "summary": "Sends a free presentation request not bound to any proposal", + "produces": ["application/json"] + } + }, + "/resolver/resolve/{did}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ResolutionResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "did", + "required": true, + "type": "string", + "pattern": "^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$", + "description": "DID", + "example": "did:ted:WgWxqztrNooG92RXvxSTWv" + } + ], + "tags": ["resolver"], + "summary": "Retrieve doc for requested did", + "produces": ["application/json"] + } + }, + "/revocation/active-registry/{cred_def_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevRegResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "cred_def_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag" + } + ], + "tags": ["revocation"], + "summary": "Get current active revocation registry by credential definition id", + "produces": ["application/json"] + } + }, + "/revocation/active-registry/{cred_def_id}/rotate": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevRegsCreated" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "cred_def_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag" + } + ], + "tags": ["revocation"], + "summary": "Rotate revocation registry", + "produces": ["application/json"] + } + }, + "/revocation/clear-pending-revocations": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/PublishRevocations" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/ClearPendingRevocationsRequest" } + } + ], + "tags": ["revocation"], + "summary": "Clear pending revocations", + "produces": ["application/json"] + } + }, + "/revocation/create-registry": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevRegResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/RevRegCreateRequest" } + } + ], + "tags": ["revocation"], + "summary": "Creates a new revocation registry", + "produces": ["application/json"] + } + }, + "/revocation/credential-record": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/CredRevRecordResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "cred_ex_id", + "required": false, + "type": "string", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "cred_rev_id", + "required": false, + "type": "string", + "pattern": "^[1-9][0-9]*$", + "description": "Credential revocation identifier", + "example": "12345" + }, + { + "in": "query", + "name": "rev_reg_id", + "required": false, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + } + ], + "tags": ["revocation"], + "summary": "Get credential revocation status", + "produces": ["application/json"] + } + }, + "/revocation/publish-revocations": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TxnOrPublishRevocationsResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/PublishRevocations" } + } + ], + "tags": ["revocation"], + "summary": "Publish pending revocations to ledger", + "produces": ["application/json"] + } + }, + "/revocation/registries/created": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevRegsCreated" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "cred_def_id", + "required": false, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag" + }, + { + "in": "query", + "name": "state", + "required": false, + "type": "string", + "enum": [ + "init", + "generated", + "posted", + "active", + "full", + "decommissioned" + ], + "description": "Revocation registry state" + } + ], + "tags": ["revocation"], + "summary": "Search for matching revocation registries that current agent created", + "produces": ["application/json"] + } + }, + "/revocation/registry/delete-tails-file": { + "delete": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TailsDeleteResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "cred_def_id", + "required": false, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag" + }, + { + "in": "query", + "name": "rev_reg_id", + "required": false, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + } + ], + "tags": ["revocation"], + "summary": "Delete the tail files", + "produces": ["application/json"] + } + }, + "/revocation/registry/{rev_reg_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevRegResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "rev_reg_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation Registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + } + ], + "tags": ["revocation"], + "summary": "Get revocation registry by revocation registry id", + "produces": ["application/json"] + }, + "patch": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevRegResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/RevRegUpdateTailsFileUri" } + }, + { + "in": "path", + "name": "rev_reg_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation Registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + } + ], + "tags": ["revocation"], + "summary": "Update revocation registry with new public URI to its tails file", + "produces": ["application/json"] + } + }, + "/revocation/registry/{rev_reg_id}/definition": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TxnOrRevRegResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "rev_reg_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation Registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + }, + { + "in": "query", + "name": "conn_id", + "required": false, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "create_transaction_for_endorser", + "required": false, + "type": "boolean", + "description": "Create Transaction For Endorser's signature" + } + ], + "tags": ["revocation"], + "summary": "Send revocation registry definition to ledger", + "produces": ["application/json"] + } + }, + "/revocation/registry/{rev_reg_id}/entry": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevRegResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "rev_reg_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation Registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + }, + { + "in": "query", + "name": "conn_id", + "required": false, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "create_transaction_for_endorser", + "required": false, + "type": "boolean", + "description": "Create Transaction For Endorser's signature" + } + ], + "tags": ["revocation"], + "summary": "Send revocation registry entry to ledger", + "produces": ["application/json"] + } + }, + "/revocation/registry/{rev_reg_id}/fix-revocation-entry-state": { + "put": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevRegWalletUpdatedResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "rev_reg_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation Registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + }, + { + "in": "query", + "name": "apply_ledger_update", + "required": true, + "type": "boolean", + "description": "Apply updated accumulator transaction to ledger" + } + ], + "tags": ["revocation"], + "summary": "Fix revocation state in wallet and return number of updated entries", + "produces": ["application/json"] + } + }, + "/revocation/registry/{rev_reg_id}/issued": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevRegIssuedResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "rev_reg_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation Registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + } + ], + "tags": ["revocation"], + "summary": "Get number of credentials issued against revocation registry", + "produces": ["application/json"] + } + }, + "/revocation/registry/{rev_reg_id}/issued/details": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/CredRevRecordDetailsResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "rev_reg_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation Registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + } + ], + "tags": ["revocation"], + "summary": "Get details of credentials issued against revocation registry", + "produces": ["application/json"] + } + }, + "/revocation/registry/{rev_reg_id}/issued/indy_recs": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/CredRevIndyRecordsResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "rev_reg_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation Registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + } + ], + "tags": ["revocation"], + "summary": "Get details of revoked credentials from ledger", + "produces": ["application/json"] + } + }, + "/revocation/registry/{rev_reg_id}/set-state": { + "patch": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevRegResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "rev_reg_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation Registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + }, + { + "in": "query", + "name": "state", + "required": true, + "type": "string", + "enum": ["init", "generated", "posted", "active", "full"], + "description": "Revocation registry state to set" + } + ], + "tags": ["revocation"], + "summary": "Set revocation registry state manually", + "produces": ["application/json"] + } + }, + "/revocation/registry/{rev_reg_id}/tails-file": { + "put": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevocationModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "rev_reg_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation Registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + } + ], + "tags": ["revocation"], + "summary": "Upload local tails file to server", + "produces": ["application/json"] + }, + "get": { + "responses": { + "200": { + "schema": { "type": "string", "format": "binary" }, + "description": "tails file" + } + }, + "parameters": [ + { + "in": "path", + "name": "rev_reg_id", + "required": true, + "type": "string", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "description": "Revocation Registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0" + } + ], + "tags": ["revocation"], + "summary": "Download tails file", + "produces": ["application/octet-stream"] + } + }, + "/revocation/revoke": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/RevocationModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/RevokeRequest" } + } + ], + "tags": ["revocation"], + "summary": "Revoke an issued credential", + "produces": ["application/json"] + } + }, + "/schemas": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TxnOrSchemaSendResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/SchemaSendRequest" } + }, + { + "in": "query", + "name": "conn_id", + "required": false, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "create_transaction_for_endorser", + "required": false, + "type": "boolean", + "description": "Create Transaction For Endorser's signature" + } + ], + "tags": ["schema"], + "summary": "Sends a schema to the ledger", + "produces": ["application/json"] + } + }, + "/schemas/created": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/SchemasCreatedResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "schema_id", + "required": false, + "type": "string", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0" + }, + { + "in": "query", + "name": "schema_issuer_did", + "required": false, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "description": "Schema issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv" + }, + { + "in": "query", + "name": "schema_name", + "required": false, + "type": "string", + "description": "Schema name", + "example": "membership" + }, + { + "in": "query", + "name": "schema_version", + "required": false, + "type": "string", + "pattern": "^[0-9.]+$", + "description": "Schema version", + "example": "1.0" + } + ], + "tags": ["schema"], + "summary": "Search for matching schema that agent originated", + "produces": ["application/json"] + } + }, + "/schemas/{schema_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/SchemaGetResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "schema_id", + "required": true, + "type": "string", + "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0" + } + ], + "tags": ["schema"], + "summary": "Gets a schema from the ledger", + "produces": ["application/json"] + } + }, + "/schemas/{schema_id}/write_record": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/SchemaGetResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "schema_id", + "required": true, + "type": "string", + "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0" + } + ], + "tags": ["schema"], + "summary": "Writes a schema non-secret record to the wallet", + "produces": ["application/json"] + } + }, + "/settings": { + "put": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ProfileSettings" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/UpdateProfileSettings" } + } + ], + "tags": ["settings"], + "summary": "Update configurable settings associated with the profile.", + "produces": ["application/json"] + }, + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/ProfileSettings" }, + "description": "" + } + }, + "parameters": [], + "tags": ["settings"], + "summary": "Get the configurable settings associated with the profile.", + "produces": ["application/json"] + } + }, + "/shutdown": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/AdminShutdown" }, + "description": "" + } + }, + "parameters": [], + "tags": ["server"], + "summary": "Shut down server", + "produces": ["application/json"] + } + }, + "/status": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/AdminStatus" }, + "description": "" + } + }, + "parameters": [], + "tags": ["server"], + "summary": "Fetch the server status", + "produces": ["application/json"] + } + }, + "/status/config": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/AdminConfig" }, + "description": "" + } + }, + "parameters": [], + "tags": ["server"], + "summary": "Fetch the server configuration", + "produces": ["application/json"] + } + }, + "/status/live": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/AdminStatusLiveliness" }, + "description": "" + } + }, + "parameters": [], + "tags": ["server"], + "summary": "Liveliness check", + "produces": ["application/json"] + } + }, + "/status/ready": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/AdminStatusReadiness" }, + "description": "" + } + }, + "parameters": [], + "tags": ["server"], + "summary": "Readiness check", + "produces": ["application/json"] + } + }, + "/status/reset": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/AdminReset" }, + "description": "" + } + }, + "parameters": [], + "tags": ["server"], + "summary": "Reset statistics", + "produces": ["application/json"] + } + }, + "/transaction/{tran_id}/resend": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TransactionRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "tran_id", + "required": true, + "type": "string", + "description": "Transaction identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["endorse-transaction"], + "summary": "For Author to resend a particular transaction request", + "produces": ["application/json"] + } + }, + "/transactions": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TransactionList" }, + "description": "" + } + }, + "parameters": [], + "tags": ["endorse-transaction"], + "summary": "Query transactions", + "produces": ["application/json"] + } + }, + "/transactions/create-request": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TransactionRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/Date" } + }, + { + "in": "query", + "name": "tran_id", + "required": true, + "type": "string", + "description": "Transaction identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "endorser_write_txn", + "required": false, + "type": "boolean", + "description": "Endorser will write the transaction after endorsing it" + } + ], + "tags": ["endorse-transaction"], + "summary": "For author to send a transaction request", + "produces": ["application/json"] + } + }, + "/transactions/{conn_id}/set-endorser-info": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/EndorserInfo" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "endorser_did", + "required": true, + "type": "string", + "description": "Endorser DID" + }, + { + "in": "query", + "name": "endorser_name", + "required": false, + "type": "string", + "description": "Endorser Name" + } + ], + "tags": ["endorse-transaction"], + "summary": "Set Endorser Info", + "produces": ["application/json"] + } + }, + "/transactions/{conn_id}/set-endorser-role": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TransactionJobs" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "conn_id", + "required": true, + "type": "string", + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "transaction_my_job", + "required": false, + "type": "string", + "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], + "description": "Transaction related jobs" + } + ], + "tags": ["endorse-transaction"], + "summary": "Set transaction jobs", + "produces": ["application/json"] + } + }, + "/transactions/{tran_id}": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TransactionRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "tran_id", + "required": true, + "type": "string", + "description": "Transaction identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["endorse-transaction"], + "summary": "Fetch a single transaction record", + "produces": ["application/json"] + } + }, + "/transactions/{tran_id}/cancel": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TransactionRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "tran_id", + "required": true, + "type": "string", + "description": "Transaction identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["endorse-transaction"], + "summary": "For Author to cancel a particular transaction request", + "produces": ["application/json"] + } + }, + "/transactions/{tran_id}/endorse": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TransactionRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "tran_id", + "required": true, + "type": "string", + "description": "Transaction identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + }, + { + "in": "query", + "name": "endorser_did", + "required": false, + "type": "string", + "description": "Endorser DID" + } + ], + "tags": ["endorse-transaction"], + "summary": "For Endorser to endorse a particular transaction record", + "produces": ["application/json"] + } + }, + "/transactions/{tran_id}/refuse": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TransactionRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "tran_id", + "required": true, + "type": "string", + "description": "Transaction identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["endorse-transaction"], + "summary": "For Endorser to refuse a particular transaction record", + "produces": ["application/json"] + } + }, + "/transactions/{tran_id}/write": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/TransactionRecord" }, + "description": "" + } + }, + "parameters": [ + { + "in": "path", + "name": "tran_id", + "required": true, + "type": "string", + "description": "Transaction identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + ], + "tags": ["endorse-transaction"], + "summary": "For Author / Endorser to write an endorsed transaction to the ledger", + "produces": ["application/json"] + } + }, + "/wallet/did": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/DIDList" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "did", + "required": false, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "description": "DID of interest", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv" + }, + { + "in": "query", + "name": "key_type", + "required": false, + "type": "string", + "enum": ["ed25519", "bls12381g2"], + "example": "ed25519", + "description": "Key type to query for." + }, + { + "in": "query", + "name": "method", + "required": false, + "type": "string", + "enum": ["key", "sov"], + "example": "key", + "description": "DID method to query for. e.g. sov to only fetch indy/sov DIDs" + }, + { + "in": "query", + "name": "posture", + "required": false, + "type": "string", + "enum": ["public", "posted", "wallet_only"], + "description": "Whether DID is current public DID, posted to ledger but current public DID, or local to the wallet", + "example": "wallet_only" + }, + { + "in": "query", + "name": "verkey", + "required": false, + "type": "string", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "description": "Verification key of interest", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV" + } + ], + "tags": ["wallet"], + "summary": "List wallet DIDs", + "produces": ["application/json"] + } + }, + "/wallet/did/create": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/DIDResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/DIDCreate" } + } + ], + "tags": ["wallet"], + "summary": "Create a local DID", + "produces": ["application/json"] + } + }, + "/wallet/did/local/rotate-keypair": { + "patch": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/WalletModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "did", + "required": true, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "description": "DID of interest", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv" + } + ], + "tags": ["wallet"], + "summary": "Rotate keypair for a DID not posted to the ledger", + "produces": ["application/json"] + } + }, + "/wallet/did/public": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/DIDResult" }, + "description": "" + } + }, + "parameters": [], + "tags": ["wallet"], + "summary": "Fetch the current public DID", + "produces": ["application/json"] + }, + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/DIDResult" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "did", + "required": true, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "description": "DID of interest", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv" + }, + { + "in": "query", + "name": "conn_id", + "required": false, + "type": "string", + "description": "Connection identifier" + }, + { + "in": "query", + "name": "create_transaction_for_endorser", + "required": false, + "type": "boolean", + "description": "Create Transaction For Endorser's signature" + }, + { + "in": "query", + "name": "mediation_id", + "required": false, + "type": "string", + "description": "Mediation identifier" + } + ], + "tags": ["wallet"], + "summary": "Assign the current public DID", + "produces": ["application/json"] + } + }, + "/wallet/get-did-endpoint": { + "get": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/DIDEndpoint" }, + "description": "" + } + }, + "parameters": [ + { + "in": "query", + "name": "did", + "required": true, + "type": "string", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "description": "DID of interest", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv" + } + ], + "tags": ["wallet"], + "summary": "Query DID endpoint in wallet", + "produces": ["application/json"] + } + }, + "/wallet/jwt/sign": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/WalletModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/JWSCreate" } + } + ], + "tags": ["wallet"], + "summary": "Create a EdDSA jws using did keys with a given payload", + "produces": ["application/json"] + } + }, + "/wallet/jwt/verify": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/JWSVerifyResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/JWSVerify" } + } + ], + "tags": ["wallet"], + "summary": "Verify a EdDSA jws using did keys with a given JWS", + "produces": ["application/json"] + } + }, + "/wallet/sd-jwt/sign": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/WalletModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/SDJWSCreate" } + } + ], + "tags": ["wallet"], + "summary": "Create a EdDSA sd-jws using did keys with a given payload", + "produces": ["application/json"] + } + }, + "/wallet/sd-jwt/verify": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/SDJWSVerifyResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/SDJWSVerify" } + } + ], + "tags": ["wallet"], + "summary": "Verify a EdDSA sd-jws using did keys with a given SD-JWS with optional key binding", + "produces": ["application/json"] + } + }, + "/wallet/set-did-endpoint": { + "post": { + "responses": { + "200": { + "schema": { "$ref": "#/definitions/WalletModuleResponse" }, + "description": "" + } + }, + "parameters": [ + { + "in": "body", + "required": false, + "name": "body", + "schema": { "$ref": "#/definitions/DIDEndpointWithType" } + }, + { + "in": "query", + "name": "conn_id", + "required": false, + "type": "string", + "description": "Connection identifier" + }, + { + "in": "query", + "name": "create_transaction_for_endorser", + "required": false, + "type": "boolean", + "description": "Create Transaction For Endorser's signature" + } + ], + "tags": ["wallet"], + "summary": "Update endpoint in wallet and on ledger if posted to it", + "produces": ["application/json"] + } + } + }, + "info": { "title": "Aries Cloud Agent", "version": "v0.11.0" }, + "swagger": "2.0", + "definitions": { + "AMLRecord": { + "properties": { + "aml": { + "additionalProperties": { "type": "string" }, + "type": "object" + }, + "amlContext": { "type": "string" }, + "version": { "type": "string" } + }, + "type": "object" + }, + "ActionMenuFetchResult": { + "properties": { + "result": { + "allOf": [{ "$ref": "#/definitions/Menu" }], + "description": "Action menu" + } + }, + "type": "object" + }, + "ActionMenuModulesResult": { "properties": {}, "type": "object" }, + "AdminConfig": { + "properties": { + "config": { "description": "Configuration settings", "type": "object" } + }, + "type": "object" + }, + "AdminMediationDeny": { "properties": {}, "type": "object" }, + "AdminModules": { + "properties": { + "result": { + "description": "List of admin modules", + "items": { "description": "admin module", "type": "string" }, + "type": "array" + } + }, + "type": "object" + }, + "AdminReset": { "properties": {}, "type": "object" }, + "AdminShutdown": { "properties": {}, "type": "object" }, + "AdminStatus": { + "properties": { + "conductor": { + "description": "Conductor statistics", + "type": "object" + }, + "label": { + "description": "Default label", + "type": "string", + "x-nullable": true + }, + "timing": { "description": "Timing results", "type": "object" }, + "version": { "description": "Version code", "type": "string" } + }, + "type": "object" + }, + "AdminStatusLiveliness": { + "properties": { + "alive": { + "description": "Liveliness status", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "AdminStatusReadiness": { + "properties": { + "ready": { + "description": "Readiness status", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "AttachDecorator": { + "properties": { + "@id": { + "description": "Attachment identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "byte_count": { + "description": "Byte count of data included by reference", + "example": 1234, + "format": "int32", + "type": "integer" + }, + "data": { "$ref": "#/definitions/AttachDecoratorData" }, + "description": { + "description": "Human-readable description of content", + "example": "view from doorway, facing east, with lights off", + "type": "string" + }, + "filename": { + "description": "File name", + "example": "IMG1092348.png", + "type": "string" + }, + "lastmod_time": { + "description": "Hint regarding last modification datetime, in ISO-8601 format", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "mime-type": { + "description": "MIME type", + "example": "image/png", + "type": "string" + } + }, + "required": ["data"], + "type": "object" + }, + "AttachDecoratorData": { + "properties": { + "base64": { + "description": "Base64-encoded data", + "example": "ey4uLn0=", + "pattern": "^[a-zA-Z0-9+/]*={0,2}$", + "type": "string" + }, + "json": { + "description": "JSON-serialized data", + "example": "{\"sample\": \"content\"}" + }, + "jws": { + "allOf": [{ "$ref": "#/definitions/AttachDecoratorDataJWS" }], + "description": "Detached Java Web Signature" + }, + "links": { + "description": "List of hypertext links to data", + "items": { "example": "https://link.to/data", "type": "string" }, + "type": "array" + }, + "sha256": { + "description": "SHA256 hash (binhex encoded) of content", + "example": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb", + "pattern": "^[a-fA-F0-9+/]{64}$", + "type": "string" + } + }, + "type": "object" + }, + "AttachDecoratorData1JWS": { + "properties": { + "header": { "$ref": "#/definitions/AttachDecoratorDataJWSHeader" }, + "protected": { + "description": "protected JWS header", + "example": "ey4uLn0", + "pattern": "^[-_a-zA-Z0-9]*$", + "type": "string" + }, + "signature": { + "description": "signature", + "example": "ey4uLn0", + "pattern": "^[-_a-zA-Z0-9]*$", + "type": "string" + } + }, + "required": ["header", "signature"], + "type": "object" + }, + "AttachDecoratorDataJWS": { + "properties": { + "header": { "$ref": "#/definitions/AttachDecoratorDataJWSHeader" }, + "protected": { + "description": "protected JWS header", + "example": "ey4uLn0", + "pattern": "^[-_a-zA-Z0-9]*$", + "type": "string" + }, + "signature": { + "description": "signature", + "example": "ey4uLn0", + "pattern": "^[-_a-zA-Z0-9]*$", + "type": "string" + }, + "signatures": { + "description": "List of signatures", + "items": { "$ref": "#/definitions/AttachDecoratorData1JWS" }, + "type": "array" + } + }, + "type": "object" + }, + "AttachDecoratorDataJWSHeader": { + "properties": { + "kid": { + "description": "Key identifier, in W3C did:key or DID URL format", + "example": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4", + "pattern": "^did:(?:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+|sov:[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}(;.*)?(\\?.*)?#.+)$", + "type": "string" + } + }, + "required": ["kid"], + "type": "object" + }, + "AttachmentDef": { + "properties": { + "id": { + "description": "Attachment identifier", + "example": "attachment-0", + "type": "string" + }, + "type": { + "description": "Attachment type", + "enum": ["credential-offer", "present-proof"], + "example": "present-proof", + "type": "string" + } + }, + "type": "object" + }, + "AttributeMimeTypesResult": { + "properties": { + "results": { + "additionalProperties": { + "description": "MIME type", + "type": "string" + }, + "type": "object", + "x-nullable": true + } + }, + "type": "object" + }, + "BasicMessageModuleResponse": { "properties": {}, "type": "object" }, + "ClaimFormat": { + "properties": { + "jwt": { "type": "object" }, + "jwt_vc": { "type": "object" }, + "jwt_vp": { "type": "object" }, + "ldp": { "type": "object" }, + "ldp_vc": { "type": "object" }, + "ldp_vp": { "type": "object" } + }, + "type": "object" + }, + "ClearPendingRevocationsRequest": { + "properties": { + "purge": { + "additionalProperties": { + "items": { + "description": "Credential revocation identifier", + "example": "12345", + "pattern": "^[1-9][0-9]*$", + "type": "string" + }, + "type": "array" + }, + "description": "Credential revocation ids by revocation registry id: omit for all, specify null or empty list for all pending per revocation registry", + "type": "object" + } + }, + "type": "object" + }, + "ConfigurableWriteLedgers": { + "properties": { + "write_ledgers": { + "description": "List of configurable write ledgers identifiers", + "items": { "description": "Ledgers identifiers", "type": "string" }, + "type": "array" + } + }, + "type": "object" + }, + "ConnRecord": { + "properties": { + "accept": { + "description": "Connection acceptance: manual or auto", + "enum": ["manual", "auto"], + "example": "auto", + "type": "string" + }, + "alias": { + "description": "Optional alias to apply to connection for later use", + "example": "Bob, providing quotes", + "type": "string" + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "connection_protocol": { + "description": "Connection protocol used", + "enum": ["connections/1.0", "didexchange/1.0"], + "example": "connections/1.0", + "type": "string" + }, + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "error_msg": { + "description": "Error message", + "example": "No DIDDoc provided; cannot connect to public DID", + "type": "string" + }, + "inbound_connection_id": { + "description": "Inbound routing connection id to use", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "invitation_key": { + "description": "Public key for connection", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "invitation_mode": { + "description": "Invitation mode", + "enum": ["once", "multi", "static"], + "example": "once", + "type": "string" + }, + "invitation_msg_id": { + "description": "ID of out-of-band invitation message", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "my_did": { + "description": "Our DID for connection", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "request_id": { + "description": "Connection request identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "rfc23_state": { + "description": "State per RFC 23", + "example": "invitation-sent", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Current record state", + "example": "active", + "type": "string" + }, + "their_did": { + "description": "Their DID for connection", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "their_label": { + "description": "Their label for connection", + "example": "Bob", + "type": "string" + }, + "their_public_did": { + "description": "Other agent's public DID for connection", + "example": "2cpBmR3FqGKWi5EyUbpRY8", + "type": "string" + }, + "their_role": { + "description": "Their role in the connection protocol", + "enum": ["invitee", "requester", "inviter", "responder"], + "example": "requester", + "type": "string" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionInvitation": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "did": { + "description": "DID for connection invitation", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "type": "string" + }, + "imageUrl": { + "description": "Optional image URL for connection invitation", + "example": "http://192.168.56.101/img/logo.jpg", + "format": "url", + "type": "string", + "x-nullable": true + }, + "label": { + "description": "Optional label for connection invitation", + "example": "Bob", + "type": "string" + }, + "recipientKeys": { + "description": "List of recipient keys", + "items": { + "description": "Recipient public key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "type": "array" + }, + "routingKeys": { + "description": "List of routing keys", + "items": { + "description": "Routing key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "type": "array" + }, + "serviceEndpoint": { + "description": "Service endpoint at which to reach this agent", + "example": "http://192.168.56.101:8020", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionList": { + "properties": { + "results": { + "description": "List of connection records", + "items": { "$ref": "#/definitions/ConnRecord" }, + "type": "array" + } + }, + "type": "object" + }, + "ConnectionMetadata": { + "properties": { + "results": { + "description": "Dictionary of metadata associated with connection.", + "type": "object" + } + }, + "type": "object" + }, + "ConnectionMetadataSetRequest": { + "properties": { + "metadata": { + "description": "Dictionary of metadata to set for connection.", + "type": "object" + } + }, + "required": ["metadata"], + "type": "object" + }, + "ConnectionModuleResponse": { "properties": {}, "type": "object" }, + "ConnectionStaticRequest": { + "properties": { + "alias": { + "description": "Alias to assign to this connection", + "type": "string" + }, + "my_did": { + "description": "Local DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "my_seed": { + "description": "Seed to use for the local DID", + "type": "string" + }, + "their_did": { + "description": "Remote DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "their_endpoint": { + "description": "URL endpoint for other party", + "example": "https://myhost:8021", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + }, + "their_label": { + "description": "Other party's label for this connection", + "type": "string" + }, + "their_seed": { + "description": "Seed to use for the remote DID", + "type": "string" + }, + "their_verkey": { + "description": "Remote verification key", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionStaticResult": { + "properties": { + "my_did": { + "description": "Local DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "my_endpoint": { + "description": "My URL endpoint", + "example": "https://myhost:8021", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + }, + "my_verkey": { + "description": "My verification key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "record": { "$ref": "#/definitions/ConnRecord" }, + "their_did": { + "description": "Remote DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "their_verkey": { + "description": "Remote verification key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + } + }, + "required": [ + "my_did", + "my_endpoint", + "my_verkey", + "record", + "their_did", + "their_verkey" + ], + "type": "object" + }, + "Constraints": { + "properties": { + "fields": { + "items": { "$ref": "#/definitions/DIFField" }, + "type": "array" + }, + "is_holder": { + "items": { "$ref": "#/definitions/DIFHolder" }, + "type": "array" + }, + "limit_disclosure": { + "description": "LimitDisclosure", + "type": "string" + }, + "status_active": { + "enum": ["required", "allowed", "disallowed"], + "type": "string" + }, + "status_revoked": { + "enum": ["required", "allowed", "disallowed"], + "type": "string" + }, + "status_suspended": { + "enum": ["required", "allowed", "disallowed"], + "type": "string" + }, + "subject_is_issuer": { + "description": "SubjectIsIssuer", + "enum": ["required", "preferred"], + "type": "string" + } + }, + "type": "object" + }, + "CreateInvitationRequest": { + "properties": { + "mediation_id": { + "description": "Identifier for active mediation record to be used", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type": "string" + }, + "metadata": { + "description": "Optional metadata to attach to the connection created with the invitation", + "type": "object" + }, + "my_label": { + "description": "Optional label for connection invitation", + "example": "Bob", + "type": "string" + }, + "recipient_keys": { + "description": "List of recipient keys", + "items": { + "description": "Recipient public key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "type": "array" + }, + "routing_keys": { + "description": "List of routing keys", + "items": { + "description": "Routing key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "type": "array" + }, + "service_endpoint": { + "description": "Connection endpoint", + "example": "http://192.168.56.102:8020", + "type": "string" + } + }, + "type": "object" + }, + "CreateWalletRequest": { + "properties": { + "extra_settings": { + "description": "Agent config key-value pairs", + "type": "object" + }, + "image_url": { + "description": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", + "example": "https://aries.ca/images/sample.png", + "type": "string" + }, + "key_management_mode": { + "description": "Key management method to use for this wallet.", + "enum": ["managed"], + "example": "managed", + "type": "string" + }, + "label": { + "description": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", + "example": "Alice", + "type": "string" + }, + "wallet_dispatch_type": { + "description": "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", + "enum": ["default", "both", "base"], + "example": "default", + "type": "string" + }, + "wallet_key": { + "description": "Master key used for key derivation.", + "example": "MySecretKey123", + "type": "string" + }, + "wallet_key_derivation": { + "description": "Key derivation", + "enum": ["ARGON2I_MOD", "ARGON2I_INT", "RAW"], + "example": "RAW", + "type": "string" + }, + "wallet_name": { + "description": "Wallet name", + "example": "MyNewWallet", + "type": "string" + }, + "wallet_type": { + "description": "Type of the wallet to create", + "enum": ["askar", "in_memory", "indy"], + "example": "indy", + "type": "string" + }, + "wallet_webhook_urls": { + "description": "List of Webhook URLs associated with this subwallet", + "items": { + "description": "Optional webhook URL to receive webhook messages", + "example": "http://localhost:8022/webhooks", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CreateWalletResponse": { + "properties": { + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "key_management_mode": { + "description": "Mode regarding management of wallet key", + "enum": ["managed", "unmanaged"], + "type": "string" + }, + "settings": { + "description": "Settings for this wallet.", + "type": "object" + }, + "state": { + "description": "Current record state", + "example": "active", + "type": "string" + }, + "token": { + "description": "Authorization token to authenticate wallet requests", + "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", + "type": "string" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "wallet_id": { + "description": "Wallet record ID", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + } + }, + "required": ["key_management_mode", "wallet_id"], + "type": "object" + }, + "CreateWalletTokenRequest": { + "properties": { + "wallet_key": { + "description": "Master key used for key derivation. Only required for unamanged wallets.", + "example": "MySecretKey123", + "type": "string" + } + }, + "type": "object" + }, + "CreateWalletTokenResponse": { + "properties": { + "token": { + "description": "Authorization token to authenticate wallet requests", + "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", + "type": "string" + } + }, + "type": "object" + }, + "CredAttrSpec": { + "properties": { + "mime-type": { + "description": "MIME type: omit for (null) default", + "example": "image/jpeg", + "type": "string", + "x-nullable": true + }, + "name": { + "description": "Attribute name", + "example": "favourite_drink", + "type": "string" + }, + "value": { + "description": "Attribute value: base64-encode if MIME type is present", + "example": "martini", + "type": "string" + } + }, + "required": ["name", "value"], + "type": "object" + }, + "CredDefValue": { + "properties": { + "primary": { + "allOf": [{ "$ref": "#/definitions/CredDefValuePrimary" }], + "description": "Primary value for credential definition" + }, + "revocation": { + "allOf": [{ "$ref": "#/definitions/CredDefValueRevocation" }], + "description": "Revocation value for credential definition" + } + }, + "type": "object" + }, + "CredDefValuePrimary": { + "properties": { + "n": { "example": "0", "pattern": "^[0-9]*$", "type": "string" }, + "r": { "$ref": "#/definitions/Generated" }, + "rctxt": { "example": "0", "pattern": "^[0-9]*$", "type": "string" }, + "s": { "example": "0", "pattern": "^[0-9]*$", "type": "string" }, + "z": { "example": "0", "pattern": "^[0-9]*$", "type": "string" } + }, + "type": "object" + }, + "CredDefValueRevocation": { + "properties": { + "g": { "example": "1 1F14F&ECB578F 2 095E45DDF417D", "type": "string" }, + "g_dash": { + "example": "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D", + "type": "string" + }, + "h": { + "example": "1 16675DAE54BFAE8 2 095E45DD417D", + "type": "string" + }, + "h0": { + "example": "1 21E5EF9476EAF18 2 095E45DDF417D", + "type": "string" + }, + "h1": { + "example": "1 236D1D99236090 2 095E45DDF417D", + "type": "string" + }, + "h2": { + "example": "1 1C3AE8D1F1E277 2 095E45DDF417D", + "type": "string" + }, + "h_cap": { + "example": "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000", + "type": "string" + }, + "htilde": { + "example": "1 1D8549E8C0F8 2 095E45DDF417D", + "type": "string" + }, + "pk": { + "example": "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D", + "type": "string" + }, + "u": { + "example": "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000", + "type": "string" + }, + "y": { + "example": "1 153558BD903312 2 095E45DDF417D 1 0000000000000000", + "type": "string" + } + }, + "type": "object" + }, + "CredInfoList": { + "properties": { + "results": { + "items": { "$ref": "#/definitions/IndyCredInfo" }, + "type": "array" + } + }, + "type": "object" + }, + "CredRevIndyRecordsResult": { + "properties": { + "rev_reg_delta": { + "description": "Indy revocation registry delta", + "type": "object" + } + }, + "type": "object" + }, + "CredRevRecordDetailsResult": { + "properties": { + "results": { + "items": { "$ref": "#/definitions/IssuerCredRevRecord" }, + "type": "array" + } + }, + "type": "object" + }, + "CredRevRecordResult": { + "properties": { + "result": { "$ref": "#/definitions/IssuerCredRevRecord" } + }, + "type": "object" + }, + "CredRevokedResult": { + "properties": { + "revoked": { + "description": "Whether credential is revoked on the ledger", + "type": "boolean" + } + }, + "type": "object" + }, + "Credential": { + "properties": { + "@context": { + "description": "The JSON-LD context of the credential", + "example": [ + "https://www.w3.org/2018/credentials/v1", + "https://www.w3.org/2018/credentials/examples/v1" + ], + "items": {}, + "type": "array" + }, + "credentialSubject": { + "example": { + "alumniOf": { "id": "did:example:c276e12ec21ebfeb1f712ebc6f1" }, + "id": "did:example:ebfeb1f712ebc6f1c276e12ec21" + } + }, + "expirationDate": { + "description": "The expiration date", + "example": "2010-01-01T19:23:24Z", + "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", + "type": "string" + }, + "id": { + "example": "http://example.edu/credentials/1872", + "pattern": "\\w+:(\\/?\\/?)[^\\s]+", + "type": "string" + }, + "issuanceDate": { + "description": "The issuance date", + "example": "2010-01-01T19:23:24Z", + "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", + "type": "string" + }, + "issuer": { + "description": "The JSON-LD Verifiable Credential Issuer. Either string of object with id field.", + "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH" + }, + "proof": { + "allOf": [{ "$ref": "#/definitions/LinkedDataProof" }], + "description": "The proof of the credential", + "example": { + "created": "2019-12-11T03:50:55", + "jws": "eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ", + "proofPurpose": "assertionMethod", + "type": "Ed25519Signature2018", + "verificationMethod": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL" + } + }, + "type": { + "description": "The JSON-LD type of the credential", + "example": ["VerifiableCredential", "AlumniCredential"], + "items": { "type": "string" }, + "type": "array" + } + }, + "required": [ + "@context", + "credentialSubject", + "issuanceDate", + "issuer", + "type" + ], + "type": "object" + }, + "CredentialDefinition": { + "properties": { + "id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "schemaId": { + "description": "Schema identifier within credential definition identifier", + "example": "20", + "type": "string" + }, + "tag": { + "description": "Tag within credential definition identifier", + "example": "tag", + "type": "string" + }, + "type": { + "default": "CL", + "description": "Signature type: CL for Camenisch-Lysyanskaya", + "example": "CL" + }, + "value": { + "allOf": [{ "$ref": "#/definitions/CredDefValue" }], + "description": "Credential definition primary and revocation values" + }, + "ver": { + "description": "Node protocol version", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + } + }, + "type": "object" + }, + "CredentialDefinitionGetResult": { + "properties": { + "credential_definition": { + "$ref": "#/definitions/CredentialDefinition" + } + }, + "type": "object" + }, + "CredentialDefinitionSendRequest": { + "properties": { + "revocation_registry_size": { + "description": "Revocation registry size", + "example": 1000, + "format": "int32", + "maximum": 32768, + "minimum": 4, + "type": "integer" + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + }, + "support_revocation": { + "description": "Revocation supported flag", + "type": "boolean" + }, + "tag": { + "description": "Credential definition identifier tag", + "example": "default", + "type": "string" + } + }, + "type": "object" + }, + "CredentialDefinitionSendResult": { + "properties": { + "credential_definition_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + } + }, + "type": "object" + }, + "CredentialDefinitionsCreatedResult": { + "properties": { + "credential_definition_ids": { + "items": { + "description": "Credential definition identifiers", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CredentialOffer": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "credential_preview": { "$ref": "#/definitions/CredentialPreview" }, + "offers~attach": { + "items": { "$ref": "#/definitions/AttachDecorator" }, + "type": "array" + } + }, + "required": ["offers~attach"], + "type": "object" + }, + "CredentialPreview": { + "properties": { + "@type": { + "description": "Message type identifier", + "example": "issue-credential/1.0/credential-preview", + "type": "string" + }, + "attributes": { + "items": { "$ref": "#/definitions/CredAttrSpec" }, + "type": "array" + } + }, + "required": ["attributes"], + "type": "object" + }, + "CredentialProposal": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "cred_def_id": { + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "credential_proposal": { "$ref": "#/definitions/CredentialPreview" }, + "issuer_did": { + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "schema_id": { + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + }, + "schema_issuer_did": { + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "schema_name": { "type": "string" }, + "schema_version": { + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + } + }, + "type": "object" + }, + "CredentialStatusOptions": { + "properties": { + "type": { + "description": "Credential status method type to use for the credential. Should match status method registered in the Verifiable Credential Extension Registry", + "example": "CredentialStatusList2017", + "type": "string" + } + }, + "required": ["type"], + "type": "object" + }, + "DID": { + "properties": { + "did": { + "description": "DID of interest", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "type": "string" + }, + "key_type": { + "description": "Key type associated with the DID", + "enum": ["ed25519", "bls12381g2"], + "example": "ed25519", + "type": "string" + }, + "method": { + "description": "Did method associated with the DID", + "example": "sov", + "type": "string" + }, + "posture": { + "description": "Whether DID is current public DID, posted to ledger but not current public DID, or local to the wallet", + "enum": ["public", "posted", "wallet_only"], + "example": "wallet_only", + "type": "string" + }, + "verkey": { + "description": "Public verification key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + } + }, + "type": "object" + }, + "DIDCreate": { + "properties": { + "method": { + "description": "Method for the requested DID.Supported methods are 'key', 'sov', and any other registered method.", + "example": "sov", + "type": "string" + }, + "options": { + "allOf": [{ "$ref": "#/definitions/DIDCreateOptions" }], + "description": "To define a key type and/or a did depending on chosen DID method." + }, + "seed": { + "description": "Optional seed to use for DID, Must beenabled in configuration before use.", + "example": "000000000000000000000000Trustee1", + "type": "string" + } + }, + "type": "object" + }, + "DIDCreateOptions": { + "properties": { + "did": { + "description": "Specify final value of the did (including did:: prefix)if the method supports or requires so.", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "type": "string" + }, + "key_type": { + "description": "Key type to use for the DID keypair. Validated with the chosen DID method's supported key types.", + "enum": ["ed25519", "bls12381g2"], + "example": "ed25519", + "type": "string" + } + }, + "required": ["key_type"], + "type": "object" + }, + "DIDEndpoint": { + "properties": { + "did": { + "description": "DID of interest", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "endpoint": { + "description": "Endpoint to set (omit to delete)", + "example": "https://myhost:8021", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + } + }, + "required": ["did"], + "type": "object" + }, + "DIDEndpointWithType": { + "properties": { + "did": { + "description": "DID of interest", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "endpoint": { + "description": "Endpoint to set (omit to delete)", + "example": "https://myhost:8021", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + }, + "endpoint_type": { + "description": "Endpoint type to set (default 'Endpoint'); affects only public or posted DIDs", + "enum": ["Endpoint", "Profile", "LinkedDomains"], + "example": "Endpoint", + "type": "string" + } + }, + "required": ["did"], + "type": "object" + }, + "DIDList": { + "properties": { + "results": { + "description": "DID list", + "items": { "$ref": "#/definitions/DID" }, + "type": "array" + } + }, + "type": "object" + }, + "DIDResult": { + "properties": { "result": { "$ref": "#/definitions/DID" } }, + "type": "object" + }, + "DIDXRejectRequest": { + "properties": { + "reason": { + "description": "Reason for rejecting the DID Exchange", + "example": "Request rejected", + "type": "string" + } + }, + "type": "object" + }, + "DIDXRequest": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "did": { + "description": "DID of exchange", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "type": "string" + }, + "did_doc~attach": { + "allOf": [{ "$ref": "#/definitions/AttachDecorator" }], + "description": "As signed attachment, DID Doc associated with DID" + }, + "goal": { + "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", + "example": "To issue a Faber College Graduate credential", + "type": "string" + }, + "goal_code": { + "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", + "example": "issue-vc", + "type": "string" + }, + "label": { + "description": "Label for DID exchange request", + "example": "Request to connect with Bob", + "type": "string" + } + }, + "required": ["label"], + "type": "object" + }, + "DIFField": { + "properties": { + "filter": { "$ref": "#/definitions/Filter" }, + "id": { "description": "ID", "type": "string" }, + "path": { + "items": { "description": "Path", "type": "string" }, + "type": "array" + }, + "predicate": { + "description": "Preference", + "enum": ["required", "preferred"], + "type": "string" + }, + "purpose": { "description": "Purpose", "type": "string" } + }, + "type": "object" + }, + "DIFHolder": { + "properties": { + "directive": { + "description": "Preference", + "enum": ["required", "preferred"], + "type": "string" + }, + "field_id": { + "items": { + "description": "FieldID", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DIFOptions": { + "properties": { + "challenge": { + "description": "Challenge protect against replay attack", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type": "string" + }, + "domain": { + "description": "Domain protect against replay attack", + "example": "4jt78h47fh47", + "type": "string" + } + }, + "type": "object" + }, + "DIFPresSpec": { + "properties": { + "issuer_id": { + "description": "Issuer identifier to sign the presentation, if different from current public DID", + "type": "string" + }, + "presentation_definition": { + "$ref": "#/definitions/PresentationDefinition" + }, + "record_ids": { + "description": "Mapping of input_descriptor id to list of stored W3C credential record_id", + "example": { + "": ["", ""], + "": [""] + }, + "type": "object" + }, + "reveal_doc": { + "description": "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", + "example": { + "@context": [ + "https://www.w3.org/2018/credentials/v1", + "https://w3id.org/security/bbs/v1" + ], + "@explicit": true, + "@requireAll": true, + "credentialSubject": { + "@explicit": true, + "@requireAll": true, + "Observation": [ + { + "effectiveDateTime": {}, + "@explicit": true, + "@requireAll": true + } + ] + }, + "issuanceDate": {}, + "issuer": {}, + "type": ["VerifiableCredential", "LabReport"] + }, + "type": "object" + } + }, + "type": "object" + }, + "DIFProofProposal": { + "properties": { + "input_descriptors": { + "items": { "$ref": "#/definitions/InputDescriptors" }, + "type": "array" + }, + "options": { "$ref": "#/definitions/DIFOptions" } + }, + "type": "object" + }, + "DIFProofRequest": { + "properties": { + "options": { "$ref": "#/definitions/DIFOptions" }, + "presentation_definition": { + "$ref": "#/definitions/PresentationDefinition" + } + }, + "required": ["presentation_definition"], + "type": "object" + }, + "Date": { + "properties": { + "expires_time": { + "description": "Expiry Date", + "example": "2021-03-29T05:22:19Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["expires_time"], + "type": "object" + }, + "Disclose": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "protocols": { + "description": "List of protocol descriptors", + "items": { "$ref": "#/definitions/ProtocolDescriptor" }, + "type": "array" + } + }, + "required": ["protocols"], + "type": "object" + }, + "Disclosures": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "disclosures": { + "description": "List of protocol or goal_code descriptors", + "items": {}, + "type": "array" + } + }, + "required": ["disclosures"], + "type": "object" + }, + "Doc": { + "properties": { + "credential": { "description": "Credential to sign", "type": "object" }, + "options": { + "allOf": [{ "$ref": "#/definitions/SignatureOptions" }], + "description": "Signature options" + } + }, + "required": ["credential", "options"], + "type": "object" + }, + "EndorserInfo": { + "properties": { + "endorser_did": { "description": "Endorser DID", "type": "string" }, + "endorser_name": { "description": "Endorser Name", "type": "string" } + }, + "required": ["endorser_did"], + "type": "object" + }, + "EndpointsResult": { + "properties": { + "my_endpoint": { + "description": "My endpoint", + "example": "https://myhost:8021", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + }, + "their_endpoint": { + "description": "Their endpoint", + "example": "https://myhost:8021", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + } + }, + "type": "object" + }, + "Filter": { + "properties": { + "const": { "description": "Const" }, + "enum": { "items": { "description": "Enum" }, "type": "array" }, + "exclusiveMaximum": { "description": "ExclusiveMaximum" }, + "exclusiveMinimum": { "description": "ExclusiveMinimum" }, + "format": { "description": "Format", "type": "string" }, + "maxLength": { + "description": "Max Length", + "example": 1234, + "format": "int32", + "type": "integer" + }, + "maximum": { "description": "Maximum" }, + "minLength": { + "description": "Min Length", + "example": 1234, + "format": "int32", + "type": "integer" + }, + "minimum": { "description": "Minimum" }, + "not": { "description": "Not", "example": false, "type": "boolean" }, + "pattern": { "description": "Pattern", "type": "string" }, + "type": { "description": "Type", "type": "string" } + }, + "type": "object" + }, + "Generated": { + "properties": { + "master_secret": { + "example": "0", + "pattern": "^[0-9]*$", + "type": "string" + }, + "number": { "example": "0", "pattern": "^[0-9]*$", "type": "string" }, + "remainder": { "example": "0", "pattern": "^[0-9]*$", "type": "string" } + }, + "type": "object" + }, + "GetDIDEndpointResponse": { + "properties": { + "endpoint": { + "description": "Full verification key", + "example": "https://myhost:8021", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string", + "x-nullable": true + } + }, + "type": "object" + }, + "GetDIDVerkeyResponse": { + "properties": { + "verkey": { + "description": "Full verification key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string", + "x-nullable": true + } + }, + "type": "object" + }, + "GetNymRoleResponse": { + "properties": { + "role": { + "description": "Ledger role", + "enum": [ + "STEWARD", + "TRUSTEE", + "ENDORSER", + "NETWORK_MONITOR", + "USER", + "ROLE_REMOVE" + ], + "example": "ENDORSER", + "type": "string" + } + }, + "type": "object" + }, + "HolderModuleResponse": { "properties": {}, "type": "object" }, + "IndyAttrValue": { + "properties": { + "encoded": { + "description": "Attribute encoded value", + "example": "-1", + "pattern": "^-?[0-9]*$", + "type": "string" + }, + "raw": { "description": "Attribute raw value", "type": "string" } + }, + "required": ["encoded", "raw"], + "type": "object" + }, + "IndyCredAbstract": { + "properties": { + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "key_correctness_proof": { + "allOf": [{ "$ref": "#/definitions/IndyKeyCorrectnessProof" }], + "description": "Key correctness proof" + }, + "nonce": { + "description": "Nonce in credential abstract", + "example": "0", + "pattern": "^[0-9]*$", + "type": "string" + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + } + }, + "required": [ + "cred_def_id", + "key_correctness_proof", + "nonce", + "schema_id" + ], + "type": "object" + }, + "IndyCredInfo": { + "properties": { + "attrs": { + "additionalProperties": { "example": "alice", "type": "string" }, + "description": "Attribute names and value", + "type": "object" + }, + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "cred_rev_id": { + "description": "Credential revocation identifier", + "example": "12345", + "pattern": "^[1-9][0-9]*$", + "type": "string", + "x-nullable": true + }, + "referent": { + "description": "Wallet referent", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "rev_reg_id": { + "description": "Revocation registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string", + "x-nullable": true + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + } + }, + "type": "object" + }, + "IndyCredPrecis": { + "properties": { + "cred_info": { + "allOf": [{ "$ref": "#/definitions/IndyCredInfo" }], + "description": "Credential info" + }, + "interval": { + "allOf": [{ "$ref": "#/definitions/IndyNonRevocationInterval" }], + "description": "Non-revocation interval from presentation request" + }, + "presentation_referents": { + "items": { + "description": "presentation referent", + "example": "1_age_uuid", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "IndyCredRequest": { + "properties": { + "blinded_ms": { + "description": "Blinded master secret", + "type": "object" + }, + "blinded_ms_correctness_proof": { + "description": "Blinded master secret correctness proof", + "type": "object" + }, + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "nonce": { + "description": "Nonce in credential request", + "example": "0", + "pattern": "^[0-9]*$", + "type": "string" + }, + "prover_did": { + "description": "Prover DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + } + }, + "required": [ + "blinded_ms", + "blinded_ms_correctness_proof", + "cred_def_id", + "nonce", + "prover_did" + ], + "type": "object" + }, + "IndyCredential": { + "properties": { + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "rev_reg": { + "description": "Revocation registry state", + "type": "object", + "x-nullable": true + }, + "rev_reg_id": { + "description": "Revocation registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string", + "x-nullable": true + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + }, + "signature": { + "description": "Credential signature", + "type": "object" + }, + "signature_correctness_proof": { + "description": "Credential signature correctness proof", + "type": "object" + }, + "values": { + "additionalProperties": { + "allOf": [{ "$ref": "#/definitions/IndyAttrValue" }], + "description": "Attribute value" + }, + "description": "Credential attributes", + "type": "object" + }, + "witness": { + "description": "Witness for revocation proof", + "type": "object", + "x-nullable": true + } + }, + "required": [ + "cred_def_id", + "schema_id", + "signature", + "signature_correctness_proof", + "values" + ], + "type": "object" + }, + "IndyEQProof": { + "properties": { + "a_prime": { "example": "0", "pattern": "^[0-9]*$", "type": "string" }, + "e": { "example": "0", "pattern": "^[0-9]*$", "type": "string" }, + "m": { + "additionalProperties": { + "example": "0", + "pattern": "^[0-9]*$", + "type": "string" + }, + "type": "object" + }, + "m2": { "example": "0", "pattern": "^[0-9]*$", "type": "string" }, + "revealed_attrs": { + "additionalProperties": { + "example": "-1", + "pattern": "^-?[0-9]*$", + "type": "string" + }, + "type": "object" + }, + "v": { "example": "0", "pattern": "^[0-9]*$", "type": "string" } + }, + "type": "object" + }, + "IndyGEProof": { + "properties": { + "alpha": { "example": "0", "pattern": "^[0-9]*$", "type": "string" }, + "mj": { "example": "0", "pattern": "^[0-9]*$", "type": "string" }, + "predicate": { "$ref": "#/definitions/IndyGEProofPred" }, + "r": { + "additionalProperties": { + "example": "0", + "pattern": "^[0-9]*$", + "type": "string" + }, + "type": "object" + }, + "t": { + "additionalProperties": { + "example": "0", + "pattern": "^[0-9]*$", + "type": "string" + }, + "type": "object" + }, + "u": { + "additionalProperties": { + "example": "0", + "pattern": "^[0-9]*$", + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "IndyGEProofPred": { + "properties": { + "attr_name": { + "description": "Attribute name, indy-canonicalized", + "type": "string" + }, + "p_type": { + "description": "Predicate type", + "enum": ["LT", "LE", "GE", "GT"], + "type": "string" + }, + "value": { + "description": "Predicate threshold value", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "IndyKeyCorrectnessProof": { + "properties": { + "c": { + "description": "c in key correctness proof", + "example": "0", + "pattern": "^[0-9]*$", + "type": "string" + }, + "xr_cap": { + "description": "xr_cap in key correctness proof", + "items": { + "description": "xr_cap components in key correctness proof", + "items": { + "description": "xr_cap component values in key correctness proof", + "type": "string" + }, + "type": "array" + }, + "type": "array" + }, + "xz_cap": { + "description": "xz_cap in key correctness proof", + "example": "0", + "pattern": "^[0-9]*$", + "type": "string" + } + }, + "required": ["c", "xr_cap", "xz_cap"], + "type": "object" + }, + "IndyNonRevocProof": { + "properties": { + "c_list": { + "additionalProperties": { "type": "string" }, + "type": "object" + }, + "x_list": { + "additionalProperties": { "type": "string" }, + "type": "object" + } + }, + "type": "object" + }, + "IndyNonRevocationInterval": { + "properties": { + "from": { + "description": "Earliest time of interest in non-revocation interval", + "example": 1640995199, + "format": "int32", + "maximum": 18446744073709551615, + "minimum": 0, + "type": "integer" + }, + "to": { + "description": "Latest time of interest in non-revocation interval", + "example": 1640995199, + "format": "int32", + "maximum": 18446744073709551615, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "IndyPresAttrSpec": { + "properties": { + "cred_def_id": { + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "mime-type": { + "description": "MIME type (default null)", + "example": "image/jpeg", + "type": "string" + }, + "name": { + "description": "Attribute name", + "example": "favourite_drink", + "type": "string" + }, + "referent": { + "description": "Credential referent", + "example": "0", + "type": "string" + }, + "value": { + "description": "Attribute value", + "example": "martini", + "type": "string" + } + }, + "required": ["name"], + "type": "object" + }, + "IndyPresPredSpec": { + "properties": { + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "name": { + "description": "Attribute name", + "example": "high_score", + "type": "string" + }, + "predicate": { + "description": "Predicate type ('<', '<=', '>=', or '>')", + "enum": ["<", "<=", ">=", ">"], + "example": ">=", + "type": "string" + }, + "threshold": { + "description": "Threshold value", + "format": "int32", + "type": "integer" + } + }, + "required": ["name", "predicate", "threshold"], + "type": "object" + }, + "IndyPresPreview": { + "properties": { + "@type": { + "description": "Message type identifier", + "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/present-proof/1.0/presentation-preview", + "type": "string" + }, + "attributes": { + "items": { "$ref": "#/definitions/IndyPresAttrSpec" }, + "type": "array" + }, + "predicates": { + "items": { "$ref": "#/definitions/IndyPresPredSpec" }, + "type": "array" + } + }, + "required": ["attributes", "predicates"], + "type": "object" + }, + "IndyPresSpec": { + "properties": { + "requested_attributes": { + "additionalProperties": { + "$ref": "#/definitions/IndyRequestedCredsRequestedAttr" + }, + "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers", + "type": "object" + }, + "requested_predicates": { + "additionalProperties": { + "$ref": "#/definitions/IndyRequestedCredsRequestedPred" + }, + "description": "Nested object mapping proof request predicate referents to requested-predicate specifiers", + "type": "object" + }, + "self_attested_attributes": { + "additionalProperties": { + "description": "Self-attested attribute values to use in requested-credentials structure for proof construction", + "example": "self_attested_value", + "type": "string" + }, + "description": "Self-attested attributes to build into proof", + "type": "object" + }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } + }, + "required": [ + "requested_attributes", + "requested_predicates", + "self_attested_attributes" + ], + "type": "object" + }, + "IndyPrimaryProof": { + "properties": { + "eq_proof": { + "allOf": [{ "$ref": "#/definitions/IndyEQProof" }], + "description": "Indy equality proof", + "x-nullable": true + }, + "ge_proofs": { + "description": "Indy GE proofs", + "items": { "$ref": "#/definitions/IndyGEProof" }, + "type": "array", + "x-nullable": true + } + }, + "type": "object" + }, + "IndyProof": { + "properties": { + "identifiers": { + "description": "Indy proof.identifiers content", + "items": { "$ref": "#/definitions/IndyProofIdentifier" }, + "type": "array" + }, + "proof": { + "allOf": [{ "$ref": "#/definitions/IndyProofProof" }], + "description": "Indy proof.proof content" + }, + "requested_proof": { + "allOf": [{ "$ref": "#/definitions/IndyProofRequestedProof" }], + "description": "Indy proof.requested_proof content" + } + }, + "type": "object" + }, + "IndyProofIdentifier": { + "properties": { + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "rev_reg_id": { + "description": "Revocation registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string", + "x-nullable": true + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + }, + "timestamp": { + "description": "Timestamp epoch", + "example": 1640995199, + "format": "int32", + "maximum": 18446744073709551615, + "minimum": 0, + "type": "integer", + "x-nullable": true + } + }, + "type": "object" + }, + "IndyProofProof": { + "properties": { + "aggregated_proof": { + "allOf": [{ "$ref": "#/definitions/IndyProofProofAggregatedProof" }], + "description": "Indy proof aggregated proof" + }, + "proofs": { + "description": "Indy proof proofs", + "items": { "$ref": "#/definitions/IndyProofProofProofsProof" }, + "type": "array" + } + }, + "type": "object" + }, + "IndyProofProofAggregatedProof": { + "properties": { + "c_hash": { "description": "c_hash value", "type": "string" }, + "c_list": { + "description": "c_list value", + "items": { + "items": { "format": "int32", "type": "integer" }, + "type": "array" + }, + "type": "array" + } + }, + "type": "object" + }, + "IndyProofProofProofsProof": { + "properties": { + "non_revoc_proof": { + "allOf": [{ "$ref": "#/definitions/IndyNonRevocProof" }], + "description": "Indy non-revocation proof", + "x-nullable": true + }, + "primary_proof": { + "allOf": [{ "$ref": "#/definitions/IndyPrimaryProof" }], + "description": "Indy primary proof" + } + }, + "type": "object" + }, + "IndyProofReqAttrSpec": { + "properties": { + "name": { + "description": "Attribute name", + "example": "favouriteDrink", + "type": "string" + }, + "names": { + "description": "Attribute name group", + "items": { "example": "age", "type": "string" }, + "type": "array" + }, + "non_revoked": { + "allOf": [{ "$ref": "#/definitions/IndyProofReqAttrSpecNonRevoked" }], + "x-nullable": true + }, + "restrictions": { + "description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", + "items": { + "additionalProperties": { + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "type": "string" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "IndyProofReqAttrSpecNonRevoked": { + "properties": { + "from": { + "description": "Earliest time of interest in non-revocation interval", + "example": 1640995199, + "format": "int32", + "maximum": 18446744073709551615, + "minimum": 0, + "type": "integer" + }, + "to": { + "description": "Latest time of interest in non-revocation interval", + "example": 1640995199, + "format": "int32", + "maximum": 18446744073709551615, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "IndyProofReqPredSpec": { + "properties": { + "name": { + "description": "Attribute name", + "example": "index", + "type": "string" + }, + "non_revoked": { + "allOf": [{ "$ref": "#/definitions/IndyProofReqPredSpecNonRevoked" }], + "x-nullable": true + }, + "p_type": { + "description": "Predicate type ('<', '<=', '>=', or '>')", + "enum": ["<", "<=", ">=", ">"], + "example": ">=", + "type": "string" + }, + "p_value": { + "description": "Threshold value", + "format": "int32", + "type": "integer" + }, + "restrictions": { + "description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", + "items": { + "additionalProperties": { + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "type": "string" + }, + "type": "object" + }, + "type": "array" + } + }, + "required": ["name", "p_type", "p_value"], + "type": "object" + }, + "IndyProofReqPredSpecNonRevoked": { + "properties": { + "from": { + "description": "Earliest time of interest in non-revocation interval", + "example": 1640995199, + "format": "int32", + "maximum": 18446744073709551615, + "minimum": 0, + "type": "integer" + }, + "to": { + "description": "Latest time of interest in non-revocation interval", + "example": 1640995199, + "format": "int32", + "maximum": 18446744073709551615, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "IndyProofRequest": { + "properties": { + "name": { + "description": "Proof request name", + "example": "Proof request", + "type": "string" + }, + "non_revoked": { + "allOf": [{ "$ref": "#/definitions/IndyProofRequestNonRevoked" }], + "x-nullable": true + }, + "nonce": { + "description": "Nonce", + "example": "1", + "pattern": "^[1-9][0-9]*$", + "type": "string" + }, + "requested_attributes": { + "additionalProperties": { + "$ref": "#/definitions/IndyProofReqAttrSpec" + }, + "description": "Requested attribute specifications of proof request", + "type": "object" + }, + "requested_predicates": { + "additionalProperties": { + "$ref": "#/definitions/IndyProofReqPredSpec" + }, + "description": "Requested predicate specifications of proof request", + "type": "object" + }, + "version": { + "description": "Proof request version", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + } + }, + "required": ["requested_attributes", "requested_predicates"], + "type": "object" + }, + "IndyProofRequestNonRevoked": { + "properties": { + "from": { + "description": "Earliest time of interest in non-revocation interval", + "example": 1640995199, + "format": "int32", + "maximum": 18446744073709551615, + "minimum": 0, + "type": "integer" + }, + "to": { + "description": "Latest time of interest in non-revocation interval", + "example": 1640995199, + "format": "int32", + "maximum": 18446744073709551615, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "IndyProofRequestedProof": { + "properties": { + "predicates": { + "additionalProperties": { + "$ref": "#/definitions/IndyProofRequestedProofPredicate" + }, + "description": "Proof requested proof predicates.", + "type": "object" + }, + "revealed_attr_groups": { + "additionalProperties": { + "$ref": "#/definitions/IndyProofRequestedProofRevealedAttrGroup" + }, + "description": "Proof requested proof revealed attribute groups", + "type": "object", + "x-nullable": true + }, + "revealed_attrs": { + "additionalProperties": { + "$ref": "#/definitions/IndyProofRequestedProofRevealedAttr" + }, + "description": "Proof requested proof revealed attributes", + "type": "object", + "x-nullable": true + }, + "self_attested_attrs": { + "description": "Proof requested proof self-attested attributes", + "type": "object" + }, + "unrevealed_attrs": { + "description": "Unrevealed attributes", + "type": "object" + } + }, + "type": "object" + }, + "IndyProofRequestedProofPredicate": { + "properties": { + "sub_proof_index": { + "description": "Sub-proof index", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "IndyProofRequestedProofRevealedAttr": { + "properties": { + "encoded": { + "description": "Encoded value", + "example": "-1", + "pattern": "^-?[0-9]*$", + "type": "string" + }, + "raw": { "description": "Raw value", "type": "string" }, + "sub_proof_index": { + "description": "Sub-proof index", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "IndyProofRequestedProofRevealedAttrGroup": { + "properties": { + "sub_proof_index": { + "description": "Sub-proof index", + "format": "int32", + "type": "integer" + }, + "values": { + "additionalProperties": { "$ref": "#/definitions/RawEncoded" }, + "description": "Indy proof requested proof revealed attr groups group value", + "type": "object" + } + }, + "type": "object" + }, + "IndyRequestedCredsRequestedAttr": { + "properties": { + "cred_id": { + "description": "Wallet credential identifier (typically but not necessarily a UUID)", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "revealed": { + "description": "Whether to reveal attribute in proof (default true)", + "type": "boolean" + } + }, + "required": ["cred_id"], + "type": "object" + }, + "IndyRequestedCredsRequestedPred": { + "properties": { + "cred_id": { + "description": "Wallet credential identifier (typically but not necessarily a UUID)", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "timestamp": { + "description": "Epoch timestamp of interest for non-revocation proof", + "example": 1640995199, + "format": "int32", + "maximum": 18446744073709551615, + "minimum": 0, + "type": "integer" + } + }, + "required": ["cred_id"], + "type": "object" + }, + "IndyRevRegDef": { + "properties": { + "credDefId": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "id": { + "description": "Indy revocation registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + }, + "revocDefType": { + "description": "Revocation registry type (specify CL_ACCUM)", + "enum": ["CL_ACCUM"], + "example": "CL_ACCUM", + "type": "string" + }, + "tag": { "description": "Revocation registry tag", "type": "string" }, + "value": { + "allOf": [{ "$ref": "#/definitions/IndyRevRegDefValue" }], + "description": "Revocation registry definition value" + }, + "ver": { + "description": "Version of revocation registry definition", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + } + }, + "type": "object" + }, + "IndyRevRegDefValue": { + "properties": { + "issuanceType": { + "description": "Issuance type", + "enum": ["ISSUANCE_ON_DEMAND", "ISSUANCE_BY_DEFAULT"], + "type": "string" + }, + "maxCredNum": { + "description": "Maximum number of credentials; registry size", + "example": 10, + "format": "int32", + "minimum": 1, + "type": "integer" + }, + "publicKeys": { + "allOf": [{ "$ref": "#/definitions/IndyRevRegDefValuePublicKeys" }], + "description": "Public keys" + }, + "tailsHash": { + "description": "Tails hash value", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "tailsLocation": { + "description": "Tails file location", + "type": "string" + } + }, + "type": "object" + }, + "IndyRevRegDefValuePublicKeys": { + "properties": { + "accumKey": { + "$ref": "#/definitions/IndyRevRegDefValuePublicKeysAccumKey" + } + }, + "type": "object" + }, + "IndyRevRegDefValuePublicKeysAccumKey": { + "properties": { + "z": { + "description": "Value for z", + "example": "1 120F522F81E6B7 1 09F7A59005C4939854", + "type": "string" + } + }, + "type": "object" + }, + "IndyRevRegEntry": { + "properties": { + "value": { + "allOf": [{ "$ref": "#/definitions/IndyRevRegEntryValue" }], + "description": "Revocation registry entry value" + }, + "ver": { + "description": "Version of revocation registry entry", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + } + }, + "type": "object" + }, + "IndyRevRegEntryValue": { + "properties": { + "accum": { + "description": "Accumulator value", + "example": "21 11792B036AED0AAA12A4 4 298B2571FFC63A737", + "type": "string" + }, + "prevAccum": { + "description": "Previous accumulator value", + "example": "21 137AC810975E4 6 76F0384B6F23", + "type": "string" + }, + "revoked": { + "description": "Revoked credential revocation identifiers", + "items": { "format": "int32", "type": "integer" }, + "type": "array" + } + }, + "type": "object" + }, + "InputDescriptors": { + "properties": { + "constraints": { "$ref": "#/definitions/Constraints" }, + "group": { + "items": { "description": "Group", "type": "string" }, + "type": "array" + }, + "id": { "description": "ID", "type": "string" }, + "metadata": { "description": "Metadata dictionary", "type": "object" }, + "name": { "description": "Name", "type": "string" }, + "purpose": { "description": "Purpose", "type": "string" }, + "schema": { + "allOf": [{ "$ref": "#/definitions/SchemasInputDescriptorFilter" }], + "description": "Accepts a list of schema or a dict containing filters like oneof_filter.", + "example": { + "oneof_filter": [ + [ + { "uri": "https://www.w3.org/Test1#Test1" }, + { "uri": "https://www.w3.org/Test2#Test2" } + ], + { + "oneof_filter": [ + [{ "uri": "https://www.w3.org/Test1#Test1" }], + [{ "uri": "https://www.w3.org/Test2#Test2" }] + ] + } + ] + } + } + }, + "type": "object" + }, + "IntroModuleResponse": { "properties": {}, "type": "object" }, + "InvitationCreateRequest": { + "properties": { + "accept": { + "description": "List of mime type in order of preference that should be use in responding to the message", + "example": ["didcomm/aip1", "didcomm/aip2;env=rfc19"], + "items": { "type": "string" }, + "type": "array" + }, + "alias": { + "description": "Alias for connection", + "example": "Barry", + "type": "string" + }, + "attachments": { + "description": "Optional invitation attachments", + "items": { "$ref": "#/definitions/AttachmentDef" }, + "type": "array" + }, + "goal": { + "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", + "example": "To issue a Faber College Graduate credential", + "type": "string" + }, + "goal_code": { + "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", + "example": "issue-vc", + "type": "string" + }, + "handshake_protocols": { + "items": { + "description": "Handshake protocol to specify in invitation", + "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0", + "type": "string" + }, + "type": "array" + }, + "mediation_id": { + "description": "Identifier for active mediation record to be used", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type": "string" + }, + "metadata": { + "description": "Optional metadata to attach to the connection created with the invitation", + "type": "object" + }, + "my_label": { + "description": "Label for connection invitation", + "example": "Invitation to Barry", + "type": "string" + }, + "protocol_version": { + "description": "OOB protocol version", + "example": "1.1", + "type": "string" + }, + "use_public_did": { + "description": "Whether to use public DID in invitation", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "InvitationMessage": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "type": "string" + }, + "accept": { + "description": "List of mime type in order of preference", + "example": ["didcomm/aip1", "didcomm/aip2;env=rfc19"], + "items": { "type": "string" }, + "type": "array" + }, + "goal": { + "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", + "example": "To issue a Faber College Graduate credential", + "type": "string" + }, + "goal_code": { + "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", + "example": "issue-vc", + "type": "string" + }, + "handshake_protocols": { + "items": { + "description": "Handshake protocol", + "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0", + "type": "string" + }, + "type": "array" + }, + "imageUrl": { + "description": "Optional image URL for out-of-band invitation", + "example": "http://192.168.56.101/img/logo.jpg", + "format": "url", + "type": "string", + "x-nullable": true + }, + "label": { + "description": "Optional label", + "example": "Bob", + "type": "string" + }, + "requests~attach": { + "description": "Optional request attachment", + "items": { "$ref": "#/definitions/AttachDecorator" }, + "type": "array" + }, + "services": { + "example": [ + { + "did": "WgWxqztrNooG92RXvxSTWv", + "id": "string", + "recipientKeys": [ + "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH" + ], + "routingKeys": [ + "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH" + ], + "serviceEndpoint": "http://192.168.56.101:8020", + "type": "string" + }, + "did:sov:WgWxqztrNooG92RXvxSTWv" + ], + "items": { + "description": "Either a DIDComm service object (as per RFC0067) or a DID string." + }, + "type": "array" + } + }, + "type": "object" + }, + "InvitationRecord": { + "properties": { + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "invi_msg_id": { + "description": "Invitation message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "invitation": { + "allOf": [{ "$ref": "#/definitions/InvitationMessage" }], + "description": "Out of band invitation message" + }, + "invitation_id": { + "description": "Invitation record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "invitation_url": { + "description": "Invitation message URL", + "example": "https://example.com/endpoint?c_i=eyJAdHlwZSI6ICIuLi4iLCAiLi4uIjogIi4uLiJ9XX0=", + "type": "string" + }, + "oob_id": { + "description": "Out of band record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "state": { + "description": "Out of band message exchange state", + "example": "await_response", + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "type": "object" + }, + "InvitationResult": { + "properties": { + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "invitation": { "$ref": "#/definitions/ConnectionInvitation" }, + "invitation_url": { + "description": "Invitation URL", + "example": "http://192.168.56.101:8020/invite?c_i=eyJAdHlwZSI6Li4ufQ==", + "type": "string" + } + }, + "type": "object" + }, + "IssueCredentialModuleResponse": { "properties": {}, "type": "object" }, + "IssuerCredRevRecord": { + "properties": { + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "cred_ex_id": { + "description": "Credential exchange record identifier at credential issue", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "cred_ex_version": { + "description": "Credential exchange version", + "type": "string" + }, + "cred_rev_id": { + "description": "Credential revocation identifier", + "example": "12345", + "pattern": "^[1-9][0-9]*$", + "type": "string" + }, + "record_id": { + "description": "Issuer credential revocation record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "rev_reg_id": { + "description": "Revocation registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + }, + "state": { + "description": "Issue credential revocation record state", + "example": "issued", + "type": "string" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "type": "object" + }, + "IssuerRevRegRecord": { + "properties": { + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "error_msg": { + "description": "Error message", + "example": "Revocation registry undefined", + "type": "string" + }, + "issuer_did": { + "description": "Issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "max_cred_num": { + "description": "Maximum number of credentials for revocation registry", + "example": 1000, + "format": "int32", + "type": "integer" + }, + "pending_pub": { + "description": "Credential revocation identifier for credential revoked and pending publication to ledger", + "items": { "example": "23", "type": "string" }, + "type": "array" + }, + "record_id": { + "description": "Issuer revocation registry record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "revoc_def_type": { + "description": "Revocation registry type (specify CL_ACCUM)", + "enum": ["CL_ACCUM"], + "example": "CL_ACCUM", + "type": "string" + }, + "revoc_reg_def": { + "allOf": [{ "$ref": "#/definitions/IndyRevRegDef" }], + "description": "Revocation registry definition" + }, + "revoc_reg_entry": { + "allOf": [{ "$ref": "#/definitions/IndyRevRegEntry" }], + "description": "Revocation registry entry" + }, + "revoc_reg_id": { + "description": "Revocation registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + }, + "state": { + "description": "Issue revocation registry record state", + "example": "active", + "type": "string" + }, + "tag": { + "description": "Tag within issuer revocation registry identifier", + "type": "string" + }, + "tails_hash": { + "description": "Tails hash", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "tails_local_path": { + "description": "Local path to tails file", + "type": "string" + }, + "tails_public_uri": { + "description": "Public URI for tails file", + "type": "string" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "type": "object" + }, + "JWSCreate": { + "properties": { + "did": { + "description": "DID of interest", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "type": "string" + }, + "headers": { "type": "object" }, + "payload": { "type": "object" }, + "verificationMethod": { + "description": "Information used for proof verification", + "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", + "pattern": "\\w+:(\\/?\\/?)[^\\s]+", + "type": "string" + } + }, + "required": ["payload"], + "type": "object" + }, + "JWSVerify": { + "properties": { + "jwt": { + "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", + "pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+$", + "type": "string" + } + }, + "type": "object" + }, + "JWSVerifyResponse": { + "properties": { + "error": { "description": "Error text", "type": "string" }, + "headers": { + "description": "Headers from verified JWT.", + "type": "object" + }, + "kid": { "description": "kid of signer", "type": "string" }, + "payload": { + "description": "Payload from verified JWT", + "type": "object" + }, + "valid": { "type": "boolean" } + }, + "required": ["headers", "kid", "payload", "valid"], + "type": "object" + }, + "Keylist": { + "properties": { + "results": { + "description": "List of keylist records", + "items": { "$ref": "#/definitions/RouteRecord" }, + "type": "array" + } + }, + "type": "object" + }, + "KeylistQuery": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "filter": { + "description": "Query dictionary object", + "example": { "filter": {} }, + "type": "object" + }, + "paginate": { + "allOf": [{ "$ref": "#/definitions/KeylistQueryPaginate" }], + "description": "Pagination info" + } + }, + "type": "object" + }, + "KeylistQueryFilterRequest": { + "properties": { + "filter": { + "description": "Filter for keylist query", + "type": "object" + } + }, + "type": "object" + }, + "KeylistQueryPaginate": { + "properties": { + "limit": { + "description": "Limit for keylist query", + "example": 30, + "format": "int32", + "type": "integer" + }, + "offset": { + "description": "Offset value for query", + "example": 0, + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "KeylistUpdate": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "updates": { + "description": "List of update rules", + "items": { "$ref": "#/definitions/KeylistUpdateRule" }, + "type": "array" + } + }, + "type": "object" + }, + "KeylistUpdateRequest": { + "properties": { + "updates": { + "items": { "$ref": "#/definitions/KeylistUpdateRule" }, + "type": "array" + } + }, + "type": "object" + }, + "KeylistUpdateRule": { + "properties": { + "action": { + "description": "Action for specific key", + "enum": ["add", "remove"], + "example": "add", + "type": "string" + }, + "recipient_key": { + "description": "Key to remove or add", + "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", + "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$|^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + } + }, + "required": ["action", "recipient_key"], + "type": "object" + }, + "LDProofVCDetail": { + "properties": { + "credential": { + "allOf": [{ "$ref": "#/definitions/Credential" }], + "description": "Detail of the JSON-LD Credential to be issued", + "example": { + "@context": [ + "https://www.w3.org/2018/credentials/v1", + "https://w3id.org/citizenship/v1" + ], + "credentialSubject": { + "familyName": "SMITH", + "gender": "Male", + "givenName": "JOHN", + "type": ["PermanentResident", "Person"] + }, + "description": "Government of Example Permanent Resident Card.", + "identifier": "83627465", + "issuanceDate": "2019-12-03T12:19:52Z", + "issuer": "did:key:z6MkmjY8GnV5i9YTDtPETC2uUAW6ejw3nk5mXF5yci5ab7th", + "name": "Permanent Resident Card", + "type": ["VerifiableCredential", "PermanentResidentCard"] + } + }, + "options": { + "allOf": [{ "$ref": "#/definitions/LDProofVCDetailOptions" }], + "description": "Options for specifying how the linked data proof is created.", + "example": { "proofType": "Ed25519Signature2018" } + } + }, + "required": ["credential", "options"], + "type": "object" + }, + "LDProofVCDetailOptions": { + "properties": { + "challenge": { + "description": "A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder)", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "created": { + "description": "The date and time of the proof (with a maximum accuracy in seconds). Defaults to current system time", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "credentialStatus": { + "allOf": [{ "$ref": "#/definitions/CredentialStatusOptions" }], + "description": "The credential status mechanism to use for the credential. Omitting the property indicates the issued credential will not include a credential status" + }, + "domain": { + "description": "The intended domain of validity for the proof", + "example": "example.com", + "type": "string" + }, + "proofPurpose": { + "description": "The proof purpose used for the proof. Should match proof purposes registered in the Linked Data Proofs Specification", + "example": "assertionMethod", + "type": "string" + }, + "proofType": { + "description": "The proof type used for the proof. Should match suites registered in the Linked Data Cryptographic Suite Registry", + "example": "Ed25519Signature2018", + "type": "string" + } + }, + "required": ["proofType"], + "type": "object" + }, + "LedgerConfigInstance": { + "properties": { + "genesis_file": { "description": "genesis_file", "type": "string" }, + "genesis_transactions": { + "description": "genesis_transactions", + "type": "string" + }, + "genesis_url": { "description": "genesis_url", "type": "string" }, + "id": { "description": "ledger_id", "type": "string" }, + "is_production": { "description": "is_production", "type": "boolean" } + }, + "type": "object" + }, + "LedgerConfigList": { + "properties": { + "ledger_config_list": { + "items": { "$ref": "#/definitions/LedgerConfigInstance" }, + "type": "array" + } + }, + "required": ["ledger_config_list"], + "type": "object" + }, + "LedgerModulesResult": { "properties": {}, "type": "object" }, + "LinkedDataProof": { + "properties": { + "challenge": { + "description": "Associates a challenge with a proof, for use with a proofPurpose such as authentication", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "created": { + "description": "The string value of an ISO8601 combined date and time string generated by the Signature Algorithm", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "domain": { + "description": "A string value specifying the restricted domain of the signature.", + "example": "example.com", + "pattern": "\\w+:(\\/?\\/?)[^\\s]+", + "type": "string" + }, + "jws": { + "description": "Associates a Detached Json Web Signature with a proof", + "example": "eyJhbGciOiAiRWREUc2UsICJjcml0IjogWyJiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQ1Ch6YBKY7UBAjg6iBX5qBQ", + "type": "string" + }, + "nonce": { + "description": "The nonce", + "example": "CF69iO3nfvqRsRBNElE8b4wO39SyJHPM7Gg1nExltW5vSfQA1lvDCR/zXX1To0/4NLo==", + "type": "string" + }, + "proofPurpose": { + "description": "Proof purpose", + "example": "assertionMethod", + "type": "string" + }, + "proofValue": { + "description": "The proof value of a proof", + "example": "sy1AahqbzJQ63n9RtekmwzqZeVj494VppdAVJBnMYrTwft6cLJJGeTSSxCCJ6HKnRtwE7jjDh6sB2z2AAiZY9BBnCD8wUVgwqH3qchGRCuC2RugA4eQ9fUrR4Yuycac3caiaaay", + "type": "string" + }, + "type": { + "description": "Identifies the digital signature suite that was used to create the signature", + "example": "Ed25519Signature2018", + "type": "string" + }, + "verificationMethod": { + "description": "Information used for proof verification", + "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", + "pattern": "\\w+:(\\/?\\/?)[^\\s]+", + "type": "string" + } + }, + "required": ["created", "proofPurpose", "type", "verificationMethod"], + "type": "object" + }, + "MediationCreateRequest": { "properties": {}, "type": "object" }, + "MediationDeny": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MediationGrant": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "endpoint": { + "description": "endpoint on which messages destined for the recipient are received.", + "example": "http://192.168.56.102:8020/", + "type": "string" + }, + "routing_keys": { + "items": { + "description": "Keys to use for forward message packaging", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "MediationIdMatchInfo": { + "properties": { + "mediation_id": { + "description": "Mediation record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + } + }, + "type": "object" + }, + "MediationList": { + "properties": { + "results": { + "description": "List of mediation records", + "items": { "$ref": "#/definitions/MediationRecord" }, + "type": "array" + } + }, + "type": "object" + }, + "MediationRecord": { + "properties": { + "connection_id": { "type": "string" }, + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "endpoint": { "type": "string" }, + "mediation_id": { "type": "string" }, + "mediator_terms": { "items": { "type": "string" }, "type": "array" }, + "recipient_terms": { "items": { "type": "string" }, "type": "array" }, + "role": { "type": "string" }, + "routing_keys": { + "items": { + "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", + "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$", + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "Current record state", + "example": "active", + "type": "string" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "required": ["connection_id", "role"], + "type": "object" + }, + "Menu": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Introductory text for the menu", + "example": "This menu presents options", + "type": "string" + }, + "errormsg": { + "description": "An optional error message to display in menu header", + "example": "Error: item not found", + "type": "string" + }, + "options": { + "description": "List of menu options", + "items": { "$ref": "#/definitions/MenuOption" }, + "type": "array" + }, + "title": { + "description": "Menu title", + "example": "My Menu", + "type": "string" + } + }, + "required": ["options"], + "type": "object" + }, + "MenuForm": { + "properties": { + "description": { + "description": "Additional descriptive text for menu form", + "example": "Window preference settings", + "type": "string" + }, + "params": { + "description": "List of form parameters", + "items": { "$ref": "#/definitions/MenuFormParam" }, + "type": "array" + }, + "submit-label": { + "description": "Alternative label for form submit button", + "example": "Send", + "type": "string" + }, + "title": { + "description": "Menu form title", + "example": "Preferences", + "type": "string" + } + }, + "type": "object" + }, + "MenuFormParam": { + "properties": { + "default": { + "description": "Default parameter value", + "example": "0", + "type": "string" + }, + "description": { + "description": "Additional descriptive text for menu form parameter", + "example": "Delay in seconds before starting", + "type": "string" + }, + "name": { + "description": "Menu parameter name", + "example": "delay", + "type": "string" + }, + "required": { + "description": "Whether parameter is required", + "example": "False", + "type": "boolean" + }, + "title": { + "description": "Menu parameter title", + "example": "Delay in seconds", + "type": "string" + }, + "type": { + "description": "Menu form parameter input type", + "example": "int", + "type": "string" + } + }, + "required": ["name", "title"], + "type": "object" + }, + "MenuJson": { + "properties": { + "description": { + "description": "Introductory text for the menu", + "example": "User preferences for window settings", + "type": "string" + }, + "errormsg": { + "description": "Optional error message to display in menu header", + "example": "Error: item not present", + "type": "string" + }, + "options": { + "description": "List of menu options", + "items": { "$ref": "#/definitions/MenuOption" }, + "type": "array" + }, + "title": { + "description": "Menu title", + "example": "My Menu", + "type": "string" + } + }, + "required": ["options"], + "type": "object" + }, + "MenuOption": { + "properties": { + "description": { + "description": "Additional descriptive text for menu option", + "example": "Window display preferences", + "type": "string" + }, + "disabled": { + "description": "Whether to show option as disabled", + "example": "False", + "type": "boolean" + }, + "form": { "$ref": "#/definitions/MenuForm" }, + "name": { + "description": "Menu option name (unique identifier)", + "example": "window_prefs", + "type": "string" + }, + "title": { + "description": "Menu option title", + "example": "Window Preferences", + "type": "string" + } + }, + "required": ["name", "title"], + "type": "object" + }, + "MultitenantModuleResponse": { "properties": {}, "type": "object" }, + "OobRecord": { + "properties": { + "attach_thread_id": { + "description": "Connection record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "connection_id": { + "description": "Connection record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "invi_msg_id": { + "description": "Invitation message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "invitation": { + "allOf": [{ "$ref": "#/definitions/InvitationMessage" }], + "description": "Out of band invitation message" + }, + "oob_id": { + "description": "Oob record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "our_recipient_key": { + "description": "Recipient key used for oob invitation", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "role": { + "description": "OOB Role", + "enum": ["sender", "receiver"], + "example": "receiver", + "type": "string" + }, + "state": { + "description": "Out of band message exchange state", + "enum": [ + "initial", + "prepare-response", + "await-response", + "reuse-not-accepted", + "reuse-accepted", + "done", + "deleted" + ], + "example": "await-response", + "type": "string" + }, + "their_service": { "$ref": "#/definitions/ServiceDecorator" }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "required": ["invi_msg_id", "invitation", "oob_id", "state"], + "type": "object" + }, + "PerformRequest": { + "properties": { + "name": { + "description": "Menu option name", + "example": "Query", + "type": "string" + }, + "params": { + "additionalProperties": { + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "description": "Input parameter values", + "type": "object" + } + }, + "type": "object" + }, + "PingRequest": { + "properties": { + "comment": { + "description": "Comment for the ping message", + "type": "string", + "x-nullable": true + } + }, + "type": "object" + }, + "PingRequestResponse": { + "properties": { + "thread_id": { + "description": "Thread ID of the ping message", + "type": "string" + } + }, + "type": "object" + }, + "PresentationDefinition": { + "properties": { + "format": { "$ref": "#/definitions/ClaimFormat" }, + "id": { + "description": "Unique Resource Identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type": "string" + }, + "input_descriptors": { + "items": { "$ref": "#/definitions/InputDescriptors" }, + "type": "array" + }, + "name": { + "description": "Human-friendly name that describes what the presentation definition pertains to", + "type": "string" + }, + "purpose": { + "description": "Describes the purpose for which the Presentation Definition's inputs are being requested", + "type": "string" + }, + "submission_requirements": { + "items": { "$ref": "#/definitions/SubmissionRequirements" }, + "type": "array" + } + }, + "type": "object" + }, + "PresentationProposal": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "presentation_proposal": { "$ref": "#/definitions/IndyPresPreview" } + }, + "required": ["presentation_proposal"], + "type": "object" + }, + "PresentationRequest": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "request_presentations~attach": { + "items": { "$ref": "#/definitions/AttachDecorator" }, + "type": "array" + } + }, + "required": ["request_presentations~attach"], + "type": "object" + }, + "ProfileSettings": { + "properties": { + "settings": { + "description": "Profile settings dict", + "example": { + "debug.invite_public": true, + "log.level": "INFO", + "public_invites": false + }, + "type": "object" + } + }, + "type": "object" + }, + "ProtocolDescriptor": { + "properties": { + "pid": { "type": "string" }, + "roles": { + "description": "List of roles", + "items": { + "description": "Role: requester or responder", + "example": "requester", + "type": "string" + }, + "type": "array", + "x-nullable": true + } + }, + "required": ["pid"], + "type": "object" + }, + "PublishRevocations": { + "properties": { + "rrid2crid": { + "additionalProperties": { + "items": { + "description": "Credential revocation identifier", + "example": "12345", + "pattern": "^[1-9][0-9]*$", + "type": "string" + }, + "type": "array" + }, + "description": "Credential revocation ids by revocation registry id", + "type": "object" + } + }, + "type": "object" + }, + "Queries": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "queries": { + "items": { "$ref": "#/definitions/QueryItem" }, + "type": "array" + } + }, + "type": "object" + }, + "Query": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { "type": "string", "x-nullable": true }, + "query": { "type": "string" } + }, + "required": ["query"], + "type": "object" + }, + "QueryItem": { + "properties": { + "feature-type": { + "description": "feature type", + "enum": ["protocol", "goal-code"], + "type": "string" + }, + "match": { "description": "match", "type": "string" } + }, + "required": ["feature-type", "match"], + "type": "object" + }, + "RawEncoded": { + "properties": { + "encoded": { + "description": "Encoded value", + "example": "-1", + "pattern": "^-?[0-9]*$", + "type": "string" + }, + "raw": { "description": "Raw value", "type": "string" } + }, + "type": "object" + }, + "ReceiveInvitationRequest": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "did": { + "description": "DID for connection invitation", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "type": "string" + }, + "imageUrl": { + "description": "Optional image URL for connection invitation", + "example": "http://192.168.56.101/img/logo.jpg", + "format": "url", + "type": "string", + "x-nullable": true + }, + "label": { + "description": "Optional label for connection invitation", + "example": "Bob", + "type": "string" + }, + "recipientKeys": { + "description": "List of recipient keys", + "items": { + "description": "Recipient public key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "type": "array" + }, + "routingKeys": { + "description": "List of routing keys", + "items": { + "description": "Routing key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "type": "array" + }, + "serviceEndpoint": { + "description": "Service endpoint at which to reach this agent", + "example": "http://192.168.56.101:8020", + "type": "string" + } + }, + "type": "object" + }, + "RemoveWalletRequest": { + "properties": { + "wallet_key": { + "description": "Master key used for key derivation. Only required for unmanaged wallets.", + "example": "MySecretKey123", + "type": "string" + } + }, + "type": "object" + }, + "ResolutionResult": { + "properties": { + "did_document": { "description": "DID Document", "type": "object" }, + "metadata": { "description": "Resolution metadata", "type": "object" } + }, + "required": ["did_document", "metadata"], + "type": "object" + }, + "RevRegCreateRequest": { + "properties": { + "credential_definition_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "max_cred_num": { + "description": "Revocation registry size", + "example": 1000, + "format": "int32", + "maximum": 32768, + "minimum": 4, + "type": "integer" + } + }, + "type": "object" + }, + "RevRegIssuedResult": { + "properties": { + "result": { + "description": "Number of credentials issued against revocation registry", + "example": 0, + "format": "int32", + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "RevRegResult": { + "properties": { + "result": { "$ref": "#/definitions/IssuerRevRegRecord" } + }, + "type": "object" + }, + "RevRegUpdateTailsFileUri": { + "properties": { + "tails_public_uri": { + "description": "Public URI to the tails file", + "example": "http://192.168.56.133:6543/revocation/registry/WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0/tails-file", + "format": "url", + "type": "string" + } + }, + "required": ["tails_public_uri"], + "type": "object" + }, + "RevRegWalletUpdatedResult": { + "properties": { + "accum_calculated": { + "description": "Calculated accumulator for phantom revocations", + "type": "object" + }, + "accum_fixed": { + "description": "Applied ledger transaction to fix revocations", + "type": "object" + }, + "rev_reg_delta": { + "description": "Indy revocation registry delta", + "type": "object" + } + }, + "type": "object" + }, + "RevRegsCreated": { + "properties": { + "rev_reg_ids": { + "items": { + "description": "Revocation registry identifiers", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RevocationModuleResponse": { "properties": {}, "type": "object" }, + "RevokeRequest": { + "properties": { + "comment": { + "description": "Optional comment to include in revocation notification", + "type": "string" + }, + "connection_id": { + "description": "Connection ID to which the revocation notification will be sent; required if notify is true", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type": "string" + }, + "cred_ex_id": { + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type": "string" + }, + "cred_rev_id": { + "description": "Credential revocation identifier", + "example": "12345", + "pattern": "^[1-9][0-9]*$", + "type": "string" + }, + "notify": { + "description": "Send a notification to the credential recipient", + "type": "boolean" + }, + "notify_version": { + "description": "Specify which version of the revocation notification should be sent", + "enum": ["v1_0", "v2_0"], + "type": "string" + }, + "publish": { + "description": "(True) publish revocation to ledger immediately, or (default, False) mark it pending", + "type": "boolean" + }, + "rev_reg_id": { + "description": "Revocation registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + }, + "thread_id": { + "description": "Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true", + "type": "string" + } + }, + "type": "object" + }, + "RouteRecord": { + "properties": { + "connection_id": { "type": "string" }, + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "recipient_key": { "type": "string" }, + "record_id": { "type": "string" }, + "role": { "type": "string" }, + "state": { + "description": "Current record state", + "example": "active", + "type": "string" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "wallet_id": { "type": "string" } + }, + "required": ["recipient_key"], + "type": "object" + }, + "SDJWSCreate": { + "properties": { + "did": { + "description": "DID of interest", + "example": "did:peer:WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "type": "string" + }, + "headers": { "type": "object" }, + "non_sd_list": { + "items": { + "example": [ + "name", + "address", + "address.street_address", + "nationalities[1:3]" + ], + "pattern": "[a-z0-9:\\[\\]_\\.@?\\(\\)]", + "type": "string" + }, + "type": "array" + }, + "payload": { "type": "object" }, + "verificationMethod": { + "description": "Information used for proof verification", + "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", + "pattern": "\\w+:(\\/?\\/?)[^\\s]+", + "type": "string" + } + }, + "required": ["payload"], + "type": "object" + }, + "SDJWSVerify": { + "properties": { + "sd_jwt": { + "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk~WyJEM3BUSFdCYWNRcFdpREc2TWZKLUZnIiwgIkRFIl0~WyJPMTFySVRjRTdHcXExYW9oRkd0aDh3IiwgIlNBIl0~WyJkVmEzX1JlTGNsWTU0R1FHZm5oWlRnIiwgInVwZGF0ZWRfYXQiLCAxNTcwMDAwMDAwXQ", + "pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+(?:~[a-zA-Z0-9._-]+)*~?$", + "type": "string" + } + }, + "type": "object" + }, + "SDJWSVerifyResponse": { + "properties": { + "disclosures": { + "description": "Disclosure arrays associated with the SD-JWT", + "example": [ + ["fx1iT_mETjGiC-JzRARnVg", "name", "Alice"], + [ + "n4-t3mlh8jSS6yMIT7QHnA", + "street_address", + { "_sd": ["kLZrLK7enwfqeOzJ9-Ss88YS3mhjOAEk9lr_ix2Heng"] } + ] + ], + "items": { "items": {}, "type": "array" }, + "type": "array" + }, + "error": { "description": "Error text", "type": "string" }, + "headers": { + "description": "Headers from verified JWT.", + "type": "object" + }, + "kid": { "description": "kid of signer", "type": "string" }, + "payload": { + "description": "Payload from verified JWT", + "type": "object" + }, + "valid": { "type": "boolean" } + }, + "required": ["headers", "kid", "payload", "valid"], + "type": "object" + }, + "Schema": { + "properties": { + "attrNames": { + "description": "Schema attribute names", + "items": { + "description": "Attribute name", + "example": "score", + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + }, + "name": { + "description": "Schema name", + "example": "schema_name", + "type": "string" + }, + "seqNo": { + "description": "Schema sequence number", + "example": 10, + "format": "int32", + "minimum": 1, + "type": "integer" + }, + "ver": { + "description": "Node protocol version", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + }, + "version": { + "description": "Schema version", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + } + }, + "type": "object" + }, + "SchemaGetResult": { + "properties": { "schema": { "$ref": "#/definitions/Schema" } }, + "type": "object" + }, + "SchemaInputDescriptor": { + "properties": { + "required": { "description": "Required", "type": "boolean" }, + "uri": { "description": "URI", "type": "string" } + }, + "type": "object" + }, + "SchemaSendRequest": { + "properties": { + "attributes": { + "description": "List of schema attributes", + "items": { + "description": "attribute name", + "example": "score", + "type": "string" + }, + "type": "array" + }, + "schema_name": { + "description": "Schema name", + "example": "prefs", + "type": "string" + }, + "schema_version": { + "description": "Schema version", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + } + }, + "required": ["attributes", "schema_name", "schema_version"], + "type": "object" + }, + "SchemaSendResult": { + "properties": { + "schema": { + "allOf": [{ "$ref": "#/definitions/Schema" }], + "description": "Schema definition" + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + } + }, + "required": ["schema_id"], + "type": "object" + }, + "SchemasCreatedResult": { + "properties": { + "schema_ids": { + "items": { + "description": "Schema identifiers", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SchemasInputDescriptorFilter": { + "properties": { + "oneof_filter": { "description": "oneOf", "type": "boolean" }, + "uri_groups": { + "items": { + "items": { "$ref": "#/definitions/SchemaInputDescriptor" }, + "type": "array" + }, + "type": "array" + } + }, + "type": "object" + }, + "SendMenu": { + "properties": { + "menu": { + "allOf": [{ "$ref": "#/definitions/MenuJson" }], + "description": "Menu to send to connection" + } + }, + "required": ["menu"], + "type": "object" + }, + "SendMessage": { + "properties": { + "content": { + "description": "Message content", + "example": "Hello", + "type": "string" + } + }, + "type": "object" + }, + "ServiceDecorator": { + "properties": { + "recipientKeys": { + "description": "List of recipient keys", + "items": { + "description": "Recipient public key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "type": "array" + }, + "routingKeys": { + "description": "List of routing keys", + "items": { + "description": "Routing key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + }, + "type": "array" + }, + "serviceEndpoint": { + "description": "Service endpoint at which to reach this agent", + "example": "http://192.168.56.101:8020", + "type": "string" + } + }, + "required": ["recipientKeys", "serviceEndpoint"], + "type": "object" + }, + "SignRequest": { + "properties": { + "doc": { "$ref": "#/definitions/Doc" }, + "verkey": { + "description": "Verkey to use for signing", + "type": "string" + } + }, + "required": ["doc", "verkey"], + "type": "object" + }, + "SignResponse": { + "properties": { + "error": { "description": "Error text", "type": "string" }, + "signed_doc": { "description": "Signed document", "type": "object" } + }, + "type": "object" + }, + "SignatureOptions": { + "properties": { + "challenge": { "type": "string" }, + "domain": { "type": "string" }, + "proofPurpose": { "type": "string" }, + "type": { "type": "string" }, + "verificationMethod": { "type": "string" } + }, + "required": ["proofPurpose", "verificationMethod"], + "type": "object" + }, + "SignedDoc": { + "properties": { + "proof": { + "allOf": [{ "$ref": "#/definitions/SignatureOptions" }], + "description": "Linked data proof" + } + }, + "required": ["proof"], + "type": "object" + }, + "SubmissionRequirements": { + "properties": { + "count": { + "description": "Count Value", + "example": 1234, + "format": "int32", + "type": "integer" + }, + "from": { "description": "From", "type": "string" }, + "from_nested": { + "items": { "$ref": "#/definitions/SubmissionRequirements" }, + "type": "array" + }, + "max": { + "description": "Max Value", + "example": 1234, + "format": "int32", + "type": "integer" + }, + "min": { + "description": "Min Value", + "example": 1234, + "format": "int32", + "type": "integer" + }, + "name": { "description": "Name", "type": "string" }, + "purpose": { "description": "Purpose", "type": "string" }, + "rule": { + "description": "Selection", + "enum": ["all", "pick"], + "type": "string" + } + }, + "type": "object" + }, + "TAAAccept": { + "properties": { + "mechanism": { "type": "string" }, + "text": { "type": "string" }, + "version": { "type": "string" } + }, + "type": "object" + }, + "TAAAcceptance": { + "properties": { + "mechanism": { "type": "string" }, + "time": { + "example": 1640995199, + "format": "int32", + "maximum": 18446744073709551615, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "TAAInfo": { + "properties": { + "aml_record": { "$ref": "#/definitions/AMLRecord" }, + "taa_accepted": { "$ref": "#/definitions/TAAAcceptance" }, + "taa_record": { "$ref": "#/definitions/TAARecord" }, + "taa_required": { "type": "boolean" } + }, + "type": "object" + }, + "TAARecord": { + "properties": { + "digest": { "type": "string" }, + "text": { "type": "string" }, + "version": { "type": "string" } + }, + "type": "object" + }, + "TAAResult": { + "properties": { "result": { "$ref": "#/definitions/TAAInfo" } }, + "type": "object" + }, + "TailsDeleteResponse": { + "properties": { "message": { "type": "string" } }, + "type": "object" + }, + "TransactionJobs": { + "properties": { + "transaction_my_job": { + "description": "My transaction related job", + "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], + "type": "string" + }, + "transaction_their_job": { + "description": "Their transaction related job", + "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], + "type": "string" + } + }, + "type": "object" + }, + "TransactionList": { + "properties": { + "results": { + "description": "List of transaction records", + "items": { "$ref": "#/definitions/TransactionRecord" }, + "type": "array" + } + }, + "type": "object" + }, + "TransactionRecord": { + "properties": { + "_type": { + "description": "Transaction type", + "example": "101", + "type": "string" + }, + "connection_id": { + "description": "The connection identifier for thie particular transaction record", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "endorser_write_txn": { + "description": "If True, Endorser will write the transaction after endorsing it", + "example": true, + "type": "boolean" + }, + "formats": { + "items": { + "additionalProperties": { "type": "string" }, + "example": { + "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "dif/endorse-transaction/request@v1.0" + }, + "type": "object" + }, + "type": "array" + }, + "messages_attach": { + "items": { + "example": { + "@id": "143c458d-1b1c-40c7-ab85-4d16808ddf0a", + "data": { + "json": "{\"endorser\": \"V4SGRU86Z58d6TV7PBUe6f\",\"identifier\": \"LjgpST2rjsoxYegQDRm7EL\",\"operation\": {\"data\": {\"attr_names\": [\"first_name\", \"last_name\"],\"name\": \"test_schema\",\"version\": \"2.1\",},\"type\": \"101\",},\"protocolVersion\": 2,\"reqId\": 1597766666168851000,\"signatures\": {\"LjgpST2rjsox\": \"4ATKMn6Y9sTgwqaGTm7py2c2M8x1EVDTWKZArwyuPgjU\"}, \"taaAcceptance\": {\"mechanism\": \"manual\",\"taaDigest\": \"f50fe2c2ab977006761d36bd6f23e4c6a7e0fc2feb9f62\",\"time\": 1597708800,}}" + }, + "mime-type": "application/json" + }, + "type": "object" + }, + "type": "array" + }, + "meta_data": { + "example": { + "context": { "param1": "param1_value", "param2": "param2_value" }, + "post_process": [{ "topic": "topic_value", "other": "other_value" }] + }, + "type": "object" + }, + "signature_request": { + "items": { + "example": { + "author_goal_code": "aries.transaction.ledger.write", + "context": "did:sov", + "method": "add-signature", + "signature_type": "", + "signer_goal_code": "aries.transaction.endorse" + }, + "type": "object" + }, + "type": "array" + }, + "signature_response": { + "items": { + "example": { + "context": "did:sov", + "message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "method": "add-signature", + "signer_goal_code": "aries.transaction.refuse" + }, + "type": "object" + }, + "type": "array" + }, + "state": { + "description": "Current record state", + "example": "active", + "type": "string" + }, + "thread_id": { + "description": "Thread Identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "timing": { + "example": { "expires_time": "2020-12-13T17:29:06+0000" }, + "type": "object" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + }, + "transaction_id": { + "description": "Transaction identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "type": "object" + }, + "TxnOrCredentialDefinitionSendResult": { + "properties": { + "sent": { "$ref": "#/definitions/CredentialDefinitionSendResult" }, + "txn": { + "allOf": [{ "$ref": "#/definitions/TransactionRecord" }], + "description": "Credential definition transaction to endorse" + } + }, + "type": "object" + }, + "TxnOrPublishRevocationsResult": { + "properties": { + "sent": { "$ref": "#/definitions/PublishRevocations" }, + "txn": { + "allOf": [{ "$ref": "#/definitions/TransactionRecord" }], + "description": "Revocation registry revocations transaction to endorse" + } + }, + "type": "object" + }, + "TxnOrRegisterLedgerNymResponse": { + "properties": { + "success": { + "description": "Success of nym registration operation", + "example": true, + "type": "boolean" + }, + "txn": { + "allOf": [{ "$ref": "#/definitions/TransactionRecord" }], + "description": "DID transaction to endorse" + } + }, + "type": "object" + }, + "TxnOrRevRegResult": { + "properties": { + "sent": { "$ref": "#/definitions/RevRegResult" }, + "txn": { + "allOf": [{ "$ref": "#/definitions/TransactionRecord" }], + "description": "Revocation registry definition transaction to endorse" + } + }, + "type": "object" + }, + "TxnOrSchemaSendResult": { + "properties": { + "sent": { + "allOf": [{ "$ref": "#/definitions/SchemaSendResult" }], + "description": "Content sent" + }, + "txn": { + "allOf": [{ "$ref": "#/definitions/TransactionRecord" }], + "description": "Schema transaction to endorse" + } + }, + "type": "object" + }, + "UpdateProfileSettings": { + "properties": { + "extra_settings": { + "description": "Agent config key-value pairs", + "example": { + "ACAPY_INVITE_PUBLIC": true, + "log-level": "INFO", + "public-invites": false + }, + "type": "object" + } + }, + "type": "object" + }, + "UpdateWalletRequest": { + "properties": { + "extra_settings": { + "description": "Agent config key-value pairs", + "type": "object" + }, + "image_url": { + "description": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", + "example": "https://aries.ca/images/sample.png", + "type": "string" + }, + "label": { + "description": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", + "example": "Alice", + "type": "string" + }, + "wallet_dispatch_type": { + "description": "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", + "enum": ["default", "both", "base"], + "example": "default", + "type": "string" + }, + "wallet_webhook_urls": { + "description": "List of Webhook URLs associated with this subwallet", + "items": { + "description": "Optional webhook URL to receive webhook messages", + "example": "http://localhost:8022/webhooks", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "V10CredentialBoundOfferRequest": { + "properties": { + "counter_proposal": { + "allOf": [{ "$ref": "#/definitions/CredentialProposal" }], + "description": "Optional counter-proposal" + } + }, + "type": "object" + }, + "V10CredentialConnFreeOfferRequest": { + "properties": { + "auto_issue": { + "description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", + "type": "boolean" + }, + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "credential_preview": { "$ref": "#/definitions/CredentialPreview" }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + } + }, + "required": ["cred_def_id", "credential_preview"], + "type": "object" + }, + "V10CredentialCreate": { + "properties": { + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "credential_proposal": { "$ref": "#/definitions/CredentialPreview" }, + "issuer_did": { + "description": "Credential issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + }, + "schema_issuer_did": { + "description": "Schema issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "schema_name": { + "description": "Schema name", + "example": "preferences", + "type": "string" + }, + "schema_version": { + "description": "Schema version", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + } + }, + "required": ["credential_proposal"], + "type": "object" + }, + "V10CredentialExchange": { + "properties": { + "auto_issue": { + "description": "Issuer choice to issue to request in this credential exchange", + "example": false, + "type": "boolean" + }, + "auto_offer": { + "description": "Holder choice to accept offer in this credential exchange", + "example": false, + "type": "boolean" + }, + "auto_remove": { + "description": "Issuer choice to remove this credential exchange record when complete", + "example": false, + "type": "boolean" + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "credential": { + "allOf": [{ "$ref": "#/definitions/IndyCredInfo" }], + "description": "Credential as stored" + }, + "credential_definition_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "credential_exchange_id": { + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "credential_id": { + "description": "Credential identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "credential_offer": { + "allOf": [{ "$ref": "#/definitions/IndyCredAbstract" }], + "description": "(Indy) credential offer" + }, + "credential_offer_dict": { + "allOf": [{ "$ref": "#/definitions/CredentialOffer" }], + "description": "Credential offer message" + }, + "credential_proposal_dict": { + "allOf": [{ "$ref": "#/definitions/CredentialProposal" }], + "description": "Credential proposal message" + }, + "credential_request": { + "allOf": [{ "$ref": "#/definitions/IndyCredRequest" }], + "description": "(Indy) credential request" + }, + "credential_request_metadata": { + "description": "(Indy) credential request metadata", + "type": "object" + }, + "error_msg": { + "description": "Error message", + "example": "Credential definition identifier is not set in proposal", + "type": "string" + }, + "initiator": { + "description": "Issue-credential exchange initiator: self or external", + "enum": ["self", "external"], + "example": "self", + "type": "string" + }, + "parent_thread_id": { + "description": "Parent thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "raw_credential": { + "allOf": [{ "$ref": "#/definitions/IndyCredential" }], + "description": "Credential as received, prior to storage in holder wallet" + }, + "revoc_reg_id": { + "description": "Revocation registry identifier", + "type": "string" + }, + "revocation_id": { + "description": "Credential identifier within revocation registry", + "type": "string" + }, + "role": { + "description": "Issue-credential exchange role: holder or issuer", + "enum": ["holder", "issuer"], + "example": "issuer", + "type": "string" + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + }, + "state": { + "description": "Issue-credential exchange state", + "example": "credential_acked", + "type": "string" + }, + "thread_id": { + "description": "Thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "type": "object" + }, + "V10CredentialExchangeAutoRemoveRequest": { + "properties": { + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + } + }, + "type": "object" + }, + "V10CredentialExchangeListResult": { + "properties": { + "results": { + "description": "Aries#0036 v1.0 credential exchange records", + "items": { "$ref": "#/definitions/V10CredentialExchange" }, + "type": "array" + } + }, + "type": "object" + }, + "V10CredentialFreeOfferRequest": { + "properties": { + "auto_issue": { + "description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", + "type": "boolean" + }, + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "credential_preview": { "$ref": "#/definitions/CredentialPreview" }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + } + }, + "required": ["connection_id", "cred_def_id", "credential_preview"], + "type": "object" + }, + "V10CredentialIssueRequest": { + "properties": { + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + } + }, + "type": "object" + }, + "V10CredentialProblemReportRequest": { + "properties": { "description": { "type": "string" } }, + "required": ["description"], + "type": "object" + }, + "V10CredentialProposalRequestMand": { + "properties": { + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "credential_proposal": { "$ref": "#/definitions/CredentialPreview" }, + "issuer_did": { + "description": "Credential issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + }, + "schema_issuer_did": { + "description": "Schema issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "schema_name": { + "description": "Schema name", + "example": "preferences", + "type": "string" + }, + "schema_version": { + "description": "Schema version", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + } + }, + "required": ["connection_id", "credential_proposal"], + "type": "object" + }, + "V10CredentialProposalRequestOpt": { + "properties": { + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "credential_proposal": { "$ref": "#/definitions/CredentialPreview" }, + "issuer_did": { + "description": "Credential issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + }, + "schema_issuer_did": { + "description": "Schema issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "schema_name": { + "description": "Schema name", + "example": "preferences", + "type": "string" + }, + "schema_version": { + "description": "Schema version", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + } + }, + "required": ["connection_id"], + "type": "object" + }, + "V10CredentialStoreRequest": { + "properties": { "credential_id": { "type": "string" } }, + "type": "object" + }, + "V10DiscoveryExchangeListResult": { + "properties": { + "results": { + "items": { + "allOf": [{ "$ref": "#/definitions/V10DiscoveryRecord" }], + "description": "Discover Features v1.0 exchange record" + }, + "type": "array" + } + }, + "type": "object" + }, + "V10DiscoveryRecord": { + "properties": { + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "disclose": { + "allOf": [{ "$ref": "#/definitions/Disclose" }], + "description": "Disclose message" + }, + "discovery_exchange_id": { + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "query_msg": { + "allOf": [{ "$ref": "#/definitions/Query" }], + "description": "Query message" + }, + "state": { + "description": "Current record state", + "example": "active", + "type": "string" + }, + "thread_id": { + "description": "Thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "type": "object" + }, + "V10PresentProofModuleResponse": { "properties": {}, "type": "object" }, + "V10PresentationCreateRequestRequest": { + "properties": { + "auto_remove": { + "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "auto_verify": { + "description": "Verifier choice to auto-verify proof presentation", + "example": false, + "type": "boolean" + }, + "comment": { "type": "string", "x-nullable": true }, + "proof_request": { "$ref": "#/definitions/IndyProofRequest" }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } + }, + "required": ["proof_request"], + "type": "object" + }, + "V10PresentationExchange": { + "properties": { + "auto_present": { + "description": "Prover choice to auto-present proof as verifier requests", + "example": false, + "type": "boolean" + }, + "auto_remove": { + "description": "Verifier choice to remove this presentation exchange record when complete", + "example": false, + "type": "boolean" + }, + "auto_verify": { + "description": "Verifier choice to auto-verify proof presentation", + "type": "boolean" + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "error_msg": { + "description": "Error message", + "example": "Invalid structure", + "type": "string" + }, + "initiator": { + "description": "Present-proof exchange initiator: self or external", + "enum": ["self", "external"], + "example": "self", + "type": "string" + }, + "presentation": { + "allOf": [{ "$ref": "#/definitions/IndyProof" }], + "description": "(Indy) presentation (also known as proof)" + }, + "presentation_exchange_id": { + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "presentation_proposal_dict": { + "allOf": [{ "$ref": "#/definitions/PresentationProposal" }], + "description": "Presentation proposal message" + }, + "presentation_request": { + "allOf": [{ "$ref": "#/definitions/IndyProofRequest" }], + "description": "(Indy) presentation request (also known as proof request)" + }, + "presentation_request_dict": { + "allOf": [{ "$ref": "#/definitions/PresentationRequest" }], + "description": "Presentation request message" + }, + "role": { + "description": "Present-proof exchange role: prover or verifier", + "enum": ["prover", "verifier"], + "example": "prover", + "type": "string" + }, + "state": { + "description": "Present-proof exchange state", + "example": "verified", + "type": "string" + }, + "thread_id": { + "description": "Thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "verified": { + "description": "Whether presentation is verified: true or false", + "enum": ["true", "false"], + "example": "true", + "type": "string" + }, + "verified_msgs": { + "items": { + "description": "Proof verification warning or error information", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "V10PresentationExchangeList": { + "properties": { + "results": { + "description": "Aries RFC 37 v1.0 presentation exchange records", + "items": { "$ref": "#/definitions/V10PresentationExchange" }, + "type": "array" + } + }, + "type": "object" + }, + "V10PresentationProblemReportRequest": { + "properties": { "description": { "type": "string" } }, + "required": ["description"], + "type": "object" + }, + "V10PresentationProposalRequest": { + "properties": { + "auto_present": { + "description": "Whether to respond automatically to presentation requests, building and presenting requested proof", + "type": "boolean" + }, + "auto_remove": { + "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "presentation_proposal": { "$ref": "#/definitions/IndyPresPreview" }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } + }, + "required": ["connection_id", "presentation_proposal"], + "type": "object" + }, + "V10PresentationSendRequest": { + "properties": { + "auto_remove": { + "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "requested_attributes": { + "additionalProperties": { + "$ref": "#/definitions/IndyRequestedCredsRequestedAttr" + }, + "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers", + "type": "object" + }, + "requested_predicates": { + "additionalProperties": { + "$ref": "#/definitions/IndyRequestedCredsRequestedPred" + }, + "description": "Nested object mapping proof request predicate referents to requested-predicate specifiers", + "type": "object" + }, + "self_attested_attributes": { + "additionalProperties": { + "description": "Self-attested attribute values to use in requested-credentials structure for proof construction", + "example": "self_attested_value", + "type": "string" + }, + "description": "Self-attested attributes to build into proof", + "type": "object" + }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } + }, + "required": [ + "requested_attributes", + "requested_predicates", + "self_attested_attributes" + ], + "type": "object" + }, + "V10PresentationSendRequestRequest": { + "properties": { + "auto_remove": { + "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "auto_verify": { + "description": "Verifier choice to auto-verify proof presentation", + "example": false, + "type": "boolean" + }, + "comment": { "type": "string", "x-nullable": true }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "proof_request": { "$ref": "#/definitions/IndyProofRequest" }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } + }, + "required": ["connection_id", "proof_request"], + "type": "object" + }, + "V10PresentationSendRequestToProposal": { + "properties": { + "auto_remove": { + "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "auto_verify": { + "description": "Verifier choice to auto-verify proof presentation", + "example": false, + "type": "boolean" + }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "V20CredAttrSpec": { + "properties": { + "mime-type": { + "description": "MIME type: omit for (null) default", + "example": "image/jpeg", + "type": "string", + "x-nullable": true + }, + "name": { + "description": "Attribute name", + "example": "favourite_drink", + "type": "string" + }, + "value": { + "description": "Attribute value: base64-encode if MIME type is present", + "example": "martini", + "type": "string" + } + }, + "required": ["name", "value"], + "type": "object" + }, + "V20CredBoundOfferRequest": { + "properties": { + "counter_preview": { + "allOf": [{ "$ref": "#/definitions/V20CredPreview" }], + "description": "Optional content for counter-proposal" + }, + "filter": { + "allOf": [{ "$ref": "#/definitions/V20CredFilter" }], + "description": "Credential specification criteria by format" + } + }, + "type": "object" + }, + "V20CredExFree": { + "properties": { + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "credential_preview": { "$ref": "#/definitions/V20CredPreview" }, + "filter": { + "allOf": [{ "$ref": "#/definitions/V20CredFilter" }], + "description": "Credential specification criteria by format" + }, + "replacement_id": { + "description": "Optional identifier used to manage credential replacement", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string", + "x-nullable": true + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + }, + "verification_method": { + "description": "For ld-proofs. Verification method for signing.", + "type": "string", + "x-nullable": true + } + }, + "required": ["connection_id", "filter"], + "type": "object" + }, + "V20CredExRecord": { + "properties": { + "auto_issue": { + "description": "Issuer choice to issue to request in this credential exchange", + "example": false, + "type": "boolean" + }, + "auto_offer": { + "description": "Holder choice to accept offer in this credential exchange", + "example": false, + "type": "boolean" + }, + "auto_remove": { + "description": "Issuer choice to remove this credential exchange record when complete", + "example": false, + "type": "boolean" + }, + "by_format": { + "allOf": [{ "$ref": "#/definitions/V20CredExRecordByFormat" }], + "description": "Attachment content by format for proposal, offer, request, and issue", + "readOnly": true + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "cred_ex_id": { + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "cred_issue": { + "allOf": [{ "$ref": "#/definitions/V20CredIssue" }], + "description": "Serialized credential issue message" + }, + "cred_offer": { + "allOf": [{ "$ref": "#/definitions/V20CredOffer" }], + "description": "Credential offer message" + }, + "cred_preview": { + "allOf": [{ "$ref": "#/definitions/V20CredPreview" }], + "description": "Credential preview from credential proposal", + "readOnly": true + }, + "cred_proposal": { + "allOf": [{ "$ref": "#/definitions/V20CredProposal" }], + "description": "Credential proposal message" + }, + "cred_request": { + "allOf": [{ "$ref": "#/definitions/V20CredRequest" }], + "description": "Serialized credential request message" + }, + "error_msg": { + "description": "Error message", + "example": "The front fell off", + "type": "string" + }, + "initiator": { + "description": "Issue-credential exchange initiator: self or external", + "enum": ["self", "external"], + "example": "self", + "type": "string" + }, + "parent_thread_id": { + "description": "Parent thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "role": { + "description": "Issue-credential exchange role: holder or issuer", + "enum": ["issuer", "holder"], + "example": "issuer", + "type": "string" + }, + "state": { + "description": "Issue-credential exchange state", + "enum": [ + "proposal-sent", + "proposal-received", + "offer-sent", + "offer-received", + "request-sent", + "request-received", + "credential-issued", + "credential-received", + "done", + "credential-revoked", + "abandoned", + "deleted" + ], + "example": "done", + "type": "string" + }, + "thread_id": { + "description": "Thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "type": "object" + }, + "V20CredExRecordByFormat": { + "properties": { + "cred_issue": { "type": "object" }, + "cred_offer": { "type": "object" }, + "cred_proposal": { "type": "object" }, + "cred_request": { "type": "object" } + }, + "type": "object" + }, + "V20CredExRecordDetail": { + "properties": { + "cred_ex_record": { + "allOf": [{ "$ref": "#/definitions/V20CredExRecord" }], + "description": "Credential exchange record" + }, + "indy": { "$ref": "#/definitions/V20CredExRecordIndy" }, + "ld_proof": { "$ref": "#/definitions/V20CredExRecordLDProof" } + }, + "type": "object" + }, + "V20CredExRecordIndy": { + "properties": { + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "cred_ex_id": { + "description": "Corresponding v2.0 credential exchange record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "cred_ex_indy_id": { + "description": "Record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "cred_id_stored": { + "description": "Credential identifier stored in wallet", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "cred_request_metadata": { + "description": "Credential request metadata for indy holder", + "type": "object" + }, + "cred_rev_id": { + "description": "Credential revocation identifier within revocation registry", + "example": "12345", + "pattern": "^[1-9][0-9]*$", + "type": "string" + }, + "rev_reg_id": { + "description": "Revocation registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + }, + "state": { + "description": "Current record state", + "example": "active", + "type": "string" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "type": "object" + }, + "V20CredExRecordLDProof": { + "properties": { + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "cred_ex_id": { + "description": "Corresponding v2.0 credential exchange record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "cred_ex_ld_proof_id": { + "description": "Record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "cred_id_stored": { + "description": "Credential identifier stored in wallet", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "state": { + "description": "Current record state", + "example": "active", + "type": "string" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "type": "object" + }, + "V20CredExRecordListResult": { + "properties": { + "results": { + "description": "Credential exchange records and corresponding detail records", + "items": { "$ref": "#/definitions/V20CredExRecordDetail" }, + "type": "array" + } + }, + "type": "object" + }, + "V20CredFilter": { + "properties": { + "indy": { + "allOf": [{ "$ref": "#/definitions/V20CredFilterIndy" }], + "description": "Credential filter for indy" + }, + "ld_proof": { + "allOf": [{ "$ref": "#/definitions/LDProofVCDetail" }], + "description": "Credential filter for linked data proof" + } + }, + "type": "object" + }, + "V20CredFilterIndy": { + "properties": { + "cred_def_id": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + }, + "issuer_did": { + "description": "Credential issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + }, + "schema_issuer_did": { + "description": "Schema issuer DID", + "example": "WgWxqztrNooG92RXvxSTWv", + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + }, + "schema_name": { + "description": "Schema name", + "example": "preferences", + "type": "string" + }, + "schema_version": { + "description": "Schema version", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + } + }, + "type": "object" + }, + "V20CredFilterLDProof": { + "properties": { + "ld_proof": { + "allOf": [{ "$ref": "#/definitions/LDProofVCDetail" }], + "description": "Credential filter for linked data proof" + } + }, + "required": ["ld_proof"], + "type": "object" + }, + "V20CredFormat": { + "properties": { + "attach_id": { + "description": "Attachment identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "format": { + "description": "Attachment format specifier", + "example": "aries/ld-proof-vc-detail@v1.0", + "type": "string" + } + }, + "required": ["attach_id", "format"], + "type": "object" + }, + "V20CredIssue": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "credentials~attach": { + "description": "Credential attachments", + "items": { "$ref": "#/definitions/AttachDecorator" }, + "type": "array" + }, + "formats": { + "description": "Acceptable attachment formats", + "items": { "$ref": "#/definitions/V20CredFormat" }, + "type": "array" + }, + "replacement_id": { + "description": "Issuer-unique identifier to coordinate credential replacement", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + } + }, + "required": ["credentials~attach", "formats"], + "type": "object" + }, + "V20CredIssueProblemReportRequest": { + "properties": { "description": { "type": "string" } }, + "required": ["description"], + "type": "object" + }, + "V20CredIssueRequest": { + "properties": { + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + } + }, + "type": "object" + }, + "V20CredOffer": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "credential_preview": { "$ref": "#/definitions/V20CredPreview" }, + "formats": { + "description": "Acceptable credential formats", + "items": { "$ref": "#/definitions/V20CredFormat" }, + "type": "array" + }, + "offers~attach": { + "description": "Offer attachments", + "items": { "$ref": "#/definitions/AttachDecorator" }, + "type": "array" + }, + "replacement_id": { + "description": "Issuer-unique identifier to coordinate credential replacement", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + } + }, + "required": ["formats", "offers~attach"], + "type": "object" + }, + "V20CredOfferConnFreeRequest": { + "properties": { + "auto_issue": { + "description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", + "type": "boolean" + }, + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "credential_preview": { "$ref": "#/definitions/V20CredPreview" }, + "filter": { + "allOf": [{ "$ref": "#/definitions/V20CredFilter" }], + "description": "Credential specification criteria by format" + }, + "replacement_id": { + "description": "Optional identifier used to manage credential replacement", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string", + "x-nullable": true + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + } + }, + "required": ["filter"], + "type": "object" + }, + "V20CredOfferRequest": { + "properties": { + "auto_issue": { + "description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", + "type": "boolean" + }, + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "credential_preview": { "$ref": "#/definitions/V20CredPreview" }, + "filter": { + "allOf": [{ "$ref": "#/definitions/V20CredFilter" }], + "description": "Credential specification criteria by format" + }, + "replacement_id": { + "description": "Optional identifier used to manage credential replacement", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string", + "x-nullable": true + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + } + }, + "required": ["connection_id", "filter"], + "type": "object" + }, + "V20CredPreview": { + "properties": { + "@type": { + "description": "Message type identifier", + "example": "issue-credential/2.0/credential-preview", + "type": "string" + }, + "attributes": { + "items": { "$ref": "#/definitions/V20CredAttrSpec" }, + "type": "array" + } + }, + "required": ["attributes"], + "type": "object" + }, + "V20CredProposal": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "credential_preview": { + "allOf": [{ "$ref": "#/definitions/V20CredPreview" }], + "description": "Credential preview" + }, + "filters~attach": { + "description": "Credential filter per acceptable format on corresponding identifier", + "items": { "$ref": "#/definitions/AttachDecorator" }, + "type": "array" + }, + "formats": { + "description": "Attachment formats", + "items": { "$ref": "#/definitions/V20CredFormat" }, + "type": "array" + } + }, + "required": ["filters~attach", "formats"], + "type": "object" + }, + "V20CredRequest": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "formats": { + "description": "Acceptable attachment formats", + "items": { "$ref": "#/definitions/V20CredFormat" }, + "type": "array" + }, + "requests~attach": { + "description": "Request attachments", + "items": { "$ref": "#/definitions/AttachDecorator" }, + "type": "array" + } + }, + "required": ["formats", "requests~attach"], + "type": "object" + }, + "V20CredRequestFree": { + "properties": { + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "filter": { + "allOf": [{ "$ref": "#/definitions/V20CredFilterLDProof" }], + "description": "Credential specification criteria by format" + }, + "holder_did": { + "description": "Holder DID to substitute for the credentialSubject.id", + "example": "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", + "type": "string", + "x-nullable": true + }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } + }, + "required": ["connection_id", "filter"], + "type": "object" + }, + "V20CredRequestRequest": { + "properties": { + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "holder_did": { + "description": "Holder DID to substitute for the credentialSubject.id", + "example": "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", + "type": "string", + "x-nullable": true + } + }, + "type": "object" + }, + "V20CredStoreRequest": { + "properties": { "credential_id": { "type": "string" } }, + "type": "object" + }, + "V20DiscoveryExchangeListResult": { + "properties": { + "results": { + "items": { + "allOf": [{ "$ref": "#/definitions/V20DiscoveryRecord" }], + "description": "Discover Features v2.0 exchange record" + }, + "type": "array" + } + }, + "type": "object" + }, + "V20DiscoveryExchangeResult": { + "properties": { + "results": { + "allOf": [{ "$ref": "#/definitions/V20DiscoveryRecord" }], + "description": "Discover Features v2.0 exchange record" + } + }, + "type": "object" + }, + "V20DiscoveryRecord": { + "properties": { + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "disclosures": { + "allOf": [{ "$ref": "#/definitions/Disclosures" }], + "description": "Disclosures message" + }, + "discovery_exchange_id": { + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "queries_msg": { + "allOf": [{ "$ref": "#/definitions/Queries" }], + "description": "Queries message" + }, + "state": { + "description": "Current record state", + "example": "active", + "type": "string" + }, + "thread_id": { + "description": "Thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + } + }, + "type": "object" + }, + "V20IssueCredSchemaCore": { + "properties": { + "auto_remove": { + "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "credential_preview": { "$ref": "#/definitions/V20CredPreview" }, + "filter": { + "allOf": [{ "$ref": "#/definitions/V20CredFilter" }], + "description": "Credential specification criteria by format" + }, + "replacement_id": { + "description": "Optional identifier used to manage credential replacement", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string", + "x-nullable": true + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + } + }, + "required": ["filter"], + "type": "object" + }, + "V20IssueCredentialModuleResponse": { "properties": {}, "type": "object" }, + "V20Pres": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "formats": { + "description": "Acceptable attachment formats", + "items": { "$ref": "#/definitions/V20PresFormat" }, + "type": "array" + }, + "presentations~attach": { + "items": { "$ref": "#/definitions/AttachDecorator" }, + "type": "array" + } + }, + "required": ["formats", "presentations~attach"], + "type": "object" + }, + "V20PresCreateRequestRequest": { + "properties": { + "auto_remove": { + "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "auto_verify": { + "description": "Verifier choice to auto-verify proof presentation", + "example": false, + "type": "boolean" + }, + "comment": { "type": "string", "x-nullable": true }, + "presentation_request": { + "$ref": "#/definitions/V20PresRequestByFormat" + }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } + }, + "required": ["presentation_request"], + "type": "object" + }, + "V20PresExRecord": { + "properties": { + "auto_present": { + "description": "Prover choice to auto-present proof as verifier requests", + "example": false, + "type": "boolean" + }, + "auto_remove": { + "description": "Verifier choice to remove this presentation exchange record when complete", + "example": false, + "type": "boolean" + }, + "auto_verify": { + "description": "Verifier choice to auto-verify proof presentation", + "type": "boolean" + }, + "by_format": { + "allOf": [{ "$ref": "#/definitions/V20PresExRecordByFormat" }], + "description": "Attachment content by format for proposal, request, and presentation", + "readOnly": true + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "error_msg": { + "description": "Error message", + "example": "Invalid structure", + "type": "string" + }, + "initiator": { + "description": "Present-proof exchange initiator: self or external", + "enum": ["self", "external"], + "example": "self", + "type": "string" + }, + "pres": { + "allOf": [{ "$ref": "#/definitions/V20Pres" }], + "description": "Presentation message" + }, + "pres_ex_id": { + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "pres_proposal": { + "allOf": [{ "$ref": "#/definitions/V20PresProposal" }], + "description": "Presentation proposal message" + }, + "pres_request": { + "allOf": [{ "$ref": "#/definitions/V20PresRequest" }], + "description": "Presentation request message" + }, + "role": { + "description": "Present-proof exchange role: prover or verifier", + "enum": ["prover", "verifier"], + "example": "prover", + "type": "string" + }, + "state": { + "description": "Present-proof exchange state", + "enum": [ + "proposal-sent", + "proposal-received", + "request-sent", + "request-received", + "presentation-sent", + "presentation-received", + "done", + "abandoned", + "deleted" + ], + "type": "string" + }, + "thread_id": { + "description": "Thread identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "verified": { + "description": "Whether presentation is verified: 'true' or 'false'", + "enum": ["true", "false"], + "example": "true", + "type": "string" + }, + "verified_msgs": { + "items": { + "description": "Proof verification warning or error information", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "V20PresExRecordByFormat": { + "properties": { + "pres": { "type": "object" }, + "pres_proposal": { "type": "object" }, + "pres_request": { "type": "object" } + }, + "type": "object" + }, + "V20PresExRecordList": { + "properties": { + "results": { + "description": "Presentation exchange records", + "items": { "$ref": "#/definitions/V20PresExRecord" }, + "type": "array" + } + }, + "type": "object" + }, + "V20PresFormat": { + "properties": { + "attach_id": { + "description": "Attachment identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "format": { + "description": "Attachment format specifier", + "example": "dif/presentation-exchange/submission@v1.0", + "type": "string" + } + }, + "required": ["attach_id", "format"], + "type": "object" + }, + "V20PresProblemReportRequest": { + "properties": { "description": { "type": "string" } }, + "required": ["description"], + "type": "object" + }, + "V20PresProposal": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string" + }, + "formats": { + "items": { "$ref": "#/definitions/V20PresFormat" }, + "type": "array" + }, + "proposals~attach": { + "description": "Attachment per acceptable format on corresponding identifier", + "items": { "$ref": "#/definitions/AttachDecorator" }, + "type": "array" + } + }, + "required": ["formats", "proposals~attach"], + "type": "object" + }, + "V20PresProposalByFormat": { + "properties": { + "dif": { + "allOf": [{ "$ref": "#/definitions/DIFProofProposal" }], + "description": "Presentation proposal for DIF" + }, + "indy": { + "allOf": [{ "$ref": "#/definitions/IndyProofRequest" }], + "description": "Presentation proposal for indy" + } + }, + "type": "object" + }, + "V20PresProposalRequest": { + "properties": { + "auto_present": { + "description": "Whether to respond automatically to presentation requests, building and presenting requested proof", + "type": "boolean" + }, + "auto_remove": { + "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "comment": { + "description": "Human-readable comment", + "type": "string", + "x-nullable": true + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "presentation_proposal": { + "$ref": "#/definitions/V20PresProposalByFormat" + }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } + }, + "required": ["connection_id", "presentation_proposal"], + "type": "object" + }, + "V20PresRequest": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "@type": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly": true, + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string" + }, + "formats": { + "items": { "$ref": "#/definitions/V20PresFormat" }, + "type": "array" + }, + "request_presentations~attach": { + "description": "Attachment per acceptable format on corresponding identifier", + "items": { "$ref": "#/definitions/AttachDecorator" }, + "type": "array" + }, + "will_confirm": { + "description": "Whether verifier will send confirmation ack", + "type": "boolean" + } + }, + "required": ["formats", "request_presentations~attach"], + "type": "object" + }, + "V20PresRequestByFormat": { + "properties": { + "dif": { + "allOf": [{ "$ref": "#/definitions/DIFProofRequest" }], + "description": "Presentation request for DIF" + }, + "indy": { + "allOf": [{ "$ref": "#/definitions/IndyProofRequest" }], + "description": "Presentation request for indy" + } + }, + "type": "object" + }, + "V20PresSendRequestRequest": { + "properties": { + "auto_remove": { + "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "auto_verify": { + "description": "Verifier choice to auto-verify proof presentation", + "example": false, + "type": "boolean" + }, + "comment": { "type": "string", "x-nullable": true }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format": "uuid", + "type": "string" + }, + "presentation_request": { + "$ref": "#/definitions/V20PresRequestByFormat" + }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } + }, + "required": ["connection_id", "presentation_request"], + "type": "object" + }, + "V20PresSpecByFormatRequest": { + "properties": { + "auto_remove": { + "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "dif": { + "allOf": [{ "$ref": "#/definitions/DIFPresSpec" }], + "description": "Optional Presentation specification for DIF, overrides the PresentionExchange record's PresRequest" + }, + "indy": { + "allOf": [{ "$ref": "#/definitions/IndyPresSpec" }], + "description": "Presentation specification for indy" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + } + }, + "type": "object" + }, + "V20PresentProofModuleResponse": { "properties": {}, "type": "object" }, + "V20PresentationSendRequestToProposal": { + "properties": { + "auto_remove": { + "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" + }, + "auto_verify": { + "description": "Verifier choice to auto-verify proof presentation", + "example": false, + "type": "boolean" + }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "VCRecord": { + "properties": { + "contexts": { + "items": { + "description": "Context", + "example": "https://myhost:8021", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + }, + "type": "array" + }, + "cred_tags": { + "additionalProperties": { + "description": "Retrieval tag value", + "type": "string" + }, + "type": "object" + }, + "cred_value": { + "description": "(JSON-serializable) credential value", + "type": "object" + }, + "expanded_types": { + "items": { + "description": "JSON-LD expanded type extracted from type and context", + "example": "https://w3id.org/citizenship#PermanentResidentCard", + "type": "string" + }, + "type": "array" + }, + "given_id": { + "description": "Credential identifier", + "example": "http://example.edu/credentials/3732", + "type": "string" + }, + "issuer_id": { + "description": "Issuer identifier", + "example": "https://example.edu/issuers/14", + "type": "string" + }, + "proof_types": { + "items": { + "description": "Signature suite used for proof", + "example": "Ed25519Signature2018", + "type": "string" + }, + "type": "array" + }, + "record_id": { + "description": "Record identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "schema_ids": { + "items": { + "description": "Schema identifier", + "example": "https://example.org/examples/degree.json", + "type": "string" + }, + "type": "array" + }, + "subject_ids": { + "items": { + "description": "Subject identifier", + "example": "did:example:ebfeb1f712ebc6f1c276e12ec21", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "VCRecordList": { + "properties": { + "results": { + "items": { "$ref": "#/definitions/VCRecord" }, + "type": "array" + } + }, + "type": "object" + }, + "VerifyRequest": { + "properties": { + "doc": { + "allOf": [{ "$ref": "#/definitions/SignedDoc" }], + "description": "Signed document" + }, + "verkey": { + "description": "Verkey to use for doc verification", + "type": "string" + } + }, + "required": ["doc"], + "type": "object" + }, + "VerifyResponse": { + "properties": { + "error": { "description": "Error text", "type": "string" }, + "valid": { "type": "boolean" } + }, + "required": ["valid"], + "type": "object" + }, + "W3CCredentialsListRequest": { + "properties": { + "contexts": { + "items": { + "description": "Credential context to match", + "example": "https://myhost:8021", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + }, + "type": "array" + }, + "given_id": { + "description": "Given credential id to match", + "type": "string" + }, + "issuer_id": { + "description": "Credential issuer identifier to match", + "type": "string" + }, + "max_results": { + "description": "Maximum number of results to return", + "format": "int32", + "type": "integer" + }, + "proof_types": { + "items": { + "description": "Signature suite used for proof", + "example": "Ed25519Signature2018", + "type": "string" + }, + "type": "array" + }, + "schema_ids": { + "description": "Schema identifiers, all of which to match", + "items": { + "description": "Credential schema identifier", + "example": "https://myhost:8021", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + }, + "type": "array" + }, + "subject_ids": { + "description": "Subject identifiers, all of which to match", + "items": { "description": "Subject identifier", "type": "string" }, + "type": "array" + }, + "tag_query": { + "additionalProperties": { + "description": "Tag value", + "type": "string" + }, + "description": "Tag filter", + "type": "object" + }, + "types": { + "items": { + "description": "Credential type to match", + "example": "https://myhost:8021", + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "WalletList": { + "properties": { + "results": { + "description": "List of wallet records", + "items": { "$ref": "#/definitions/WalletRecord" }, + "type": "array" + } + }, + "type": "object" + }, + "WalletModuleResponse": { "properties": {}, "type": "object" }, + "WalletRecord": { + "properties": { + "created_at": { + "description": "Time of record creation", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "key_management_mode": { + "description": "Mode regarding management of wallet key", + "enum": ["managed", "unmanaged"], + "type": "string" + }, + "settings": { + "description": "Settings for this wallet.", + "type": "object" + }, + "state": { + "description": "Current record state", + "example": "active", + "type": "string" + }, + "updated_at": { + "description": "Time of last record update", + "example": "2021-12-31T23:59:59Z", + "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type": "string" + }, + "wallet_id": { + "description": "Wallet record ID", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + } + }, + "required": ["key_management_mode", "wallet_id"], + "type": "object" + }, + "WriteLedger": { + "properties": { "ledger_id": { "type": "string" } }, + "type": "object" + } + }, + "securityDefinitions": { + "AuthorizationHeader": { + "type": "apiKey", + "in": "header", + "name": "Authorization", + "description": "Bearer token. Be sure to preprend token with 'Bearer '" + } + }, + "security": [{ "AuthorizationHeader": [] }], + "tags": [ + { + "name": "action-menu", + "description": "Menu interaction over connection" + }, + { + "name": "basicmessage", + "description": "Simple messaging", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0095-basic-message" + } + }, + { + "name": "connection", + "description": "Connection management", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/9b0aaa39df7e8bd434126c4b33c097aae78d65bf/features/0160-connection-protocol" + } + }, + { + "name": "credential-definition", + "description": "Credential definition operations", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#cred_def" + } + }, + { + "name": "credentials", + "description": "Holder credential management", + "externalDocs": { + "description": "Overview", + "url": "https://w3c.github.io/vc-data-model/#credentials" + } + }, + { + "name": "did-exchange", + "description": "Connection management via DID exchange", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/25464a5c8f8a17b14edaa4310393df6094ace7b0/features/0023-did-exchange" + } + }, + { + "name": "discover-features", + "description": "Feature discovery", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0031-discover-features" + } + }, + { + "name": "discover-features v2.0", + "description": "Feature discovery v2", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0557-discover-features-v2" + } + }, + { "name": "endorse-transaction", "description": "Endorse a Transaction" }, + { "name": "introduction", "description": "Introduction of known parties" }, + { + "name": "issue-credential v1.0", + "description": "Credential issue v1.0", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/bb42a6c35e0d5543718fb36dd099551ab192f7b0/features/0036-issue-credential" + } + }, + { + "name": "issue-credential v2.0", + "description": "Credential issue v2.0", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/cd27fc64aa2805f756a118043d7c880354353047/features/0453-issue-credential-v2" + } + }, + { + "name": "jsonld", + "description": "Sign and verify json-ld data", + "externalDocs": { + "description": "Specification", + "url": "https://tools.ietf.org/html/rfc7515" + } + }, + { + "name": "ledger", + "description": "Interaction with ledger", + "externalDocs": { + "description": "Overview", + "url": "https://hyperledger-indy.readthedocs.io/projects/plenum/en/latest/storage.html#ledger" + } + }, + { + "name": "mediation", + "description": "Mediation management", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/fa8dc4ea1e667eb07db8f9ffeaf074a4455697c0/features/0211-route-coordination" + } + }, + { "name": "multitenancy", "description": "Multitenant wallet management" }, + { + "name": "out-of-band", + "description": "Out-of-band connections", + "externalDocs": { + "description": "Design", + "url": "https://github.com/hyperledger/aries-rfcs/tree/2da7fc4ee043effa3a9960150e7ba8c9a4628b68/features/0434-outofband" + } + }, + { + "name": "present-proof v1.0", + "description": "Proof presentation v1.0", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/4fae574c03f9f1013db30bf2c0c676b1122f7149/features/0037-present-proof" + } + }, + { + "name": "present-proof v2.0", + "description": "Proof presentation v2.0", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/eace815c3e8598d4a8dd7881d8c731fdb2bcc0aa/features/0454-present-proof-v2" + } + }, + { + "name": "resolver", + "description": "did resolver interface.", + "externalDocs": { "description": "Specification" } + }, + { + "name": "revocation", + "description": "Revocation registry management", + "externalDocs": { + "description": "Overview", + "url": "https://github.com/hyperledger/indy-hipe/tree/master/text/0011-cred-revocation" + } + }, + { + "name": "schema", + "description": "Schema operations", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#schema" + } + }, + { "name": "settings", "description": "Agent settings interface." }, + { + "name": "trustping", + "description": "Trust-ping over connection", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0048-trust-ping" + } + }, + { + "name": "wallet", + "description": "DID and tag policy management", + "externalDocs": { + "description": "Design", + "url": "https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage" + } + } + ] +} diff --git a/generator/scripts/convert-to-openapi3-local.sh b/generator/scripts/convert-to-openapi3-local.sh index 38765267..d81a8e94 100755 --- a/generator/scripts/convert-to-openapi3-local.sh +++ b/generator/scripts/convert-to-openapi3-local.sh @@ -5,7 +5,7 @@ CONTAINER_RUNTIME=${CONTAINER_RUNTIME:-docker} CONTAINER_NAME=openapi-converter -${CONTAINER_RUNTIME} run --rm -d -p 8080:8080 --name ${CONTAINER_NAME} swaggerapi/swagger-converter:v1.0.2 +${CONTAINER_RUNTIME} run --rm -d -p 8080:8080 --name ${CONTAINER_NAME} swaggerapi/swagger-converter:v1.0.5 trap '${CONTAINER_RUNTIME} stop ${CONTAINER_NAME}' EXIT while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:8080)" != "200" ]];do echo "Converter not yet ready..." diff --git a/generator/scripts/generate-client.sh b/generator/scripts/generate-client.sh index 5c5dae95..b8689a09 100755 --- a/generator/scripts/generate-client.sh +++ b/generator/scripts/generate-client.sh @@ -6,8 +6,8 @@ cd "$(dirname "$0")/../" || exit # Remove old generated code rm -rf ../generated/ -# Read ACA_PY_VERSION from input arg or default to 0.9.0 -ACA_PY_VERSION=${1:-"0.9.0"} +# Read ACA_PY_VERSION from input arg or default to 0.11.0 +ACA_PY_VERSION=${1:-"0.11.0"} export ACA_PY_VERSION # Set env for openapi-config-template' diff --git a/setup.py b/setup.py index 2dc5cd80..59a06b08 100644 --- a/setup.py +++ b/setup.py @@ -19,7 +19,7 @@ def parse_requirements(filename: str): if __name__ == "__main__": setup( name=PACKAGE_NAME, - version="0.11.0-rev4", + version="0.11.0-rev5", description="A simple python client for controlling an ACA-Py agent", long_description=long_description, long_description_content_type="text/markdown",