From 4b8d99397506ea1979dbda4182ddbf7f1aaae971 Mon Sep 17 00:00:00 2001 From: ff137 Date: Tue, 23 Apr 2024 14:40:19 +0200 Subject: [PATCH] :art: latest openapi specs --- generator/data/openapi.yml | 2662 +++- generator/data/swagger.json | 26088 ++++++++++++++++++++-------------- 2 files changed, 17862 insertions(+), 10888 deletions(-) diff --git a/generator/data/openapi.yml b/generator/data/openapi.yml index 93f83bc1..ebc1cb82 100644 --- a/generator/data/openapi.yml +++ b/generator/data/openapi.yml @@ -9,6 +9,21 @@ security: tags: - name: action-menu description: Menu interaction over connection +- name: anoncreds - credential definitions + description: Anoncreds credential definition management + externalDocs: + description: Specification + url: https://hyperledger.github.io/anoncreds-spec +- name: anoncreds - revocation + description: Revocation registry management + externalDocs: + description: Overview + url: https://github.com/hyperledger/indy-hipe/tree/master/text/0011-cred-revocation +- name: anoncreds - schemas + description: Anoncreds schema management + externalDocs: + description: Specification + url: https://hyperledger.github.io/anoncreds-spec - name: basicmessage description: Simple messaging externalDocs: @@ -34,6 +49,11 @@ tags: externalDocs: description: Specification url: https://github.com/hyperledger/aries-rfcs/tree/25464a5c8f8a17b14edaa4310393df6094ace7b0/features/0023-did-exchange +- name: did-rotate + description: Rotate a DID + externalDocs: + description: Specification + url: https://github.com/hyperledger/aries-rfcs/tree/main/features/0794-did-rotate - name: discover-features description: Feature discovery externalDocs: @@ -93,8 +113,8 @@ tags: - name: resolver description: did resolver interface. externalDocs: - description: Specification - url: https://example.com/replace/me + description: DID Resolution Specification + url: https://www.w3.org/TR/did-core/#resolution - name: revocation description: Revocation registry management externalDocs: @@ -133,6 +153,8 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string responses: @@ -151,35 +173,633 @@ paths: parameters: - name: conn_id in: path - description: Connection identifier + description: Connection identifier + required: true + style: simple + explode: false + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ActionMenuFetchResult' + operationId: fetch_active_menu + /action-menu/{conn_id}/perform: + post: + tags: + - action-menu + summary: Perform an action associated with the active menu + parameters: + - name: conn_id + in: path + description: Connection identifier + required: true + style: simple + explode: false + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PerformRequest' + required: false + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ActionMenuModulesResult' + x-codegen-request-body-name: body + operationId: perform_action + /action-menu/{conn_id}/request: + post: + tags: + - action-menu + summary: Request the active menu + parameters: + - name: conn_id + in: path + description: Connection identifier + required: true + style: simple + explode: false + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ActionMenuModulesResult' + operationId: request_active_menu + /action-menu/{conn_id}/send-menu: + post: + tags: + - action-menu + summary: Send an action menu to a connection + parameters: + - name: conn_id + in: path + description: Connection identifier + required: true + style: simple + explode: false + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendMenu' + required: false + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/ActionMenuModulesResult' + x-codegen-request-body-name: body + operationId: send_menu + /anoncreds/credential-definition: + post: + tags: + - anoncreds - credential definitions + summary: Create a credential definition on the connected ledger + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CredDefPostRequest' + required: false + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CredDefResult' + x-codegen-request-body-name: body + operationId: create_credential_definition + /anoncreds/credential-definition/{cred_def_id}: + get: + tags: + - anoncreds - credential definitions + summary: Retrieve an individual credential definition details + parameters: + - name: cred_def_id + in: path + description: Credential definition identifier + required: true + style: simple + explode: false + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/GetCredDefResult' + operationId: get_credential_definition + /anoncreds/credential-definitions: + get: + tags: + - anoncreds - credential definitions + summary: Retrieve all credential definition ids + parameters: + - name: issuer_id + in: query + description: Issuer Identifier of the credential definition + required: false + style: form + explode: true + schema: + type: string + - name: schema_id + in: query + description: Schema identifier + required: false + style: form + explode: true + schema: + type: string + - name: schema_name + in: query + description: Schema name + required: false + style: form + explode: true + schema: + type: string + - name: schema_version + in: query + description: Schema version + required: false + style: form + explode: true + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/GetCredDefsResponse' + operationId: get_credential_definitions + /anoncreds/registry/{rev_reg_id}/active: + put: + tags: + - anoncreds - revocation + summary: Update the active registry + parameters: + - name: rev_reg_id + in: path + description: Revocation Registry identifier + required: true + style: simple + explode: false + schema: + 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': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevocationModuleResponse' + operationId: set_active_registry + /anoncreds/registry/{rev_reg_id}/tails-file: + put: + tags: + - anoncreds - revocation + summary: Upload local tails file to server + parameters: + - name: rev_reg_id + in: path + description: Revocation Registry identifier + required: true + style: simple + explode: false + schema: + 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': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevocationModuleResponse' + operationId: upload_tails_file + /anoncreds/revocation-list: + post: + tags: + - anoncreds - revocation + summary: Create and publish a revocation status list on the connected ledger + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RevListCreateRequest' + required: false + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevListResult' + x-codegen-request-body-name: body + operationId: post_revocation_list + /anoncreds/revocation-registry-definition: + post: + tags: + - anoncreds - revocation + summary: Create and publish a registration revocation on the connected ledger + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RevRegCreateRequestSchemaAnoncreds' + required: false + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevRegDefResult' + x-codegen-request-body-name: body + operationId: create_rev_reg_definition + /anoncreds/revocation/active-registry/{cred_def_id}: + get: + tags: + - anoncreds - revocation + summary: Get current active revocation registry by credential definition id + parameters: + - name: cred_def_id + in: path + description: Credential definition identifier + required: true + style: simple + explode: false + schema: + pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevRegResultSchemaAnoncreds' + operationId: get_active_revocation_registry + /anoncreds/revocation/active-registry/{cred_def_id}/rotate: + post: + tags: + - anoncreds - revocation + summary: Rotate revocation registry + parameters: + - name: cred_def_id + in: path + description: Credential definition identifier + required: true + style: simple + explode: false + schema: + pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevRegsCreatedSchemaAnoncreds' + operationId: rotate_active_revocation_registry + /anoncreds/revocation/credential-record: + get: + tags: + - anoncreds - revocation + summary: Get credential revocation status + parameters: + - name: cred_ex_id + in: query + description: Credential exchange identifier + required: false + style: form + explode: true + schema: + 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 + - name: cred_rev_id + in: query + description: Credential revocation identifier + required: false + style: form + explode: true + schema: + pattern: ^[1-9][0-9]*$ + type: string + - name: rev_reg_id + in: query + description: Revocation registry identifier + required: false + style: form + explode: true + schema: + 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': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CredRevRecordResult' + operationId: get_cred_rev_record + /anoncreds/revocation/publish-revocations: + post: + tags: + - anoncreds - revocation + summary: Publish pending revocations to ledger + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PublishRevocations' + required: false + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/PublishRevocationsResult' + x-codegen-request-body-name: body + operationId: publish_revocations + /anoncreds/revocation/registries: + get: + tags: + - anoncreds - revocation + summary: Search for matching revocation registries that current agent created + parameters: + - name: cred_def_id + in: query + description: Credential definition identifier + required: false + style: form + explode: true + schema: + pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ + type: string + - name: state + in: query + description: Revocation registry state + required: false + style: form + explode: true + schema: + type: string + enum: + - finished + - failed + - action + - wait + - decommissioned + - full + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevRegsCreatedSchemaAnoncreds' + operationId: get_revocation_registries + /anoncreds/revocation/registry/{rev_reg_id}: + get: + tags: + - anoncreds - revocation + summary: Get revocation registry by revocation registry id + parameters: + - name: rev_reg_id + in: path + description: Revocation Registry identifier + required: true + style: simple + explode: false + schema: + 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': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevRegResultSchemaAnoncreds' + operationId: get_revocation_registry + /anoncreds/revocation/registry/{rev_reg_id}/fix-revocation-entry-state: + put: + tags: + - anoncreds - revocation + summary: Fix revocation state in wallet and return number of updated entries + parameters: + - name: rev_reg_id + in: path + description: Revocation Registry identifier + required: true + style: simple + explode: false + schema: + pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) + type: string + - name: apply_ledger_update + in: query + description: Apply updated accumulator transaction to ledger + required: true + style: form + explode: true + schema: + type: boolean + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevRegWalletUpdatedResultSchemaAnoncreds' + operationId: update_rev_reg_revoked_state + /anoncreds/revocation/registry/{rev_reg_id}/issued: + get: + tags: + - anoncreds - revocation + summary: Get number of credentials issued against revocation registry + parameters: + - name: rev_reg_id + in: path + description: Revocation Registry identifier + required: true + style: simple + explode: false + schema: + 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': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevRegIssuedResultSchemaAnoncreds' + operationId: get_rev_reg_issued_count + /anoncreds/revocation/registry/{rev_reg_id}/issued/details: + get: + tags: + - anoncreds - revocation + summary: Get details of credentials issued against revocation registry + parameters: + - name: rev_reg_id + in: path + description: Revocation Registry identifier + required: true + style: simple + explode: false + schema: + 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': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CredRevRecordDetailsResultSchemaAnoncreds' + operationId: get_rev_reg_issued_details + /anoncreds/revocation/registry/{rev_reg_id}/issued/indy_recs: + get: + tags: + - anoncreds - revocation + summary: Get details of revoked credentials from ledger + parameters: + - name: rev_reg_id + in: path + description: Revocation Registry identifier + required: true + style: simple + explode: false + schema: + 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': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CredRevIndyRecordsResultSchemaAnoncreds' + operationId: get_rev_reg_issued_indy_recs + /anoncreds/revocation/registry/{rev_reg_id}/set-state: + patch: + tags: + - anoncreds - revocation + summary: Set revocation registry state manually + parameters: + - name: rev_reg_id + in: path + description: Revocation Registry identifier + required: true + style: simple + explode: false + schema: + pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) + type: string + - name: state + in: query + description: Revocation registry state to set + required: true + style: form + explode: true + schema: + type: string + enum: + - finished + - failed + - action + - wait + - decommissioned + - full + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevRegResultSchemaAnoncreds' + operationId: set_rev_reg_state + /anoncreds/revocation/registry/{rev_reg_id}/tails-file: + get: + tags: + - anoncreds - revocation + summary: Download tails file + parameters: + - name: rev_reg_id + in: path + description: Revocation Registry identifier required: true + style: simple + explode: false schema: + 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': + description: tails file + content: + application/octet-stream: + schema: + $ref: '#/components/schemas/RevocationAnoncredsModuleResponse' + operationId: get_tails_file + /anoncreds/revocation/revoke: + post: + tags: + - anoncreds - revocation + summary: Revoke an issued credential + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RevokeRequestSchemaAnoncreds' + required: false responses: '200': description: '' content: application/json: schema: - $ref: '#/components/schemas/ActionMenuFetchResult' - operationId: fetch_active_menu - /action-menu/{conn_id}/perform: + $ref: '#/components/schemas/RevocationAnoncredsModuleResponse' + x-codegen-request-body-name: body + operationId: revoke + /anoncreds/schema: post: tags: - - action-menu - summary: Perform an action associated with the active menu - parameters: - - name: conn_id - in: path - description: Connection identifier - required: true - schema: - type: string + - anoncreds - schemas + summary: Create a schema on the connected ledger requestBody: content: application/json: schema: - $ref: '#/components/schemas/PerformRequest' + $ref: '#/components/schemas/SchemaPostRequest' required: false responses: '200': @@ -187,19 +807,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ActionMenuModulesResult' + $ref: '#/components/schemas/SchemaResult' x-codegen-request-body-name: body - operationId: perform_action - /action-menu/{conn_id}/request: - post: + operationId: create_schema + /anoncreds/schema/{schema_id}: + get: tags: - - action-menu - summary: Request the active menu + - anoncreds - schemas + summary: Retrieve an individual schemas details parameters: - - name: conn_id + - name: schema_id in: path - description: Connection identifier + description: Schema identifier required: true + style: simple + explode: false schema: type: string responses: @@ -208,35 +830,46 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ActionMenuModulesResult' - operationId: request_active_menu - /action-menu/{conn_id}/send-menu: - post: + $ref: '#/components/schemas/GetSchemaResult' + operationId: get_schema + /anoncreds/schemas: + get: tags: - - action-menu - summary: Send an action menu to a connection + - anoncreds - schemas + summary: Retrieve all schema ids parameters: - - name: conn_id - in: path - description: Connection identifier - required: true + - name: schema_issuer_id + in: query + description: Schema issuer identifier + required: false + style: form + explode: true schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SendMenu' + - name: schema_name + in: query + description: Schema name required: false + style: form + explode: true + schema: + type: string + - name: schema_version + in: query + description: Schema version + required: false + style: form + explode: true + schema: + type: string responses: '200': description: '' content: application/json: schema: - $ref: '#/components/schemas/ActionMenuModulesResult' - x-codegen-request-body-name: body - operationId: send_menu + $ref: '#/components/schemas/GetSchemasResponse' + operationId: get_schemas /connections: get: tags: @@ -246,64 +879,91 @@ paths: - name: alias in: query description: Alias + required: false + style: form + explode: true schema: type: string - name: connection_protocol in: query description: Connection protocol used + required: false + style: form + explode: true schema: type: string enum: - connections/1.0 - didexchange/1.0 + - didexchange/1.1 - name: invitation_key in: query description: invitation key + required: false + style: form + explode: true schema: pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$ type: string - name: invitation_msg_id in: query - description: Identifier of the associated Invitation Mesage + description: Identifier of the associated Invitation Message + required: false + style: form + explode: true schema: type: string - format: uuid - name: my_did in: query description: My DID + required: false + style: form + explode: true schema: 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 - name: state in: query description: Connection state + required: false + style: form + explode: true schema: type: string enum: - - invitation - - start - - init - abandoned - active - - request - - response - completed - error + - init + - invitation + - request + - response + - start - name: their_did in: query description: Their DID + required: false + style: form + explode: true schema: 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 - name: their_public_did in: query description: Their Public DID + required: false + style: form + explode: true schema: 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 - name: their_role in: query description: Their role in the connection protocol + required: false + style: form + explode: true schema: type: string enum: @@ -328,21 +988,33 @@ paths: - name: alias in: query description: Alias + required: false + style: form + explode: true schema: type: string - name: auto_accept in: query description: Auto-accept connection (defaults to configuration) + required: false + style: form + explode: true schema: type: boolean - name: multi_use in: query description: Create invitation for multiple use (default false) + required: false + style: form + explode: true schema: type: boolean - name: public in: query description: Create invitation from public DID (default false) + required: false + style: form + explode: true schema: type: boolean requestBody: @@ -358,6 +1030,7 @@ paths: application/json: schema: $ref: '#/components/schemas/InvitationResult' + deprecated: true x-codegen-request-body-name: body operationId: create_invitation /connections/create-static: @@ -389,16 +1062,25 @@ paths: - name: alias in: query description: Alias + required: false + style: form + explode: true schema: type: string - name: auto_accept in: query description: Auto-accept connection (defaults to configuration) + required: false + style: form + explode: true schema: type: boolean - name: mediation_id in: query description: Identifier for active mediation record to be used + required: false + style: form + explode: true schema: 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 @@ -415,6 +1097,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ConnRecord' + deprecated: true x-codegen-request-body-name: body operationId: receive_invitation /connections/{conn_id}: @@ -427,6 +1110,8 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string responses: @@ -446,6 +1131,8 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string responses: @@ -466,23 +1153,34 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string - name: mediation_id in: query description: Identifier for active mediation record to be used + required: false + style: form + explode: true schema: 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 - name: my_endpoint in: query description: My URL endpoint + required: false + style: form + explode: true schema: pattern: ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ type: string - name: my_label in: query description: Label for connection + required: false + style: form + explode: true schema: type: string responses: @@ -492,6 +1190,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ConnRecord' + deprecated: true operationId: accept_invitation /connections/{conn_id}/accept-request: post: @@ -503,11 +1202,16 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string - name: my_endpoint in: query description: My URL endpoint + required: false + style: form + explode: true schema: pattern: ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ type: string @@ -518,6 +1222,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ConnRecord' + deprecated: true operationId: accept_request /connections/{conn_id}/endpoints: get: @@ -529,6 +1234,8 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string responses: @@ -549,11 +1256,16 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string - name: key in: query description: Key to retrieve. + required: false + style: form + explode: true schema: type: string responses: @@ -573,6 +1285,8 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string requestBody: @@ -600,6 +1314,8 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string requestBody: @@ -627,6 +1343,8 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string requestBody: @@ -654,17 +1372,24 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string - name: target_connection_id in: query description: Target connection identifier required: true + style: form + explode: true schema: type: string - name: message in: query description: Message + required: false + style: form + explode: true schema: type: string responses: @@ -684,11 +1409,17 @@ paths: - name: conn_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string - name: create_transaction_for_endorser in: query description: Create Transaction For Endorser's signature + required: false + style: form + explode: true schema: type: boolean requestBody: @@ -715,35 +1446,53 @@ paths: - name: cred_def_id in: query description: Credential definition id + required: false + style: form + explode: true schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ type: string - name: issuer_did in: query description: Issuer DID + required: false + style: form + explode: true schema: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string - name: schema_id in: query description: Schema identifier + required: false + style: form + explode: true schema: pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$ type: string - name: schema_issuer_did in: query description: Schema issuer DID + required: false + style: form + explode: true schema: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string - name: schema_name in: query description: Schema name + required: false + style: form + explode: true schema: type: string - name: schema_version in: query description: Schema version + required: false + style: form + explode: true schema: pattern: ^[0-9.]+$ type: string @@ -765,6 +1514,8 @@ paths: in: path description: Credential definition identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ type: string @@ -786,6 +1537,8 @@ paths: in: path description: Credential definition identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ type: string @@ -796,6 +1549,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CredentialDefinitionGetResult' + operationId: fix_cred_def_wallet_record /credential/mime-types/{credential_id}: get: tags: @@ -806,6 +1560,8 @@ paths: in: path description: Credential identifier required: true + style: simple + explode: false schema: type: string responses: @@ -826,17 +1582,25 @@ paths: in: path description: Credential identifier required: true + style: simple + explode: false schema: type: string - name: from in: query description: Earliest epoch of revocation status interval of interest + required: false + style: form + explode: true schema: pattern: ^[0-9]*$ type: string - name: to in: query description: Latest epoch of revocation status interval of interest + required: false + style: form + explode: true schema: pattern: ^[0-9]*$ type: string @@ -858,6 +1622,8 @@ paths: in: path description: Credential identifier required: true + style: simple + explode: false schema: type: string responses: @@ -877,6 +1643,8 @@ paths: in: path description: Credential identifier required: true + style: simple + explode: false schema: type: string responses: @@ -897,6 +1665,8 @@ paths: in: path description: Credential identifier required: true + style: simple + explode: false schema: type: string responses: @@ -916,6 +1686,8 @@ paths: in: path description: Credential identifier required: true + style: simple + explode: false schema: type: string responses: @@ -935,18 +1707,27 @@ paths: - name: count in: query description: Maximum number to retrieve + required: false + style: form + explode: true schema: pattern: ^[1-9][0-9]*$ type: string - name: start in: query description: Start index + required: false + style: form + explode: true schema: pattern: ^[0-9]*$ type: string - name: wql in: query description: (JSON) WQL query + required: false + style: form + explode: true schema: pattern: ^{.*}$ type: string @@ -967,18 +1748,27 @@ paths: - name: count in: query description: Maximum number to retrieve + required: false + style: form + explode: true schema: pattern: ^[1-9][0-9]*$ type: string - name: start in: query description: Start index + required: false + style: form + explode: true schema: pattern: ^[0-9]*$ type: string - name: wql in: query description: (JSON) WQL query + required: false + style: form + explode: true schema: pattern: ^{.*}$ type: string @@ -997,6 +1787,57 @@ paths: $ref: '#/components/schemas/VCRecordList' x-codegen-request-body-name: body operationId: get_w3c_credentials + /did-rotate/{conn_id}/hangup: + post: + tags: + - did-rotate + summary: Send hangup of DID rotation as a rotator + parameters: + - name: conn_id + in: path + description: Connection identifier + required: true + style: simple + explode: false + schema: + type: string + responses: + '200': + description: Hangup agent message for observer + content: + application/json: + schema: + $ref: '#/components/schemas/Hangup' + operationId: hangup + /did-rotate/{conn_id}/rotate: + post: + tags: + - did-rotate + summary: Begin rotation of a DID as a rotator + parameters: + - name: conn_id + in: path + description: Connection identifier + required: true + style: simple + explode: false + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DIDRotateRequestJSON' + required: false + responses: + '200': + description: Rotate agent message for observer + content: + application/json: + schema: + $ref: '#/components/schemas/Rotate' + x-codegen-request-body-name: body + operationId: rotate /didexchange/create-request: post: tags: @@ -1007,46 +1848,107 @@ paths: in: query description: Qualified public DID to which to request connection required: true + style: form + explode: true schema: 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 - name: alias in: query description: Alias for connection + required: false + style: form + explode: true schema: type: string + - name: auto_accept + in: query + description: Auto-accept connection (defaults to configuration) + required: false + style: form + explode: true + schema: + type: boolean - name: goal in: query 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 + required: false + style: form + explode: true schema: type: string - name: goal_code in: query 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 + required: false + style: form + explode: true schema: type: string - name: mediation_id in: query description: Identifier for active mediation record to be used + required: false + style: form + explode: true schema: 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 - name: my_endpoint in: query description: My URL endpoint + required: false + style: form + explode: true schema: pattern: ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ type: string - name: my_label in: query description: Label for connection request + required: false + style: form + explode: true + schema: + type: string + - name: protocol + in: query + description: Which DID Exchange Protocol version to use + required: false + style: form + explode: true + schema: + type: string + enum: + - didexchange/1.0 + - didexchange/1.1 + - name: use_did + in: query + description: The DID to use to for this connection + required: false + style: form + explode: true + schema: + type: string + - name: use_did_method + in: query + description: The DID method to use to generate a DID for this connection + required: false + style: form + explode: true schema: type: string + enum: + - did:peer:2 + - did:peer:4 - name: use_public_did in: query description: Use public DID for this connection + required: false + style: form + explode: true schema: type: boolean responses: @@ -1066,22 +1968,34 @@ paths: - name: alias in: query description: Alias for connection + required: false + style: form + explode: true schema: type: string - name: auto_accept in: query description: Auto-accept connection (defaults to configuration) + required: false + style: form + explode: true schema: type: boolean - name: mediation_id in: query description: Identifier for active mediation record to be used + required: false + style: form + explode: true schema: 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 - name: my_endpoint in: query description: My URL endpoint + required: false + style: form + explode: true schema: pattern: ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ type: string @@ -1098,6 +2012,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ConnRecord' + deprecated: true x-codegen-request-body-name: body operationId: receive_request /didexchange/{conn_id}/accept-invitation: @@ -1110,19 +2025,46 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string - name: my_endpoint in: query description: My URL endpoint + required: false + style: form + explode: true schema: pattern: ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ type: string - name: my_label in: query description: Label for connection request + required: false + style: form + explode: true + schema: + type: string + - name: use_did + in: query + description: The DID to use to for this connection + required: false + style: form + explode: true + schema: + type: string + - name: use_did_method + in: query + description: The DID method to use to generate a DID for this connection + required: false + style: form + explode: true schema: type: string + enum: + - did:peer:2 + - did:peer:4 responses: '200': description: '' @@ -1141,23 +2083,34 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string - name: mediation_id in: query description: Identifier for active mediation record to be used + required: false + style: form + explode: true schema: 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 - name: my_endpoint in: query description: My URL endpoint + required: false + style: form + explode: true schema: pattern: ^[A-Za-z0-9\.\-\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$ type: string - name: use_public_did in: query description: Use public DID for this connection + required: false + style: form + explode: true schema: type: boolean responses: @@ -1178,6 +2131,8 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string requestBody: @@ -1194,6 +2149,7 @@ paths: schema: $ref: '#/components/schemas/ConnRecord' x-codegen-request-body-name: body + operationId: reject /discover-features-2.0/queries: get: tags: @@ -1204,16 +2160,25 @@ paths: in: query description: Connection identifier, if none specified, then the query will provide features for this agent. + required: false + style: form + explode: true schema: type: string - name: query_goal_code in: query description: Goal-code feature-type query + required: false + style: form + explode: true schema: type: string - name: query_protocol in: query description: Protocol feature-type query + required: false + style: form + explode: true schema: type: string responses: @@ -1223,6 +2188,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V20DiscoveryExchangeResult' + operationId: query_features /discover-features-2.0/records: get: tags: @@ -1232,6 +2198,9 @@ paths: - name: connection_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string responses: @@ -1241,6 +2210,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V20DiscoveryExchangeListResult' + operationId: query_records /discover-features/query: get: tags: @@ -1250,17 +2220,26 @@ paths: - name: comment in: query description: Comment + required: false + style: form + explode: true schema: type: string - name: connection_id in: query description: Connection identifier, if none specified, then the query will provide features for this agent. + required: false + style: form + explode: true schema: type: string - name: query in: query description: Protocol feature query + required: false + style: form + explode: true schema: type: string responses: @@ -1270,6 +2249,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10DiscoveryRecord' + operationId: query_features /discover-features/records: get: tags: @@ -1279,6 +2259,9 @@ paths: - name: connection_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string responses: @@ -1288,6 +2271,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10DiscoveryExchangeListResult' + operationId: query_records /issue-credential-2.0/create: post: tags: @@ -1328,6 +2312,7 @@ paths: schema: $ref: '#/components/schemas/V20CredExRecord' x-codegen-request-body-name: body + operationId: create_offer /issue-credential-2.0/records: get: tags: @@ -1337,12 +2322,17 @@ paths: - name: connection_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string - format: uuid - name: role in: query description: Role assigned in credential exchange + required: false + style: form + explode: true schema: type: string enum: @@ -1351,6 +2341,9 @@ paths: - name: state in: query description: Credential exchange state + required: false + style: form + explode: true schema: type: string enum: @@ -1368,9 +2361,11 @@ paths: - name: thread_id in: query description: Thread identifier + required: false + style: form + explode: true schema: type: string - format: uuid responses: '200': description: '' @@ -1389,6 +2384,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1409,6 +2406,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1430,6 +2429,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1458,6 +2459,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1486,6 +2489,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1514,6 +2519,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1542,6 +2549,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1660,6 +2669,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10CredentialExchange' + deprecated: true x-codegen-request-body-name: body operationId: create_credential /issue-credential/create-offer: @@ -1680,6 +2690,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10CredentialExchange' + deprecated: true x-codegen-request-body-name: body operationId: create_offer /issue-credential/records: @@ -1691,12 +2702,17 @@ paths: - name: connection_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string - format: uuid - name: role in: query description: Role assigned in credential exchange + required: false + style: form + explode: true schema: type: string enum: @@ -1705,6 +2721,9 @@ paths: - name: state in: query description: Credential exchange state + required: false + style: form + explode: true schema: type: string enum: @@ -1722,9 +2741,11 @@ paths: - name: thread_id in: query description: Thread identifier + required: false + style: form + explode: true schema: type: string - format: uuid responses: '200': description: '' @@ -1732,6 +2753,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10CredentialExchangeListResult' + deprecated: true operationId: get_records /issue-credential/records/{cred_ex_id}: get: @@ -1743,6 +2765,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1753,6 +2777,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10CredentialExchange' + deprecated: true operationId: get_record delete: tags: @@ -1763,6 +2788,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1773,6 +2800,7 @@ paths: application/json: schema: $ref: '#/components/schemas/IssueCredentialModuleResponse' + deprecated: true operationId: delete_record /issue-credential/records/{cred_ex_id}/issue: post: @@ -1784,6 +2812,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1800,6 +2830,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10CredentialExchange' + deprecated: true x-codegen-request-body-name: body operationId: issue_credential /issue-credential/records/{cred_ex_id}/problem-report: @@ -1812,6 +2843,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1828,6 +2861,7 @@ paths: application/json: schema: $ref: '#/components/schemas/IssueCredentialModuleResponse' + deprecated: true x-codegen-request-body-name: body operationId: report_problem /issue-credential/records/{cred_ex_id}/send-offer: @@ -1840,6 +2874,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1856,6 +2892,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10CredentialExchange' + deprecated: true x-codegen-request-body-name: body operationId: send_offer /issue-credential/records/{cred_ex_id}/send-request: @@ -1868,6 +2905,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1884,6 +2923,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10CredentialExchange' + deprecated: true x-codegen-request-body-name: body operationId: send_request /issue-credential/records/{cred_ex_id}/store: @@ -1896,6 +2936,8 @@ paths: in: path description: Credential exchange identifier required: true + style: simple + explode: false schema: 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 @@ -1912,6 +2954,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10CredentialExchange' + deprecated: true x-codegen-request-body-name: body operationId: store_credential /issue-credential/send: @@ -1932,6 +2975,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10CredentialExchange' + deprecated: true x-codegen-request-body-name: body operationId: issue_credential_automated /issue-credential/send-offer: @@ -1952,6 +2996,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10CredentialExchange' + deprecated: true x-codegen-request-body-name: body operationId: send_offer_free /issue-credential/send-proposal: @@ -1972,6 +3017,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10CredentialExchange' + deprecated: true x-codegen-request-body-name: body operationId: send_proposal /jsonld/sign: @@ -1992,6 +3038,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SignResponse' + deprecated: true x-codegen-request-body-name: body operationId: sign /jsonld/verify: @@ -2012,6 +3059,7 @@ paths: application/json: schema: $ref: '#/components/schemas/VerifyResponse' + deprecated: true x-codegen-request-body-name: body operationId: verify /ledger/config: @@ -2026,6 +3074,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LedgerConfigList' + operationId: get_config /ledger/did-endpoint: get: tags: @@ -2036,12 +3085,17 @@ paths: in: query description: DID of interest required: true + style: form + explode: true schema: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string - name: endpoint_type in: query description: Endpoint type of interest (default 'Endpoint') + required: false + style: form + explode: true schema: type: string enum: @@ -2066,6 +3120,8 @@ paths: in: query description: DID of interest required: true + style: form + explode: true schema: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string @@ -2087,6 +3143,8 @@ paths: in: query description: DID of interest required: true + style: form + explode: true schema: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string @@ -2110,6 +3168,7 @@ paths: application/json: schema: $ref: '#/components/schemas/WriteLedger' + operationId: get_write_ledger /ledger/get-write-ledgers: get: tags: @@ -2122,6 +3181,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ConfigurableWriteLedgers' + operationId: get_write_ledgers /ledger/register-nym: post: tags: @@ -2132,6 +3192,8 @@ paths: in: query description: DID to register required: true + style: form + explode: true schema: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string @@ -2139,27 +3201,41 @@ paths: in: query description: Verification key required: true + style: form + explode: true schema: pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$ type: string - name: alias in: query description: Alias + required: false + style: form + explode: true schema: type: string - name: conn_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string - name: create_transaction_for_endorser in: query description: Create Transaction For Endorser's signature + required: false + style: form + explode: true schema: type: boolean - name: role in: query description: Role + required: false + style: form + explode: true schema: type: string enum: @@ -2231,6 +3307,8 @@ paths: - name: ledger_id in: path required: true + style: simple + explode: false schema: type: string responses: @@ -2240,6 +3318,7 @@ paths: application/json: schema: $ref: '#/components/schemas/WriteLedger' + operationId: set_write_ledger /mediation/default-mediator: get: tags: @@ -2274,13 +3353,18 @@ paths: - name: conn_id in: query description: Connection identifier (optional) + required: false + style: form + explode: true schema: type: string - format: uuid - name: role in: query - description: Filer on role, 'client' for keys mediated by other agents, - 'server' for keys mediated by this agent + description: Filer on role, 'client' for keys mediated by other agents, 'server' + for keys mediated by this agent + required: false + style: form + explode: true schema: type: string default: server @@ -2305,12 +3389,16 @@ paths: in: path description: Mediation record identifier required: true + style: simple + explode: false schema: type: string - format: uuid - name: paginate_limit in: query description: limit number of results + required: false + style: form + explode: true schema: type: integer format: int32 @@ -2318,6 +3406,9 @@ paths: - name: paginate_offset in: query description: offset to use in pagination + required: false + style: form + explode: true schema: type: integer format: int32 @@ -2347,9 +3438,10 @@ paths: in: path description: Mediation record identifier required: true + style: simple + explode: false schema: type: string - format: uuid requestBody: content: application/json: @@ -2375,6 +3467,8 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string requestBody: @@ -2401,12 +3495,17 @@ paths: - name: conn_id in: query description: Connection identifier (optional) + required: false + style: form + explode: true schema: type: string - format: uuid - name: state in: query description: Mediation state (optional) + required: false + style: form + explode: true schema: type: string enum: @@ -2431,9 +3530,10 @@ paths: in: path description: Mediation record identifier required: true + style: simple + explode: false schema: type: string - format: uuid responses: '200': description: '' @@ -2451,9 +3551,10 @@ paths: in: path description: Mediation record identifier required: true + style: simple + explode: false schema: type: string - format: uuid responses: '200': description: '' @@ -2472,9 +3573,10 @@ paths: in: path description: Mediation record identifier required: true + style: simple + explode: false schema: type: string - format: uuid requestBody: content: application/json: @@ -2500,9 +3602,10 @@ paths: in: path description: Mediation record identifier required: true + style: simple + explode: false schema: type: string - format: uuid responses: '201': description: '' @@ -2521,6 +3624,8 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string requestBody: @@ -2537,6 +3642,7 @@ paths: schema: $ref: '#/components/schemas/KeylistUpdate' x-codegen-request-body-name: body + operationId: update_keylist_for_connection /mediation/{mediation_id}/default-mediator: put: tags: @@ -2547,9 +3653,10 @@ paths: in: path description: Mediation record identifier required: true + style: simple + explode: false schema: type: string - format: uuid responses: '201': description: '' @@ -2588,6 +3695,8 @@ paths: in: path description: Subwallet identifier required: true + style: simple + explode: false schema: type: string responses: @@ -2607,6 +3716,8 @@ paths: in: path description: Subwallet identifier required: true + style: simple + explode: false schema: type: string requestBody: @@ -2634,6 +3745,8 @@ paths: in: path description: Subwallet identifier required: true + style: simple + explode: false schema: type: string requestBody: @@ -2660,6 +3773,8 @@ paths: - name: wallet_id in: path required: true + style: simple + explode: false schema: type: string requestBody: @@ -2686,6 +3801,9 @@ paths: - name: wallet_name in: query description: Wallet name + required: false + style: form + explode: true schema: type: string responses: @@ -2705,11 +3823,25 @@ paths: - name: auto_accept in: query description: Auto-accept connection (defaults to configuration) + required: false + style: form + explode: true + schema: + type: boolean + - name: create_unique_did + in: query + description: Create unique DID for this invitation (default false) + required: false + style: form + explode: true schema: type: boolean - name: multi_use in: query description: Create invitation for multiple use (default false) + required: false + style: form + explode: true schema: type: boolean requestBody: @@ -2724,9 +3856,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InvitationRecord' - x-codegen-request-body-name: body - operationId: create_invitation + $ref: '#/components/schemas/InvitationRecord' + x-codegen-request-body-name: body + operationId: create_invitation + /out-of-band/invitations/{invi_msg_id}: + delete: + tags: + - out-of-band + summary: Delete records associated with invitation + parameters: + - name: invi_msg_id + in: path + description: Invitation Message identifier + required: true + style: simple + explode: false + schema: + 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': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/InvitationRecordResponse' + operationId: remove_invitation_record /out-of-band/receive-invitation: post: tags: @@ -2736,22 +3891,34 @@ paths: - name: alias in: query description: Alias for connection + required: false + style: form + explode: true schema: type: string - name: auto_accept in: query description: Auto-accept connection (defaults to configuration) + required: false + style: form + explode: true schema: type: boolean - name: mediation_id in: query description: Identifier for active mediation record to be used + required: false + style: form + explode: true schema: 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 - name: use_existing_connection in: query description: Use an existing connection, if possible + required: false + style: form + explode: true schema: type: boolean requestBody: @@ -2811,12 +3978,17 @@ paths: - name: connection_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string - format: uuid - name: role in: query description: Role assigned in presentation exchange + required: false + style: form + explode: true schema: type: string enum: @@ -2825,6 +3997,9 @@ paths: - name: state in: query description: Presentation exchange state + required: false + style: form + explode: true schema: type: string enum: @@ -2839,9 +4014,11 @@ paths: - name: thread_id in: query description: Thread identifier + required: false + style: form + explode: true schema: type: string - format: uuid responses: '200': description: '' @@ -2860,6 +4037,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -2880,6 +4059,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -2901,29 +4082,43 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 - name: count in: query description: Maximum number to retrieve + required: false + style: form + explode: true schema: pattern: ^[1-9][0-9]*$ type: string - name: extra_query in: query description: (JSON) object mapping referents to extra WQL queries + required: false + style: form + explode: true schema: pattern: ^{\s*".*?"\s*:\s*{.*?}\s*(,\s*".*?"\s*:\s*{.*?}\s*)*\s*}$ type: string - name: referent in: query description: Proof request referents of interest, comma-separated + required: false + style: form + explode: true schema: type: string - name: start in: query description: Start index + required: false + style: form + explode: true schema: pattern: ^[0-9]*$ type: string @@ -2947,6 +4142,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -2975,6 +4172,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -3003,6 +4202,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -3031,6 +4232,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -3100,6 +4303,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10PresentationExchange' + deprecated: true x-codegen-request-body-name: body operationId: create_proof_request /present-proof/records: @@ -3111,12 +4315,17 @@ paths: - name: connection_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string - format: uuid - name: role in: query description: Role assigned in presentation exchange + required: false + style: form + explode: true schema: type: string enum: @@ -3125,6 +4334,9 @@ paths: - name: state in: query description: Presentation exchange state + required: false + style: form + explode: true schema: type: string enum: @@ -3140,9 +4352,11 @@ paths: - name: thread_id in: query description: Thread identifier + required: false + style: form + explode: true schema: type: string - format: uuid responses: '200': description: '' @@ -3150,6 +4364,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10PresentationExchangeList' + deprecated: true operationId: get_records /present-proof/records/{pres_ex_id}: get: @@ -3161,6 +4376,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -3171,6 +4388,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10PresentationExchange' + deprecated: true operationId: get_record delete: tags: @@ -3181,6 +4399,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -3191,6 +4411,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10PresentProofModuleResponse' + deprecated: true operationId: delete_record /present-proof/records/{pres_ex_id}/credentials: get: @@ -3202,29 +4423,43 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 - name: count in: query description: Maximum number to retrieve + required: false + style: form + explode: true schema: pattern: ^[1-9][0-9]*$ type: string - name: extra_query in: query description: (JSON) object mapping referents to extra WQL queries + required: false + style: form + explode: true schema: pattern: ^{\s*".*?"\s*:\s*{.*?}\s*(,\s*".*?"\s*:\s*{.*?}\s*)*\s*}$ type: string - name: referent in: query description: Proof request referents of interest, comma-separated + required: false + style: form + explode: true schema: type: string - name: start in: query description: Start index + required: false + style: form + explode: true schema: pattern: ^[0-9]*$ type: string @@ -3237,6 +4472,7 @@ paths: type: array items: $ref: '#/components/schemas/IndyCredPrecis' + deprecated: true operationId: get_matching_credentials /present-proof/records/{pres_ex_id}/problem-report: post: @@ -3248,6 +4484,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -3264,6 +4502,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10PresentProofModuleResponse' + deprecated: true x-codegen-request-body-name: body operationId: report_problem /present-proof/records/{pres_ex_id}/send-presentation: @@ -3276,6 +4515,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -3292,6 +4533,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10PresentationExchange' + deprecated: true x-codegen-request-body-name: body operationId: send_presentation /present-proof/records/{pres_ex_id}/send-request: @@ -3304,6 +4546,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -3320,6 +4564,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10PresentationExchange' + deprecated: true x-codegen-request-body-name: body operationId: send_request /present-proof/records/{pres_ex_id}/verify-presentation: @@ -3332,6 +4577,8 @@ paths: in: path description: Presentation exchange identifier required: true + style: simple + explode: false schema: 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 @@ -3342,6 +4589,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10PresentationExchange' + deprecated: true operationId: verify_presentation /present-proof/send-proposal: post: @@ -3361,6 +4609,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10PresentationExchange' + deprecated: true x-codegen-request-body-name: body operationId: send_proposal /present-proof/send-request: @@ -3381,6 +4630,7 @@ paths: application/json: schema: $ref: '#/components/schemas/V10PresentationExchange' + deprecated: true x-codegen-request-body-name: body operationId: send_request_free /resolver/resolve/{did}: @@ -3393,6 +4643,8 @@ paths: in: path description: DID required: true + style: simple + explode: false schema: pattern: ^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$ type: string @@ -3414,6 +4666,8 @@ paths: in: path description: Credential definition identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ type: string @@ -3435,6 +4689,8 @@ paths: in: path description: Credential definition identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ type: string @@ -3445,6 +4701,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RevRegsCreated' + operationId: rotate_rev_reg /revocation/clear-pending-revocations: post: tags: @@ -3462,7 +4719,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PublishRevocations' + $ref: '#/components/schemas/PublishRevocationsSchemaAnoncreds' x-codegen-request-body-name: body operationId: clear_pending_revocations /revocation/create-registry: @@ -3494,18 +4751,27 @@ paths: - name: cred_ex_id in: query description: Credential exchange identifier + required: false + style: form + explode: true schema: 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 - name: cred_rev_id in: query description: Credential revocation identifier + required: false + style: form + explode: true schema: pattern: ^[1-9][0-9]*$ type: string - name: rev_reg_id in: query description: Revocation registry identifier + required: false + style: form + explode: true schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string @@ -3515,18 +4781,35 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CredRevRecordResult' + $ref: '#/components/schemas/CredRevRecordResultSchemaAnoncreds' operationId: get_revocation_status /revocation/publish-revocations: post: tags: - revocation summary: Publish pending revocations to ledger + parameters: + - name: conn_id + in: query + description: Connection identifier + required: false + style: form + explode: true + schema: + type: string + - name: create_transaction_for_endorser + in: query + description: Create Transaction For Endorser's signature + required: false + style: form + explode: true + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/PublishRevocations' + $ref: '#/components/schemas/PublishRevocationsSchemaAnoncreds' required: false responses: '200': @@ -3546,12 +4829,18 @@ paths: - name: cred_def_id in: query description: Credential definition identifier + required: false + style: form + explode: true schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ type: string - name: state in: query description: Revocation registry state + required: false + style: form + explode: true schema: type: string enum: @@ -3578,12 +4867,18 @@ paths: - name: cred_def_id in: query description: Credential definition identifier + required: false + style: form + explode: true schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ type: string - name: rev_reg_id in: query description: Revocation registry identifier + required: false + style: form + explode: true schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string @@ -3594,6 +4889,7 @@ paths: application/json: schema: $ref: '#/components/schemas/TailsDeleteResponse' + operationId: delete_tails_file /revocation/registry/{rev_reg_id}: get: tags: @@ -3604,6 +4900,8 @@ paths: in: path description: Revocation Registry identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string @@ -3624,6 +4922,8 @@ paths: in: path description: Revocation Registry identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string @@ -3652,17 +4952,25 @@ paths: in: path description: Revocation Registry identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string - name: conn_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string - name: create_transaction_for_endorser in: query description: Create Transaction For Endorser's signature + required: false + style: form + explode: true schema: type: boolean responses: @@ -3683,17 +4991,25 @@ paths: in: path description: Revocation Registry identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string - name: conn_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string - name: create_transaction_for_endorser in: query description: Create Transaction For Endorser's signature + required: false + style: form + explode: true schema: type: boolean responses: @@ -3714,6 +5030,8 @@ paths: in: path description: Revocation Registry identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string @@ -3721,6 +5039,8 @@ paths: in: query description: Apply updated accumulator transaction to ledger required: true + style: form + explode: true schema: type: boolean responses: @@ -3730,6 +5050,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RevRegWalletUpdatedResult' + operationId: update_rev_reg_revoked_state /revocation/registry/{rev_reg_id}/issued: get: tags: @@ -3740,6 +5061,8 @@ paths: in: path description: Revocation Registry identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string @@ -3750,7 +5073,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RevRegIssuedResult' - operationId: get_registry_issued_credentials_count + operationId: get_rev_reg_issued_count /revocation/registry/{rev_reg_id}/issued/details: get: tags: @@ -3761,6 +5084,8 @@ paths: in: path description: Revocation Registry identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string @@ -3771,6 +5096,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CredRevRecordDetailsResult' + operationId: get_rev_reg_issued_issued_details /revocation/registry/{rev_reg_id}/issued/indy_recs: get: tags: @@ -3781,6 +5107,8 @@ paths: in: path description: Revocation Registry identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string @@ -3791,6 +5119,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CredRevIndyRecordsResult' + operationId: get_rev_reg_indy_recs /revocation/registry/{rev_reg_id}/set-state: patch: tags: @@ -3801,6 +5130,8 @@ paths: in: path description: Revocation Registry identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string @@ -3808,6 +5139,8 @@ paths: in: query description: Revocation registry state to set required: true + style: form + explode: true schema: type: string enum: @@ -3834,6 +5167,8 @@ paths: in: path description: Revocation Registry identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string @@ -3855,6 +5190,8 @@ paths: in: path description: Revocation Registry identifier required: true + style: simple + explode: false schema: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) type: string @@ -3871,6 +5208,23 @@ paths: tags: - revocation summary: Revoke an issued credential + parameters: + - name: conn_id + in: query + description: Connection identifier + required: false + style: form + explode: true + schema: + type: string + - name: create_transaction_for_endorser + in: query + description: Create Transaction For Endorser's signature + required: false + style: form + explode: true + schema: + type: boolean requestBody: content: application/json: @@ -3895,11 +5249,17 @@ paths: - name: conn_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string - name: create_transaction_for_endorser in: query description: Create Transaction For Endorser's signature + required: false + style: form + explode: true schema: type: boolean requestBody: @@ -3926,23 +5286,35 @@ paths: - name: schema_id in: query description: Schema identifier + required: false + style: form + explode: true schema: pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$ type: string - name: schema_issuer_did in: query description: Schema issuer DID + required: false + style: form + explode: true schema: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string - name: schema_name in: query description: Schema name + required: false + style: form + explode: true schema: type: string - name: schema_version in: query description: Schema version + required: false + style: form + explode: true schema: pattern: ^[0-9.]+$ type: string @@ -3964,6 +5336,8 @@ paths: in: path description: Schema identifier required: true + style: simple + explode: false schema: pattern: ^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$ type: string @@ -3985,6 +5359,8 @@ paths: in: path description: Schema identifier required: true + style: simple + explode: false schema: pattern: ^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$ type: string @@ -4008,6 +5384,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ProfileSettings' + operationId: get_settings put: tags: - settings @@ -4026,6 +5403,7 @@ paths: schema: $ref: '#/components/schemas/ProfileSettings' x-codegen-request-body-name: body + operationId: update_settings /shutdown: get: tags: @@ -4114,6 +5492,8 @@ paths: in: path description: Transaction identifier required: true + style: simple + explode: false schema: type: string responses: @@ -4147,13 +5527,10 @@ paths: in: query description: Transaction identifier required: true + style: form + explode: true schema: type: string - - name: endorser_write_txn - in: query - description: Endorser will write the transaction after endorsing it - schema: - type: boolean requestBody: content: application/json: @@ -4179,17 +5556,24 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string - name: endorser_did in: query description: Endorser DID required: true + style: form + explode: true schema: type: string - name: endorser_name in: query description: Endorser Name + required: false + style: form + explode: true schema: type: string responses: @@ -4210,11 +5594,16 @@ paths: in: path description: Connection identifier required: true + style: simple + explode: false schema: type: string - name: transaction_my_job in: query description: Transaction related jobs + required: false + style: form + explode: true schema: type: string enum: @@ -4239,6 +5628,8 @@ paths: in: path description: Transaction identifier required: true + style: simple + explode: false schema: type: string responses: @@ -4259,6 +5650,8 @@ paths: in: path description: Transaction identifier required: true + style: simple + explode: false schema: type: string responses: @@ -4279,11 +5672,16 @@ paths: in: path description: Transaction identifier required: true + style: simple + explode: false schema: type: string - name: endorser_did in: query description: Endorser DID + required: false + style: form + explode: true schema: type: string responses: @@ -4304,6 +5702,8 @@ paths: in: path description: Transaction identifier required: true + style: simple + explode: false schema: type: string responses: @@ -4324,6 +5724,8 @@ paths: in: path description: Transaction identifier required: true + style: simple + explode: false schema: type: string responses: @@ -4346,6 +5748,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ListCredentialsResponse' + operationId: list_credentials /vc/credentials/issue: post: tags: @@ -4365,11 +5768,13 @@ paths: schema: $ref: '#/components/schemas/IssueCredentialResponse' x-codegen-request-body-name: body + operationId: issue_credential /vc/credentials/store: post: tags: - vc-api summary: Store a credential + operationId: store_credential /vc/credentials/verify: post: tags: @@ -4389,6 +5794,7 @@ paths: schema: $ref: '#/components/schemas/VerifyCredentialResponse' x-codegen-request-body-name: body + operationId: verify_credential /vc/credentials/{credential_id}: get: tags: @@ -4398,6 +5804,8 @@ paths: - name: credential_id in: path required: true + style: simple + explode: false schema: type: string responses: @@ -4407,6 +5815,7 @@ paths: application/json: schema: $ref: '#/components/schemas/FetchCredentialResponse' + operationId: get_credential /vc/presentations/prove: post: tags: @@ -4426,6 +5835,7 @@ paths: schema: $ref: '#/components/schemas/ProvePresentationResponse' x-codegen-request-body-name: body + operationId: prove_presentation /vc/presentations/verify: post: tags: @@ -4445,6 +5855,7 @@ paths: schema: $ref: '#/components/schemas/VerifyPresentationResponse' x-codegen-request-body-name: body + operationId: verify_presentation /wallet/did: get: tags: @@ -4454,12 +5865,18 @@ paths: - name: did in: query description: DID of interest + required: false + style: form + explode: true schema: 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 - name: key_type in: query description: Key type to query for. + required: false + style: form + explode: true schema: type: string enum: @@ -4468,15 +5885,23 @@ paths: - name: method in: query description: DID method to query for. e.g. sov to only fetch indy/sov DIDs + required: false + style: form + explode: true schema: type: string enum: - key - sov + - did:peer:2 + - did:peer:4 - name: posture in: query description: Whether DID is current public DID, posted to ledger but current public DID, or local to the wallet + required: false + style: form + explode: true schema: type: string enum: @@ -4486,6 +5911,9 @@ paths: - name: verkey in: query description: Verification key of interest + required: false + style: form + explode: true schema: pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$ type: string @@ -4527,6 +5955,8 @@ paths: in: query description: DID of interest required: true + style: form + explode: true schema: 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 @@ -4560,22 +5990,33 @@ paths: in: query description: DID of interest required: true + style: form + explode: true schema: 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 - name: conn_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string - name: create_transaction_for_endorser in: query description: Create Transaction For Endorser's signature + required: false + style: form + explode: true schema: type: boolean - name: mediation_id in: query description: Mediation identifier + required: false + style: form + explode: true schema: type: string responses: @@ -4596,6 +6037,8 @@ paths: in: query description: DID of interest required: true + style: form + explode: true schema: 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 @@ -4626,6 +6069,7 @@ paths: schema: $ref: '#/components/schemas/WalletModuleResponse' x-codegen-request-body-name: body + operationId: sign_jwt /wallet/jwt/verify: post: tags: @@ -4645,6 +6089,7 @@ paths: schema: $ref: '#/components/schemas/JWSVerifyResponse' x-codegen-request-body-name: body + operationId: verify_jwt /wallet/sd-jwt/sign: post: tags: @@ -4664,6 +6109,7 @@ paths: schema: $ref: '#/components/schemas/WalletModuleResponse' x-codegen-request-body-name: body + operationId: sign_sd_jwt /wallet/sd-jwt/verify: post: tags: @@ -4684,6 +6130,7 @@ paths: schema: $ref: '#/components/schemas/SDJWSVerifyResponse' x-codegen-request-body-name: body + operationId: verify_sd_jwt /wallet/set-did-endpoint: post: tags: @@ -4693,11 +6140,17 @@ paths: - name: conn_id in: query description: Connection identifier + required: false + style: form + explode: true schema: type: string - name: create_transaction_for_endorser in: query description: Create Transaction For Endorser's signature + required: false + style: form + explode: true schema: type: boolean requestBody: @@ -4745,6 +6198,8 @@ components: ActionMenuModulesResult: type: object AdminConfig: + required: + - config type: object properties: config: @@ -4798,6 +6253,28 @@ components: type: boolean description: Readiness status example: true + AnonCredsSchema: + type: object + properties: + attrNames: + type: array + description: Schema attribute names + items: + type: string + description: Attribute name + example: score + issuerId: + type: string + description: Issuer Identifier of the credential definition or schema + example: WgWxqztrNooG92RXvxSTWv + name: + type: string + description: Schema name + example: Example schema + version: + type: string + description: Schema version + example: '1.0' AttachDecorator: required: - data @@ -4977,6 +6454,8 @@ components: type: string description: Ledgers identifiers ConnRecord: + required: + - connection_id type: object properties: accept: @@ -5001,6 +6480,7 @@ components: enum: - connections/1.0 - didexchange/1.0 + - didexchange/1.1 created_at: pattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$ type: string @@ -5032,10 +6512,10 @@ components: description: ID of out-of-band invitation message example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 my_did: - pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ + 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 description: Our DID for connection - example: WgWxqztrNooG92RXvxSTWv + example: did:peer:WgWxqztrNooG92RXvxSTWv request_id: type: string description: Connection request identifier @@ -5050,10 +6530,10 @@ components: description: Current record state example: active their_did: - pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ + 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 description: Their DID for connection - example: WgWxqztrNooG92RXvxSTWv + example: did:peer:WgWxqztrNooG92RXvxSTWv their_label: type: string description: Their label for connection @@ -5086,7 +6566,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type did: 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_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$ @@ -5124,6 +6603,8 @@ components: description: Service endpoint at which to reach this agent example: http://192.168.56.101:8020 ConnectionList: + required: + - results type: object properties: results: @@ -5303,7 +6784,7 @@ components: description: Agent config key-value pairs image_url: type: string - description: Image url for this wallet. This image url is publicized (self-attested) + 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 key_management_mode: @@ -5314,15 +6795,14 @@ components: - managed label: type: string - description: Label for this wallet. This label is publicized (self-attested) + description: Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection. example: Alice wallet_dispatch_type: type: string - 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. + 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.' example: default enum: - default @@ -5346,10 +6826,11 @@ components: example: MyNewWallet wallet_type: type: string - description: Type of the wallet to create - example: indy + description: Type of the wallet to create. Must be same as base wallet. + example: askar enum: - askar + - askar-anoncreds - in_memory - indy wallet_webhook_urls: @@ -5402,7 +6883,7 @@ components: properties: wallet_key: type: string - description: Master key used for key derivation. Only required for unamanged + description: Master key used for key derivation. Only required for unmanaged wallets. example: MySecretKey123 CreateWalletTokenResponse: @@ -5431,6 +6912,91 @@ components: type: string description: 'Attribute value: base64-encode if MIME type is present' example: martini + CredDef: + type: object + properties: + issuerId: + type: string + description: Issuer Identifier of the credential definition or schema + example: WgWxqztrNooG92RXvxSTWv + schemaId: + type: string + description: Schema identifier + example: WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0 + tag: + type: string + description: The tag value passed in by the Issuer to an AnonCred's Credential + Definition create and store implementation. + example: default + type: + type: string + enum: + - CL + value: + $ref: '#/components/schemas/CredDefValueSchemaAnoncreds' + CredDefPostOptions: + type: object + properties: + create_transaction_for_endorser: + type: boolean + description: Create transaction for endorser (optional, default false). + Use this for agents who don't specify an author role but want to create + a transaction for an endorser to sign. + example: false + endorser_connection_id: + type: string + description: Connection identifier (optional) (this is an example). You + can set this if you know the endorser's connection id you want to use. + If not specified then the agent will attempt to find an endorser connection. + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + revocation_registry_size: + type: integer + description: Maximum number of credential revocations per registry + format: int32 + example: 1000 + support_revocation: + type: boolean + description: Support credential revocation + CredDefPostRequest: + type: object + properties: + credential_definition: + $ref: '#/components/schemas/InnerCredDef' + options: + $ref: '#/components/schemas/CredDefPostOptions' + CredDefResult: + type: object + properties: + credential_definition_metadata: + type: object + properties: {} + credential_definition_state: + $ref: '#/components/schemas/CredDefState' + job_id: + type: string + registration_metadata: + type: object + properties: {} + CredDefState: + type: object + properties: + credential_definition: + type: object + description: credential definition + allOf: + - $ref: '#/components/schemas/CredDef' + credential_definition_id: + type: string + description: credential definition id + nullable: true + example: WgWxqztrNooG92RXvxSTWv:3:CL:20:tag + state: + type: string + enum: + - finished + - failed + - action + - wait CredDefValue: type: object properties: @@ -5465,6 +7031,28 @@ components: pattern: ^[0-9]*$ type: string example: '0' + CredDefValuePrimarySchemaAnoncreds: + type: object + properties: + n: + pattern: ^[0-9]*$ + type: string + example: '0' + r: + type: object + properties: {} + rctxt: + pattern: ^[0-9]*$ + type: string + example: '0' + s: + pattern: ^[0-9]*$ + type: string + example: '0' + z: + pattern: ^[0-9]*$ + type: string + example: '0' CredDefValueRevocation: type: object properties: @@ -5501,6 +7089,55 @@ components: y: type: string example: 1 153558BD903312 2 095E45DDF417D 1 0000000000000000 + CredDefValueRevocationSchemaAnoncreds: + type: object + properties: + g: + type: string + example: 1 1F14F&ECB578F 2 095E45DDF417D + g_dash: + type: string + example: 1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D + h: + type: string + example: 1 16675DAE54BFAE8 2 095E45DD417D + h0: + type: string + example: 1 21E5EF9476EAF18 2 095E45DDF417D + h1: + type: string + example: 1 236D1D99236090 2 095E45DDF417D + h2: + type: string + example: 1 1C3AE8D1F1E277 2 095E45DDF417D + h_cap: + type: string + example: 1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000 + htilde: + type: string + example: 1 1D8549E8C0F8 2 095E45DDF417D + pk: + type: string + example: 1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D + u: + type: string + example: 1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000 + y: + type: string + example: 1 153558BD903312 2 095E45DDF417D 1 0000000000000000 + CredDefValueSchemaAnoncreds: + type: object + properties: + primary: + type: object + description: Primary value for credential definition + allOf: + - $ref: '#/components/schemas/CredDefValuePrimarySchemaAnoncreds' + revocation: + type: object + description: Revocation value for credential definition + allOf: + - $ref: '#/components/schemas/CredDefValueRevocationSchemaAnoncreds' CredInfoList: type: object properties: @@ -5515,6 +7152,13 @@ components: type: object properties: {} description: Indy revocation registry delta + CredRevIndyRecordsResultSchemaAnoncreds: + type: object + properties: + rev_reg_delta: + type: object + properties: {} + description: Indy revocation registry delta CredRevRecordDetailsResult: type: object properties: @@ -5522,7 +7166,19 @@ components: type: array items: $ref: '#/components/schemas/IssuerCredRevRecord' + CredRevRecordDetailsResultSchemaAnoncreds: + type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/IssuerCredRevRecordSchemaAnoncreds' CredRevRecordResult: + type: object + properties: + result: + $ref: '#/components/schemas/IssuerCredRevRecordSchemaAnoncreds' + CredRevRecordResultSchemaAnoncreds: type: object properties: result: @@ -5550,6 +7206,9 @@ components: - https://www.w3.org/2018/credentials/examples/v1 items: type: object + credentialStatus: + type: object + example: '' credentialSubject: type: object example: '' @@ -5561,6 +7220,7 @@ components: id: pattern: \w+:(\/?\/?)[^\s]+ type: string + description: The ID of the credential example: http://example.edu/credentials/1872 issuanceDate: 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})))?$ @@ -5649,6 +7309,8 @@ components: description: Credential definition identifier tag example: default CredentialDefinitionSendResult: + required: + - credential_definition_id type: object properties: credential_definition_id: @@ -5678,7 +7340,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string @@ -5713,7 +7374,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string @@ -5755,6 +7415,12 @@ components: Registry example: CredentialStatusList2017 DID: + required: + - did + - key_type + - method + - posture + - verkey type: object properties: did: @@ -5769,6 +7435,10 @@ components: enum: - ed25519 - bls12381g2 + metadata: + type: object + properties: {} + description: Additional metadata associated with the DID method: type: string description: Did method associated with the DID @@ -5802,7 +7472,7 @@ components: - $ref: '#/components/schemas/DIDCreateOptions' seed: type: string - description: Optional seed to use for DID, Must beenabled in configuration + description: Optional seed to use for DID, Must be enabled in configuration before use. example: 000000000000000000000000Trustee1 DIDCreateOptions: @@ -5876,6 +7546,15 @@ components: properties: result: $ref: '#/components/schemas/DID' + DIDRotateRequestJSON: + required: + - to_did + type: object + properties: + to_did: + type: string + description: The DID the rotating party is rotating to + example: did:web:example.com DIDXRejectRequest: type: object properties: @@ -5895,7 +7574,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type did: 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_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$ @@ -6055,7 +7733,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type protocols: type: array @@ -6074,7 +7751,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type disclosures: type: array @@ -6096,6 +7772,24 @@ components: description: Signature options allOf: - $ref: '#/components/schemas/SignatureOptions' + DocumentVerificationResult: + required: + - verified + type: object + properties: + document: + type: object + properties: {} + errors: + type: array + items: + type: string + results: + type: array + items: + $ref: '#/components/schemas/ProofResult' + verified: + type: boolean EndorserInfo: required: - endorser_did @@ -6186,6 +7880,33 @@ components: pattern: ^[0-9]*$ type: string example: '0' + GetCredDefResult: + type: object + properties: + credential_definition: + type: object + description: credential definition + allOf: + - $ref: '#/components/schemas/CredDef' + credential_definition_id: + type: string + description: credential definition id + example: WgWxqztrNooG92RXvxSTWv:3:CL:20:tag + credential_definitions_metadata: + type: object + properties: {} + resolution_metadata: + type: object + properties: {} + GetCredDefsResponse: + type: object + properties: + credential_definition_ids: + type: array + items: + type: string + description: credential definition identifiers + example: GvLGiRogTJubmj5B36qhYz:3:CL:8:faber.agent.degree_schema GetDIDEndpointResponse: type: object properties: @@ -6218,6 +7939,41 @@ components: - NETWORK_MONITOR - USER - ROLE_REMOVE + GetSchemaResult: + type: object + properties: + resolution_metadata: + type: object + properties: {} + schema: + $ref: '#/components/schemas/AnonCredsSchema' + schema_id: + type: string + description: Schema identifier + example: WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0 + schema_metadata: + type: object + properties: {} + GetSchemasResponse: + type: object + properties: + schema_ids: + type: array + items: + type: string + description: Schema identifiers + example: WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0 + Hangup: + type: object + properties: + '@id': + type: string + description: Message identifier + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + '@type': + type: string + description: Message type + example: https://didcomm.org/my-family/1.0/my-message-type HolderModuleResponse: type: object IndyAttrValue: @@ -6298,6 +8054,8 @@ components: description: Schema identifier example: WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0 IndyCredPrecis: + required: + - cred_info type: object properties: cred_info: @@ -6344,10 +8102,9 @@ components: description: Nonce in credential request example: '0' prover_did: - pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string - description: Prover DID - example: WgWxqztrNooG92RXvxSTWv + description: Prover DID/Random String/UUID + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 IndyCredential: required: - cred_def_id @@ -6596,7 +8353,7 @@ components: '@type': type: string description: Message type identifier - example: did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/present-proof/1.0/presentation-preview + example: https://didcomm.org/present-proof/1.0/presentation-preview attributes: type: array items: @@ -6640,11 +8397,7 @@ components: type: object properties: eq_proof: - type: object - description: Indy equality proof - nullable: true - allOf: - - $ref: '#/components/schemas/IndyEQProof' + $ref: '#/components/schemas/IndyPrimaryProof_eq_proof' ge_proofs: type: array description: Indy GE proofs @@ -6727,11 +8480,7 @@ components: type: object properties: non_revoc_proof: - type: object - description: Indy non-revocation proof - nullable: true - allOf: - - $ref: '#/components/schemas/IndyNonRevocProof' + $ref: '#/components/schemas/IndyProofProofProofsProof_non_revoc_proof' primary_proof: type: object description: Indy primary proof @@ -6751,10 +8500,7 @@ components: type: string example: age non_revoked: - type: object - nullable: true - allOf: - - $ref: '#/components/schemas/IndyProofReqAttrSpecNonRevoked' + $ref: '#/components/schemas/IndyProofReqAttrSpec_non_revoked' restrictions: type: array description: 'If present, credential must satisfy one of given restrictions: @@ -6795,10 +8541,7 @@ components: description: Attribute name example: index non_revoked: - type: object - nullable: true - allOf: - - $ref: '#/components/schemas/IndyProofReqPredSpecNonRevoked' + $ref: '#/components/schemas/IndyProofReqPredSpec_non_revoked' p_type: type: string description: Predicate type ('<', '<=', '>=', or '>') @@ -6851,10 +8594,7 @@ components: description: Proof request name example: Proof request non_revoked: - type: object - nullable: true - allOf: - - $ref: '#/components/schemas/IndyProofRequestNonRevoked' + $ref: '#/components/schemas/IndyProofRequest_non_revoked' nonce: pattern: ^[1-9][0-9]*$ type: string @@ -7086,6 +8826,45 @@ components: items: type: integer format: int32 + InnerCredDef: + required: + - issuerId + - schemaId + - tag + type: object + properties: + issuerId: + type: string + description: Issuer Identifier of the credential definition + example: WgWxqztrNooG92RXvxSTWv + schemaId: + type: string + description: Schema identifier + example: WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0 + tag: + type: string + description: Credential definition tag + example: default + InnerRevRegDef: + type: object + properties: + credDefId: + type: string + description: Credential definition identifier + example: WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0 + issuerId: + type: string + description: Issuer Identifier of the credential definition or schema + example: WgWxqztrNooG92RXvxSTWv + maxCredNum: + type: integer + description: Maximum number of credential revocations per registry + format: int32 + example: 777 + tag: + type: string + description: tag for revocation registry + example: default InputDescriptors: type: object properties: @@ -7161,7 +8940,7 @@ components: items: type: string description: Handshake protocol to specify in invitation - example: did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0 + example: https://didcomm.org/didexchange/1.0 mediation_id: 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 @@ -7180,6 +8959,17 @@ components: type: string description: OOB protocol version example: '1.1' + use_did: + type: string + description: DID to use in invitation + example: did:example:123 + use_did_method: + type: string + description: DID method to use in invitation + example: did:peer:2 + enum: + - did:peer:2 + - did:peer:4 use_public_did: type: boolean description: Whether to use public DID in invitation @@ -7219,7 +9009,7 @@ components: items: type: string description: Handshake protocol - example: did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0 + example: https://didcomm.org/didexchange/1.0 imageUrl: type: string description: Optional image URL for out-of-band invitation @@ -7292,7 +9082,13 @@ components: type: string description: Time of last record update example: 2021-12-31 23:59:59+00:00 + InvitationRecordResponse: + type: object InvitationResult: + required: + - connection_id + - invitation + - invitation_url type: object properties: connection_id: @@ -7362,6 +9158,43 @@ components: type: string description: Time of last record update example: 2021-12-31 23:59:59+00:00 + IssuerCredRevRecordSchemaAnoncreds: + type: object + properties: + created_at: + pattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$ + type: string + description: Time of record creation + example: 2021-12-31 23:59:59+00:00 + cred_def_id: + type: string + description: Credential definition identifier + cred_ex_id: + type: string + description: Credential exchange record identifier at credential issue + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + cred_ex_version: + type: string + description: Credential exchange version + cred_rev_id: + type: string + description: Credential revocation identifier + record_id: + type: string + description: Issuer credential revocation record identifier + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + rev_reg_id: + type: string + description: Revocation registry identifier + state: + type: string + description: Issue credential revocation record state + example: issued + updated_at: + pattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$ + type: string + description: Time of last record update + example: 2021-12-31 23:59:59+00:00 IssuerRevRegRecord: type: object properties: @@ -7514,7 +9347,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type filter: type: object @@ -7557,7 +9389,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type updates: type: array @@ -7625,10 +9456,8 @@ components: example: proofType: Ed25519Signature2018 allOf: - - $ref: '#/components/schemas/LDProofVCDetailOptions' - LDProofVCDetailOptions: - required: - - proofType + - $ref: '#/components/schemas/LDProofVCOptions' + LDProofVCOptions: type: object properties: challenge: @@ -7663,6 +9492,11 @@ components: description: The proof type used for the proof. Should match suites registered in the Linked Data Cryptographic Suite Registry example: Ed25519Signature2018 + verificationMethod: + type: string + description: The verification method to use for the proof. Should match + a verification method in the wallet + example: did:example:123456#key-1 LedgerConfigInstance: type: object properties: @@ -7715,7 +9549,7 @@ components: pattern: \w+:(\/?\/?)[^\s]+ type: string description: A string value specifying the restricted domain of the signature. - example: example.com + example: https://example.com jws: type: string description: Associates a Detached Json Web Signature with a proof @@ -7742,6 +9576,8 @@ components: type: string description: Information used for proof verification example: did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL + ListCredentialsResponse: + type: object MediationCreateRequest: type: object MediationDeny: @@ -7754,7 +9590,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type MediationGrant: type: object @@ -7766,7 +9601,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type endpoint: type: string @@ -7778,14 +9612,17 @@ components: type: string description: Keys to use for forward message packaging MediationIdMatchInfo: + required: + - mediation_id type: object properties: mediation_id: type: string description: Mediation record identifier - format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 MediationList: + required: + - results type: object properties: results: @@ -7847,7 +9684,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type description: type: string @@ -7994,6 +9830,10 @@ components: description: Out of band invitation message allOf: - $ref: '#/components/schemas/InvitationMessage' + multi_use: + type: boolean + description: Allow for multiple uses of the oob invitation + example: true oob_id: type: string description: Oob record identifier @@ -8057,6 +9897,52 @@ components: thread_id: type: string description: Thread ID of the ping message + Presentation: + required: + - '@context' + - type + type: object + properties: + '@context': + type: array + description: The JSON-LD context of the presentation + example: + - https://www.w3.org/2018/credentials/v1 + items: + type: object + holder: + type: object + description: The JSON-LD Verifiable Credential Holder. Either string of + object with id field. + example: did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH + id: + pattern: \w+:(\/?\/?)[^\s]+ + type: string + description: The ID of the presentation + example: http://example.edu/presentations/1872 + proof: + type: object + description: The proof of the presentation + example: + created: 2019-12-11 03:50:55 + jws: eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ + proofPurpose: assertionMethod + type: Ed25519Signature2018 + verificationMethod: did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL + allOf: + - $ref: '#/components/schemas/LinkedDataProof' + type: + type: array + description: The JSON-LD type of the presentation + example: + - VerifiablePresentation + items: + type: string + verifiableCredential: + type: array + items: + type: object + properties: {} PresentationDefinition: type: object properties: @@ -8095,7 +9981,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string @@ -8115,7 +10000,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string @@ -8125,6 +10009,23 @@ components: type: array items: $ref: '#/components/schemas/AttachDecorator' + PresentationVerificationResult: + required: + - verified + type: object + properties: + credential_results: + type: array + items: + $ref: '#/components/schemas/DocumentVerificationResult' + errors: + type: array + items: + type: string + presentation_result: + $ref: '#/components/schemas/DocumentVerificationResult' + verified: + type: boolean ProfileSettings: type: object properties: @@ -8136,6 +10037,18 @@ components: debug.invite_public: true log.level: INFO public_invites: false + ProofResult: + type: object + properties: + error: + type: string + proof: + type: object + properties: {} + purpose_result: + $ref: '#/components/schemas/PurposeResult' + verified: + type: boolean ProtocolDescriptor: required: - pid @@ -8161,9 +10074,52 @@ components: ProvePresentationResponse: type: object properties: - verifiablePresentation: - $ref: '#/components/schemas/VerifiablePresentation' - PublishRevocations: + verifiablePresentation: + $ref: '#/components/schemas/VerifiablePresentation' + PublishRevocations: + type: object + properties: + options: + $ref: '#/components/schemas/PublishRevocationsOptions' + rrid2crid: + type: object + additionalProperties: + type: array + items: + pattern: ^[1-9][0-9]*$ + type: string + description: Credential revocation identifier + example: '12345' + description: Credential revocation ids by revocation registry id + PublishRevocationsOptions: + type: object + properties: + create_transaction_for_endorser: + type: boolean + description: Create transaction for endorser (optional, default false). + Use this for agents who don't specify an author role but want to create + a transaction for an endorser to sign. + example: false + endorser_connection_id: + type: string + description: Connection identifier (optional) (this is an example). You + can set this if you know the endorser's connection id you want to use. + If not specified then the agent will attempt to find an endorser connection. + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + PublishRevocationsResult: + type: object + properties: + rrid2crid: + type: object + additionalProperties: + type: array + items: + pattern: ^[1-9][0-9]*$ + type: string + description: Credential revocation identifier + example: '12345' + description: Credential revocation ids by revocation registry id + PublishRevocationsSchemaAnoncreds: type: object properties: rrid2crid: @@ -8176,6 +10132,16 @@ components: description: Credential revocation identifier example: '12345' description: Credential revocation ids by revocation registry id + PurposeResult: + type: object + properties: + controller: + type: object + properties: {} + error: + type: string + valid: + type: boolean Queries: type: object properties: @@ -8186,7 +10152,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type queries: type: array @@ -8204,7 +10169,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string @@ -8247,7 +10211,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type did: 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_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$ @@ -8289,7 +10252,7 @@ components: properties: wallet_key: type: string - description: Master key used for key derivation. Only required for unmanaged + description: Master key used for key derivation. Only required for unmanaged wallets. example: MySecretKey123 ResolutionResult: @@ -8306,6 +10269,88 @@ components: type: object properties: {} description: Resolution metadata + RevList: + type: object + properties: + currentAccumulator: + type: string + description: The current accumulator value + example: 21 118...1FB + issuerId: + type: string + description: Issuer Identifier of the credential definition or schema + example: WgWxqztrNooG92RXvxSTWv + revRegDefId: + type: string + description: The ID of the revocation registry definition + example: WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0 + revocationList: + type: array + description: Bit list representing revoked credentials + example: + - 0 + - 1 + - 1 + - 0 + items: + type: integer + format: int32 + timestamp: + type: integer + description: Timestamp at which revocation list is applicable + format: int32 + RevListCreateRequest: + type: object + properties: + options: + $ref: '#/components/schemas/RevListOptions' + rev_reg_def_id: + type: string + description: Revocation registry definition identifier + example: WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0 + RevListOptions: + type: object + properties: + create_transaction_for_endorser: + type: boolean + description: Create transaction for endorser (optional, default false). + Use this for agents who don't specify an author role but want to create + a transaction for an endorser to sign. + example: false + endorser_connection_id: + type: string + description: Connection identifier (optional) (this is an example). You + can set this if you know the endorser's connection id you want to use. + If not specified then the agent will attempt to find an endorser connection. + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + RevListResult: + type: object + properties: + job_id: + type: string + registration_metadata: + type: object + properties: {} + revocation_list_metadata: + type: object + properties: {} + revocation_list_state: + $ref: '#/components/schemas/RevListState' + RevListState: + type: object + properties: + revocation_list: + type: object + description: revocation list + allOf: + - $ref: '#/components/schemas/RevList' + state: + type: string + enum: + - finished + - failed + - action + - wait RevRegCreateRequest: type: object properties: @@ -8321,6 +10366,98 @@ components: description: Revocation registry size format: int32 example: 1000 + RevRegCreateRequestSchemaAnoncreds: + type: object + properties: + options: + $ref: '#/components/schemas/RevRegDefOptions' + revocation_registry_definition: + $ref: '#/components/schemas/InnerRevRegDef' + RevRegDef: + type: object + properties: + credDefId: + type: string + description: Credential definition identifier + example: WgWxqztrNooG92RXvxSTWv:3:CL:20:tag + issuerId: + type: string + description: Issuer Identifier of the credential definition or schema + example: WgWxqztrNooG92RXvxSTWv + revocDefType: + type: string + tag: + type: string + description: tag for the revocation registry definition + example: default + value: + $ref: '#/components/schemas/RevRegDefValue' + RevRegDefOptions: + type: object + properties: + create_transaction_for_endorser: + type: boolean + description: Create transaction for endorser (optional, default false). + Use this for agents who don't specify an author role but want to create + a transaction for an endorser to sign. + example: false + endorser_connection_id: + type: string + description: Connection identifier (optional) (this is an example). You + can set this if you know the endorser's connection id you want to use. + If not specified then the agent will attempt to find an endorser connection. + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + RevRegDefResult: + type: object + properties: + job_id: + type: string + registration_metadata: + type: object + properties: {} + revocation_registry_definition_metadata: + type: object + properties: {} + revocation_registry_definition_state: + $ref: '#/components/schemas/RevRegDefState' + RevRegDefState: + type: object + properties: + revocation_registry_definition: + type: object + description: revocation registry definition + allOf: + - $ref: '#/components/schemas/RevRegDef' + revocation_registry_definition_id: + type: string + description: revocation registry definition id + example: WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0 + state: + type: string + enum: + - finished + - failed + - action + - wait + - decommissioned + - full + RevRegDefValue: + type: object + properties: + maxCredNum: + type: integer + format: int32 + example: 777 + publicKeys: + type: object + properties: {} + example: H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV + tailsHash: + type: string + example: 7Qen9RDyemMuV7xGQvp7NjwMSpyHieJyBakycxN7dX7P + tailsLocation: + type: string + example: https://tails-server.com/hash/7Qen9RDyemMuV7xGQvp7NjwMSpyHieJyBakycxN7dX7P RevRegIssuedResult: type: object properties: @@ -8330,11 +10467,25 @@ components: description: Number of credentials issued against revocation registry format: int32 example: 0 + RevRegIssuedResultSchemaAnoncreds: + type: object + properties: + result: + minimum: 0 + type: integer + description: Number of credentials issued against revocation registry + format: int32 + example: 0 RevRegResult: type: object properties: result: $ref: '#/components/schemas/IssuerRevRegRecord' + RevRegResultSchemaAnoncreds: + type: object + properties: + result: + $ref: '#/components/schemas/IssuerRevRegRecord' RevRegUpdateTailsFileUri: required: - tails_public_uri @@ -8360,6 +10511,21 @@ components: type: object properties: {} description: Indy revocation registry delta + RevRegWalletUpdatedResultSchemaAnoncreds: + type: object + properties: + accum_calculated: + type: object + properties: {} + description: Calculated accumulator for phantom revocations + accum_fixed: + type: object + properties: {} + description: Applied ledger transaction to fix revocations + rev_reg_delta: + type: object + properties: {} + description: Indy revocation registry delta RevRegsCreated: type: object properties: @@ -8370,6 +10536,18 @@ components: type: string description: Revocation registry identifiers example: WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0 + RevRegsCreatedSchemaAnoncreds: + type: object + properties: + rev_reg_ids: + type: array + items: + pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) + type: string + description: Revocation registry identifiers + example: WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0 + RevocationAnoncredsModuleResponse: + type: object RevocationModuleResponse: type: object RevokeRequest: @@ -8417,6 +10595,68 @@ components: type: string description: Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true + RevokeRequestSchemaAnoncreds: + type: object + properties: + comment: + type: string + description: Optional comment to include in revocation notification + connection_id: + 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 + description: Connection ID to which the revocation notification will be + sent; required if notify is true + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + cred_ex_id: + 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 + description: Credential exchange identifier + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + cred_rev_id: + pattern: ^[1-9][0-9]*$ + type: string + description: Credential revocation identifier + example: '12345' + notify: + type: boolean + description: Send a notification to the credential recipient + notify_version: + type: string + description: Specify which version of the revocation notification should + be sent + enum: + - v1_0 + - v2_0 + publish: + type: boolean + description: (True) publish revocation to ledger immediately, or (default, + False) mark it pending + rev_reg_id: + pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$) + type: string + description: Revocation registry identifier + example: WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0 + thread_id: + type: string + description: Thread ID of the credential exchange message thread resulting + in the credential now being revoked; required if notify is true + Rotate: + required: + - to_did + type: object + properties: + '@id': + type: string + description: Message identifier + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + '@type': + type: string + description: Message type + example: https://didcomm.org/my-family/1.0/my-message-type + to_did: + type: string + description: The DID the rotating party is rotating to + example: did:example:newdid RouteRecord: required: - recipient_key @@ -8568,6 +10808,41 @@ components: uri: type: string description: URI + SchemaPostOption: + type: object + properties: + create_transaction_for_endorser: + type: boolean + description: Create transaction for endorser (optional, default false). + Use this for agents who don't specify an author role but want to create + a transaction for an endorser to sign. + example: false + endorser_connection_id: + type: string + description: Connection identifier (optional) (this is an example). You + can set this if you know the endorser's connection id you want to use. + If not specified then the agent will attempt to find an endorser connection. + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + SchemaPostRequest: + type: object + properties: + options: + $ref: '#/components/schemas/SchemaPostOption' + schema: + $ref: '#/components/schemas/AnonCredsSchema' + SchemaResult: + type: object + properties: + job_id: + type: string + registration_metadata: + type: object + properties: {} + schema_metadata: + type: object + properties: {} + schema_state: + $ref: '#/components/schemas/SchemaState' SchemaSendRequest: required: - attributes @@ -8606,6 +10881,22 @@ components: type: string description: Schema identifier example: WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0 + SchemaState: + type: object + properties: + schema: + $ref: '#/components/schemas/AnonCredsSchema' + schema_id: + type: string + description: Schema identifier + example: WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0 + state: + type: string + enum: + - finished + - failed + - action + - wait SchemasCreatedResult: type: object properties: @@ -8839,7 +11130,7 @@ components: example: '101' connection_id: type: string - description: The connection identifier for thie particular transaction record + description: The connection identifier for this particular transaction record example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 created_at: pattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$ @@ -8848,9 +11139,9 @@ components: example: 2021-12-31 23:59:59+00:00 endorser_write_txn: type: boolean - description: If True, Endorser will write the transaction after endorsing - it - example: true + description: Request Endorser to write the ledger transaction, this parameter + is deprecated and no longer supported. + example: false formats: type: array items: @@ -8894,7 +11185,7 @@ components: author_goal_code: aries.transaction.ledger.write context: did:sov method: add-signature - signature_type: + signature_type: default signer_goal_code: aries.transaction.endorse signature_response: type: array @@ -8945,7 +11236,7 @@ components: type: object properties: sent: - $ref: '#/components/schemas/PublishRevocations' + $ref: '#/components/schemas/PublishRevocationsSchemaAnoncreds' txn: type: object description: Revocation registry revocations transaction to endorse @@ -9006,20 +11297,19 @@ components: description: Agent config key-value pairs image_url: type: string - description: Image url for this wallet. This image url is publicized (self-attested) + 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 label: type: string - description: Label for this wallet. This label is publicized (self-attested) + description: Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection. example: Alice wallet_dispatch_type: type: string - 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. + 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.' example: default enum: - default @@ -9273,7 +11563,6 @@ components: connection_id: type: string description: Connection identifier - format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 cred_def_id: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ @@ -9316,7 +11605,6 @@ components: connection_id: type: string description: Connection identifier - format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 cred_def_id: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ @@ -9368,7 +11656,6 @@ components: connection_id: type: string description: Connection identifier - format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 cred_def_id: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ @@ -9615,7 +11902,6 @@ components: connection_id: type: string description: Connection identifier - format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 presentation_proposal: $ref: '#/components/schemas/IndyPresPreview' @@ -9678,7 +11964,6 @@ components: connection_id: type: string description: Connection identifier - format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 proof_request: $ref: '#/components/schemas/IndyProofRequest' @@ -9750,7 +12035,6 @@ components: connection_id: type: string description: Connection identifier - format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 credential_preview: $ref: '#/components/schemas/V20CredPreview' @@ -10071,7 +12355,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string @@ -10118,7 +12401,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string @@ -10193,7 +12475,6 @@ components: connection_id: type: string description: Connection identifier - format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 credential_preview: $ref: '#/components/schemas/V20CredPreview' @@ -10236,7 +12517,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string @@ -10270,7 +12550,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string @@ -10303,7 +12582,6 @@ components: connection_id: type: string description: Connection identifier - format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 filter: type: object @@ -10439,7 +12717,6 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string @@ -10633,13 +12910,13 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string description: Human-readable comment formats: type: array + description: Acceptable attachment formats items: $ref: '#/components/schemas/V20PresFormat' proposals~attach: @@ -10681,7 +12958,6 @@ components: connection_id: type: string description: Connection identifier - format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 presentation_proposal: $ref: '#/components/schemas/V20PresProposalByFormat' @@ -10702,13 +12978,13 @@ components: '@type': type: string description: Message type - readOnly: true example: https://didcomm.org/my-family/1.0/my-message-type comment: type: string description: Human-readable comment formats: type: array + description: Acceptable attachment formats items: $ref: '#/components/schemas/V20PresFormat' request_presentations~attach: @@ -10752,7 +13028,6 @@ components: connection_id: type: string description: Connection identifier - format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 presentation_request: $ref: '#/components/schemas/V20PresRequestByFormat' @@ -10770,7 +13045,7 @@ components: dif: type: object description: Optional Presentation specification for DIF, overrides the - PresentionExchange record's PresRequest + PresentationExchange record's PresRequest allOf: - $ref: '#/components/schemas/DIFPresSpec' indy: @@ -10892,6 +13167,7 @@ components: id: pattern: \w+:(\/?\/?)[^\s]+ type: string + description: The ID of the credential example: http://example.edu/credentials/1872 issuanceDate: 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})))?$ @@ -10944,6 +13220,7 @@ components: id: pattern: \w+:(\/?\/?)[^\s]+ type: string + description: The ID of the presentation example: http://example.edu/presentations/1872 proof: type: object @@ -11117,10 +13394,37 @@ components: properties: ledger_id: type: string + IndyPrimaryProof_eq_proof: + type: object + description: Indy equality proof + nullable: true + allOf: + - $ref: '#/components/schemas/IndyEQProof' + IndyProofProofProofsProof_non_revoc_proof: + type: object + description: Indy non-revocation proof + nullable: true + allOf: + - $ref: '#/components/schemas/IndyNonRevocProof' + IndyProofReqAttrSpec_non_revoked: + type: object + nullable: true + allOf: + - $ref: '#/components/schemas/IndyProofReqAttrSpecNonRevoked' + IndyProofReqPredSpec_non_revoked: + type: object + nullable: true + allOf: + - $ref: '#/components/schemas/IndyProofReqPredSpecNonRevoked' + IndyProofRequest_non_revoked: + type: object + nullable: true + allOf: + - $ref: '#/components/schemas/IndyProofRequestNonRevoked' securitySchemes: AuthorizationHeader: type: apiKey - description: Bearer token. Be sure to preprend token with 'Bearer ' + description: Bearer token. Be sure to prepend 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 51fb0d89..b9e3c6e8 100644 --- a/generator/data/swagger.json +++ b/generator/data/swagger.json @@ -1,12539 +1,17209 @@ { + "openapi": "3.0.1", + "info": { + "title": "Aries Cloud Agent", + "version": "v0.12.0" + }, + "servers": [ + { + "url": "/" + } + ], + "security": [ + { + "AuthorizationHeader": [] + } + ], + "tags": [ + { + "description": "Menu interaction over connection", + "name": "action-menu" + }, + { + "description": "Anoncreds credential definition management", + "externalDocs": { + "description": "Specification", + "url": "https://hyperledger.github.io/anoncreds-spec" + }, + "name": "anoncreds - credential definitions" + }, + { + "description": "Revocation registry management", + "externalDocs": { + "description": "Overview", + "url": "https://github.com/hyperledger/indy-hipe/tree/master/text/0011-cred-revocation" + }, + "name": "anoncreds - revocation" + }, + { + "description": "Anoncreds schema management", + "externalDocs": { + "description": "Specification", + "url": "https://hyperledger.github.io/anoncreds-spec" + }, + "name": "anoncreds - schemas" + }, + { + "description": "Simple messaging", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0095-basic-message" + }, + "name": "basicmessage" + }, + { + "description": "Connection management", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/9b0aaa39df7e8bd434126c4b33c097aae78d65bf/features/0160-connection-protocol" + }, + "name": "connection" + }, + { + "description": "Credential definition operations", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#cred_def" + }, + "name": "credential-definition" + }, + { + "description": "Holder credential management", + "externalDocs": { + "description": "Overview", + "url": "https://w3c.github.io/vc-data-model/#credentials" + }, + "name": "credentials" + }, + { + "description": "Connection management via DID exchange", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/25464a5c8f8a17b14edaa4310393df6094ace7b0/features/0023-did-exchange" + }, + "name": "did-exchange" + }, + { + "description": "Rotate a DID", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/main/features/0794-did-rotate" + }, + "name": "did-rotate" + }, + { + "description": "Feature discovery", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0031-discover-features" + }, + "name": "discover-features" + }, + { + "description": "Feature discovery v2", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0557-discover-features-v2" + }, + "name": "discover-features v2.0" + }, + { + "description": "Endorse a Transaction", + "name": "endorse-transaction" + }, + { + "description": "Introduction of known parties", + "name": "introduction" + }, + { + "description": "Credential issue v1.0", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/bb42a6c35e0d5543718fb36dd099551ab192f7b0/features/0036-issue-credential" + }, + "name": "issue-credential v1.0" + }, + { + "description": "Credential issue v2.0", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/cd27fc64aa2805f756a118043d7c880354353047/features/0453-issue-credential-v2" + }, + "name": "issue-credential v2.0" + }, + { + "description": "Sign and verify json-ld data", + "externalDocs": { + "description": "Specification", + "url": "https://tools.ietf.org/html/rfc7515" + }, + "name": "jsonld" + }, + { + "description": "Interaction with ledger", + "externalDocs": { + "description": "Overview", + "url": "https://hyperledger-indy.readthedocs.io/projects/plenum/en/latest/storage.html#ledger" + }, + "name": "ledger" + }, + { + "description": "Mediation management", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/fa8dc4ea1e667eb07db8f9ffeaf074a4455697c0/features/0211-route-coordination" + }, + "name": "mediation" + }, + { + "description": "Multitenant wallet management", + "name": "multitenancy" + }, + { + "description": "Out-of-band connections", + "externalDocs": { + "description": "Design", + "url": "https://github.com/hyperledger/aries-rfcs/tree/2da7fc4ee043effa3a9960150e7ba8c9a4628b68/features/0434-outofband" + }, + "name": "out-of-band" + }, + { + "description": "Proof presentation v1.0", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/4fae574c03f9f1013db30bf2c0c676b1122f7149/features/0037-present-proof" + }, + "name": "present-proof v1.0" + }, + { + "description": "Proof presentation v2.0", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/eace815c3e8598d4a8dd7881d8c731fdb2bcc0aa/features/0454-present-proof-v2" + }, + "name": "present-proof v2.0" + }, + { + "description": "did resolver interface.", + "externalDocs": { + "description": "DID Resolution Specification", + "url": "https://www.w3.org/TR/did-core/#resolution" + }, + "name": "resolver" + }, + { + "description": "Revocation registry management", + "externalDocs": { + "description": "Overview", + "url": "https://github.com/hyperledger/indy-hipe/tree/master/text/0011-cred-revocation" + }, + "name": "revocation" + }, + { + "description": "Schema operations", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#schema" + }, + "name": "schema" + }, + { + "description": "Agent settings interface.", + "name": "settings" + }, + { + "description": "Trust-ping over connection", + "externalDocs": { + "description": "Specification", + "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0048-trust-ping" + }, + "name": "trustping" + }, + { + "description": "Endpoints for managing w3c credentials and presentations", + "externalDocs": { + "description": "Specification", + "url": "https://w3c-ccg.github.io/vc-api/" + }, + "name": "vc-api" + }, + { + "description": "DID and tag policy management", + "externalDocs": { + "description": "Design", + "url": "https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage" + }, + "name": "wallet" + } + ], "paths": { "/action-menu/{conn_id}/close": { "post": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/ActionMenuModulesResult" }, - "description": "" - } - }, "parameters": [ { + "description": "Connection identifier", "in": "path", "name": "conn_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActionMenuModulesResult" + } + } + }, "description": "" } }, + "summary": "Close the active menu associated with a connection", + "tags": ["action-menu"] + } + }, + "/action-menu/{conn_id}/fetch": { + "post": { "parameters": [ { + "description": "Connection identifier", "in": "path", "name": "conn_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "type": "string" + } } ], - "tags": ["action-menu"], - "summary": "Fetch the active menu", - "produces": ["application/json"] - } - }, - "/action-menu/{conn_id}/perform": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ActionMenuModulesResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActionMenuFetchResult" + } + } + }, "description": "" } }, + "summary": "Fetch the active menu", + "tags": ["action-menu"] + } + }, + "/action-menu/{conn_id}/perform": { + "post": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/PerformRequest" } - }, - { + "description": "Connection identifier", "in": "path", "name": "conn_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "type": "string" + } } ], - "tags": ["action-menu"], - "summary": "Perform an action associated with the active menu", - "produces": ["application/json"] - } - }, - "/action-menu/{conn_id}/request": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PerformRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/ActionMenuModulesResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActionMenuModulesResult" + } + } + }, "description": "" } }, + "summary": "Perform an action associated with the active menu", + "tags": ["action-menu"], + "x-codegen-request-body-name": "body" + } + }, + "/action-menu/{conn_id}/request": { + "post": { "parameters": [ { + "description": "Connection identifier", "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": { + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "schema": { "$ref": "#/definitions/ActionMenuModulesResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActionMenuModulesResult" + } + } + }, "description": "" } }, + "summary": "Request the active menu", + "tags": ["action-menu"] + } + }, + "/action-menu/{conn_id}/send-menu": { + "post": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/SendMenu" } - }, - { + "description": "Connection identifier", "in": "path", "name": "conn_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "type": "string" + } } ], - "tags": ["action-menu"], - "summary": "Send an action menu to a connection", - "produces": ["application/json"] - } - }, - "/connections": { - "get": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SendMenu" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnectionList" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActionMenuModulesResult" + } + } + }, "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"] + "summary": "Send an action menu to a connection", + "tags": ["action-menu"], + "x-codegen-request-body-name": "body" } }, - "/connections/create-invitation": { + "/anoncreds/credential-definition": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CredDefPostRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/InvitationResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredDefResult" + } + } + }, "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"] + "summary": "Create a credential definition on the connected ledger", + "tags": ["anoncreds - credential definitions"], + "x-codegen-request-body-name": "body" } }, - "/connections/create-static": { - "post": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/ConnectionStaticResult" }, - "description": "" - } - }, + "/anoncreds/credential-definition/{cred_def_id}": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/ConnectionStaticRequest" } + "description": "Credential definition identifier", + "in": "path", + "name": "cred_def_id", + "required": true, + "schema": { + "type": "string" + } } ], - "tags": ["connection"], - "summary": "Create a new static connection", - "produces": ["application/json"] - } - }, - "/connections/receive-invitation": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetCredDefResult" + } + } + }, "description": "" } }, + "summary": "Retrieve an individual credential definition details", + "tags": ["anoncreds - credential definitions"] + } + }, + "/anoncreds/credential-definitions": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/ReceiveInvitationRequest" } + "description": "Issuer Identifier of the credential definition", + "in": "query", + "name": "issuer_id", + "schema": { + "type": "string" + } }, { + "description": "Schema identifier", "in": "query", - "name": "alias", - "required": false, - "type": "string", - "description": "Alias", - "example": "Barry" + "name": "schema_id", + "schema": { + "type": "string" + } }, { + "description": "Schema name", "in": "query", - "name": "auto_accept", - "required": false, - "type": "boolean", - "description": "Auto-accept connection (defaults to configuration)" + "name": "schema_name", + "schema": { + "type": "string" + } }, { + "description": "Schema version", "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" + "name": "schema_version", + "schema": { + "type": "string" + } } ], - "tags": ["connection"], - "summary": "Receive a new connection invitation", - "produces": ["application/json"] - } - }, - "/connections/{conn_id}": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetCredDefsResponse" + } + } + }, "description": "" } }, + "summary": "Retrieve all credential definition ids", + "tags": ["anoncreds - credential definitions"] + } + }, + "/anoncreds/registry/{rev_reg_id}/active": { + "put": { "parameters": [ { + "description": "Revocation Registry identifier", "in": "path", - "name": "conn_id", + "name": "rev_reg_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "tags": ["connection"], - "summary": "Fetch a single connection record", - "produces": ["application/json"] - }, - "delete": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnectionModuleResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevocationModuleResponse" + } + } + }, "description": "" } }, + "summary": "Update the active registry", + "tags": ["anoncreds - revocation"] + } + }, + "/anoncreds/registry/{rev_reg_id}/tails-file": { + "put": { "parameters": [ { + "description": "Revocation Registry identifier", "in": "path", - "name": "conn_id", + "name": "rev_reg_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "tags": ["connection"], - "summary": "Remove an existing connection record", - "produces": ["application/json"] + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevocationModuleResponse" + } + } + }, + "description": "" + } + }, + "summary": "Upload local tails file to server", + "tags": ["anoncreds - revocation"] } }, - "/connections/{conn_id}/accept-invitation": { + "/anoncreds/revocation-list": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/RevListCreateRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevListResult" + } + } + }, + "description": "" + } + }, + "summary": "Create and publish a revocation status list on the connected ledger", + "tags": ["anoncreds - revocation"], + "x-codegen-request-body-name": "body" + } + }, + "/anoncreds/revocation-registry-definition": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/RevRegCreateRequestSchemaAnoncreds" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegDefResult" + } + } + }, "description": "" } }, + "summary": "Create and publish a registration revocation on the connected ledger", + "tags": ["anoncreds - revocation"], + "x-codegen-request-body-name": "body" + } + }, + "/anoncreds/revocation/active-registry/{cred_def_id}": { + "get": { "parameters": [ { + "description": "Credential definition identifier", "in": "path", - "name": "conn_id", + "name": "cred_def_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegResultSchemaAnoncreds" + } + } + }, + "description": "" + } + }, + "summary": "Get current active revocation registry by credential definition id", + "tags": ["anoncreds - revocation"] + } + }, + "/anoncreds/revocation/active-registry/{cred_def_id}/rotate": { + "post": { + "parameters": [ + { + "description": "Credential definition identifier", + "in": "path", + "name": "cred_def_id", + "required": true, + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegsCreatedSchemaAnoncreds" + } + } + }, + "description": "" + } + }, + "summary": "Rotate revocation registry", + "tags": ["anoncreds - revocation"] + } + }, + "/anoncreds/revocation/credential-record": { + "get": { + "parameters": [ { + "description": "Credential exchange identifier", "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" + "name": "cred_ex_id", + "schema": { + "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" + } }, { + "description": "Credential revocation identifier", "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" + "name": "cred_rev_id", + "schema": { + "pattern": "^[1-9][0-9]*$", + "type": "string" + } }, { + "description": "Revocation registry identifier", "in": "query", - "name": "my_label", - "required": false, - "type": "string", - "description": "Label for connection", - "example": "Broker" + "name": "rev_reg_id", + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "tags": ["connection"], - "summary": "Accept a stored connection invitation", - "produces": ["application/json"] + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredRevRecordResult" + } + } + }, + "description": "" + } + }, + "summary": "Get credential revocation status", + "tags": ["anoncreds - revocation"] } }, - "/connections/{conn_id}/accept-request": { + "/anoncreds/revocation/publish-revocations": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublishRevocations" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublishRevocationsResult" + } + } + }, "description": "" } }, + "summary": "Publish pending revocations to ledger", + "tags": ["anoncreds - revocation"], + "x-codegen-request-body-name": "body" + } + }, + "/anoncreds/revocation/registries": { + "get": { "parameters": [ { - "in": "path", - "name": "conn_id", - "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "description": "Credential definition identifier", + "in": "query", + "name": "cred_def_id", + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + } }, { + "description": "Revocation registry state", "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" + "name": "state", + "schema": { + "enum": [ + "finished", + "failed", + "action", + "wait", + "decommissioned", + "full" + ], + "type": "string" + } } ], - "tags": ["connection"], - "summary": "Accept a stored connection request", - "produces": ["application/json"] - } - }, - "/connections/{conn_id}/endpoints": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/EndpointsResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegsCreatedSchemaAnoncreds" + } + } + }, "description": "" } }, + "summary": "Search for matching revocation registries that current agent created", + "tags": ["anoncreds - revocation"] + } + }, + "/anoncreds/revocation/registry/{rev_reg_id}": { + "get": { "parameters": [ { + "description": "Revocation Registry identifier", "in": "path", - "name": "conn_id", + "name": "rev_reg_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "tags": ["connection"], - "summary": "Fetch connection remote endpoint", - "produces": ["application/json"] - } - }, - "/connections/{conn_id}/metadata": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnectionMetadata" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegResultSchemaAnoncreds" + } + } + }, "description": "" } }, + "summary": "Get revocation registry by revocation registry id", + "tags": ["anoncreds - revocation"] + } + }, + "/anoncreds/revocation/registry/{rev_reg_id}/fix-revocation-entry-state": { + "put": { "parameters": [ { + "description": "Revocation Registry identifier", "in": "path", - "name": "conn_id", + "name": "rev_reg_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } }, { + "description": "Apply updated accumulator transaction to ledger", "in": "query", - "name": "key", - "required": false, - "type": "string", - "description": "Key to retrieve." + "name": "apply_ledger_update", + "required": true, + "schema": { + "type": "boolean" + } } ], - "tags": ["connection"], - "summary": "Fetch connection metadata", - "produces": ["application/json"] - }, - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnectionMetadata" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegWalletUpdatedResultSchemaAnoncreds" + } + } + }, "description": "" } }, + "summary": "Fix revocation state in wallet and return number of updated entries", + "tags": ["anoncreds - revocation"] + } + }, + "/anoncreds/revocation/registry/{rev_reg_id}/issued": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/ConnectionMetadataSetRequest" } - }, - { + "description": "Revocation Registry identifier", "in": "path", - "name": "conn_id", + "name": "rev_reg_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "tags": ["connection"], - "summary": "Set connection metadata", - "produces": ["application/json"] - } - }, - "/connections/{conn_id}/send-message": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/BasicMessageModuleResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegIssuedResultSchemaAnoncreds" + } + } + }, "description": "" } }, + "summary": "Get number of credentials issued against revocation registry", + "tags": ["anoncreds - revocation"] + } + }, + "/anoncreds/revocation/registry/{rev_reg_id}/issued/details": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/SendMessage" } - }, - { + "description": "Revocation Registry identifier", "in": "path", - "name": "conn_id", + "name": "rev_reg_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredRevRecordDetailsResultSchemaAnoncreds" + } + } + }, "description": "" } }, + "summary": "Get details of credentials issued against revocation registry", + "tags": ["anoncreds - revocation"] + } + }, + "/anoncreds/revocation/registry/{rev_reg_id}/issued/indy_recs": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/PingRequest" } - }, - { + "description": "Revocation Registry identifier", "in": "path", - "name": "conn_id", + "name": "rev_reg_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredRevIndyRecordsResultSchemaAnoncreds" + } + } + }, "description": "" } }, + "summary": "Get details of revoked credentials from ledger", + "tags": ["anoncreds - revocation"] + } + }, + "/anoncreds/revocation/registry/{rev_reg_id}/set-state": { + "patch": { "parameters": [ { + "description": "Revocation Registry identifier", "in": "path", - "name": "conn_id", + "name": "rev_reg_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } }, { + "description": "Revocation registry state to set", "in": "query", - "name": "target_connection_id", + "name": "state", "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 ..." + "schema": { + "enum": [ + "finished", + "failed", + "action", + "wait", + "decommissioned", + "full" + ], + "type": "string" + } } ], - "tags": ["introduction"], - "summary": "Start an introduction between two connections", - "produces": ["application/json"] - } - }, - "/credential-definitions": { - "post": { "responses": { "200": { - "schema": { - "$ref": "#/definitions/TxnOrCredentialDefinitionSendResult" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegResultSchemaAnoncreds" + } + } }, "description": "" } }, + "summary": "Set revocation registry state manually", + "tags": ["anoncreds - revocation"] + } + }, + "/anoncreds/revocation/registry/{rev_reg_id}/tails-file": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", + "description": "Revocation Registry identifier", + "in": "path", + "name": "rev_reg_id", + "required": true, "schema": { - "$ref": "#/definitions/CredentialDefinitionSendRequest" + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" } - }, - { - "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" + "content": { + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/RevocationAnoncredsModuleResponse" + } + } }, - "description": "" + "description": "tails file" } }, - "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"] + "summary": "Download tails file", + "tags": ["anoncreds - revocation"] } }, - "/credential-definitions/{cred_def_id}": { - "get": { + "/anoncreds/revocation/revoke": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/RevokeRequestSchemaAnoncreds" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/CredentialDefinitionGetResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevocationAnoncredsModuleResponse" + } + } + }, "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"] + "summary": "Revoke an issued credential", + "tags": ["anoncreds - revocation"], + "x-codegen-request-body-name": "body" } }, - "/credential-definitions/{cred_def_id}/write_record": { + "/anoncreds/schema": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SchemaPostRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/CredentialDefinitionGetResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SchemaResult" + } + } + }, "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"] + "summary": "Create a schema on the connected ledger", + "tags": ["anoncreds - schemas"], + "x-codegen-request-body-name": "body" } }, - "/credential/mime-types/{credential_id}": { + "/anoncreds/schema/{schema_id}": { "get": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/AttributeMimeTypesResult" }, - "description": "" - } - }, "parameters": [ { + "description": "Schema identifier", "in": "path", - "name": "credential_id", + "name": "schema_id", "required": true, - "type": "string", - "description": "Credential identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "type": "string" + } } ], - "tags": ["credentials"], - "summary": "Get attribute MIME types from wallet", - "produces": ["application/json"] - } - }, - "/credential/revoked/{credential_id}": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/CredRevokedResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetSchemaResult" + } + } + }, "description": "" } }, + "summary": "Retrieve an individual schemas details", + "tags": ["anoncreds - schemas"] + } + }, + "/anoncreds/schemas": { + "get": { "parameters": [ { - "in": "path", - "name": "credential_id", - "required": true, - "type": "string", - "description": "Credential identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "description": "Schema issuer identifier", + "in": "query", + "name": "schema_issuer_id", + "schema": { + "type": "string" + } }, { + "description": "Schema name", "in": "query", - "name": "from", - "required": false, - "type": "string", - "pattern": "^[0-9]*$", - "description": "Earliest epoch of revocation status interval of interest", - "example": "0" + "name": "schema_name", + "schema": { + "type": "string" + } }, { + "description": "Schema version", "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" + "name": "schema_version", + "schema": { + "type": "string" + } } ], - "tags": ["credentials"], - "summary": "Fetch credential from wallet by id", - "produces": ["application/json"] - }, - "delete": { "responses": { "200": { - "schema": { "$ref": "#/definitions/HolderModuleResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetSchemasResponse" + } + } + }, "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"] + "summary": "Retrieve all schema ids", + "tags": ["anoncreds - schemas"] } }, - "/credentials": { + "/connections": { "get": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/CredInfoList" }, - "description": "" - } - }, "parameters": [ { + "description": "Alias", "in": "query", - "name": "count", - "required": false, - "type": "string", - "pattern": "^[1-9][0-9]*$", - "description": "Maximum number to retrieve", - "example": "1" + "name": "alias", + "schema": { + "type": "string" + } }, { + "description": "Connection protocol used", "in": "query", - "name": "start", - "required": false, - "type": "string", - "pattern": "^[0-9]*$", - "description": "Start index", - "example": "0" + "name": "connection_protocol", + "schema": { + "enum": ["connections/1.0", "didexchange/1.0", "didexchange/1.1"], + "type": "string" + } }, { + "description": "invitation key", "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": [ + "name": "invitation_key", + "schema": { + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + } + }, { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/W3CCredentialsListRequest" } + "description": "Identifier of the associated Invitation Message", + "in": "query", + "name": "invitation_msg_id", + "schema": { + "type": "string" + } }, { + "description": "My DID", "in": "query", - "name": "count", - "required": false, - "type": "string", - "pattern": "^[1-9][0-9]*$", - "description": "Maximum number to retrieve", - "example": "1" + "name": "my_did", + "schema": { + "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" + } }, { + "description": "Connection state", "in": "query", - "name": "start", - "required": false, - "type": "string", - "pattern": "^[0-9]*$", - "description": "Start index", - "example": "0" + "name": "state", + "schema": { + "enum": [ + "abandoned", + "active", + "completed", + "error", + "init", + "invitation", + "request", + "response", + "start" + ], + "type": "string" + } }, { + "description": "Their DID", "in": "query", - "name": "wql", - "required": false, - "type": "string", - "pattern": "^{.*}$", - "description": "(JSON) WQL query", - "example": "{\"attr::name::value\": \"Alex\"}" + "name": "their_did", + "schema": { + "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" + } + }, + { + "description": "Their Public DID", + "in": "query", + "name": "their_public_did", + "schema": { + "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" + } + }, + { + "description": "Their role in the connection protocol", + "in": "query", + "name": "their_role", + "schema": { + "enum": ["invitee", "requester", "inviter", "responder"], + "type": "string" + } } ], - "tags": ["credentials"], - "summary": "Fetch W3C credentials from wallet", - "produces": ["application/json"] - } - }, - "/didexchange/create-request": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionList" + } + } + }, "description": "" } }, + "summary": "Query agent-to-agent connections", + "tags": ["connection"] + } + }, + "/connections/create-invitation": { + "post": { + "deprecated": true, "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" - }, - { + "description": "Alias", "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" + "schema": { + "type": "string" + } }, { + "description": "Auto-accept connection (defaults to configuration)", "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" + "name": "auto_accept", + "schema": { + "type": "boolean" + } }, { + "description": "Create invitation for multiple use (default false)", "in": "query", - "name": "my_label", - "required": false, - "type": "string", - "description": "Label for connection request", - "example": "Broker" + "name": "multi_use", + "schema": { + "type": "boolean" + } }, { + "description": "Create invitation from public DID (default false)", "in": "query", - "name": "use_public_did", - "required": false, - "type": "boolean", - "description": "Use public DID for this connection" + "name": "public", + "schema": { + "type": "boolean" + } } ], - "tags": ["did-exchange"], - "summary": "Create and send a request against public DID's implicit invitation", - "produces": ["application/json"] + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateInvitationRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationResult" + } + } + }, + "description": "" + } + }, + "summary": "Create a new connection invitation", + "tags": ["connection"], + "x-codegen-request-body-name": "body" } }, - "/didexchange/receive-request": { + "/connections/create-static": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ConnectionStaticRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionStaticResult" + } + } + }, "description": "" } }, + "summary": "Create a new static connection", + "tags": ["connection"], + "x-codegen-request-body-name": "body" + } + }, + "/connections/receive-invitation": { + "post": { + "deprecated": true, "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/DIDXRequest" } - }, - { + "description": "Alias", "in": "query", "name": "alias", - "required": false, - "type": "string", - "description": "Alias for connection", - "example": "Barry" + "schema": { + "type": "string" + } }, { + "description": "Auto-accept connection (defaults to configuration)", "in": "query", "name": "auto_accept", - "required": false, - "type": "boolean", - "description": "Auto-accept connection (defaults to configuration)" + "schema": { + "type": "boolean" + } }, { - "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" + "name": "mediation_id", + "schema": { + "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" + } } ], - "tags": ["did-exchange"], - "summary": "Receive request against public DID's implicit invitation", - "produces": ["application/json"] + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ReceiveInvitationRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnRecord" + } + } + }, + "description": "" + } + }, + "summary": "Receive a new connection invitation", + "tags": ["connection"], + "x-codegen-request-body-name": "body" } }, - "/didexchange/{conn_id}/accept-invitation": { - "post": { + "/connections/{conn_id}": { + "delete": { + "parameters": [ + { + "description": "Connection identifier", + "in": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionModuleResponse" + } + } + }, "description": "" } }, + "summary": "Remove an existing connection record", + "tags": ["connection"] + }, + "get": { "parameters": [ { + "description": "Connection identifier", "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" + "schema": { + "type": "string" + } } ], - "tags": ["did-exchange"], - "summary": "Accept a stored connection invitation", - "produces": ["application/json"] - } - }, - "/didexchange/{conn_id}/accept-request": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnRecord" + } + } + }, "description": "" } }, + "summary": "Fetch a single connection record", + "tags": ["connection"] + } + }, + "/connections/{conn_id}/accept-invitation": { + "post": { + "deprecated": true, "parameters": [ { + "description": "Connection identifier", "in": "path", "name": "conn_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "type": "string" + } }, { + "description": "Identifier for active mediation record to be used", "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" + "schema": { + "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" + } }, { - "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" + "name": "my_endpoint", + "schema": { + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + } + }, + { + "description": "Label for connection", + "in": "query", + "name": "my_label", + "schema": { + "type": "string" + } } ], - "tags": ["did-exchange"], - "summary": "Accept a stored connection request", - "produces": ["application/json"] - } - }, - "/didexchange/{conn_id}/reject": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ConnRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnRecord" + } + } + }, "description": "" } }, + "summary": "Accept a stored connection invitation", + "tags": ["connection"] + } + }, + "/connections/{conn_id}/accept-request": { + "post": { + "deprecated": true, "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/DIDXRejectRequest" } - }, - { + "description": "Connection identifier", "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": "*" + "schema": { + "type": "string" + } }, { + "description": "My URL endpoint", "in": "query", - "name": "query_protocol", - "required": false, - "type": "string", - "description": "Protocol feature-type query", - "example": "*" + "name": "my_endpoint", + "schema": { + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + } } ], - "tags": ["discover-features v2.0"], - "summary": "Query supported features", - "produces": ["application/json"] - } - }, - "/discover-features-2.0/records": { - "get": { "responses": { "200": { - "schema": { - "$ref": "#/definitions/V20DiscoveryExchangeListResult" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnRecord" + } + } }, "description": "" } }, + "summary": "Accept a stored connection request", + "tags": ["connection"] + } + }, + "/connections/{conn_id}/endpoints": { + "get": { "parameters": [ { - "in": "query", - "name": "connection_id", - "required": false, - "type": "string", "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "in": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } } ], - "tags": ["discover-features v2.0"], - "summary": "Discover Features v2.0 records", - "produces": ["application/json"] - } - }, - "/discover-features/query": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/V10DiscoveryRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EndpointsResult" + } + } + }, "description": "" } }, + "summary": "Fetch connection remote endpoint", + "tags": ["connection"] + } + }, + "/connections/{conn_id}/metadata": { + "get": { "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" + "description": "Connection identifier", + "in": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } }, { + "description": "Key to retrieve.", "in": "query", - "name": "query", - "required": false, - "type": "string", - "description": "Protocol feature query", - "example": "*" + "name": "key", + "schema": { + "type": "string" + } } ], - "tags": ["discover-features"], - "summary": "Query supported features", - "produces": ["application/json"] - } - }, - "/discover-features/records": { - "get": { "responses": { "200": { - "schema": { - "$ref": "#/definitions/V10DiscoveryExchangeListResult" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionMetadata" + } + } }, "description": "" } }, + "summary": "Fetch connection metadata", + "tags": ["connection"] + }, + "post": { "parameters": [ { - "in": "query", - "name": "connection_id", - "required": false, - "type": "string", "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "in": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } } ], - "tags": ["discover-features"], - "summary": "Discover Features records", - "produces": ["application/json"] - } - }, - "/issue-credential-2.0/create": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ConnectionMetadataSetRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/V20CredExRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectionMetadata" + } + } + }, "description": "" } }, + "summary": "Set connection metadata", + "tags": ["connection"], + "x-codegen-request-body-name": "body" + } + }, + "/connections/{conn_id}/send-message": { + "post": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V20IssueCredSchemaCore" } + "description": "Connection identifier", + "in": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } } ], - "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": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SendMessage" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/V20CredExRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BasicMessageModuleResponse" + } + } + }, "description": "" } }, + "summary": "Send a basic message to a connection", + "tags": ["basicmessage"], + "x-codegen-request-body-name": "body" + } + }, + "/connections/{conn_id}/send-ping": { + "post": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V20CredOfferConnFreeRequest" } + "description": "Connection identifier", + "in": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } } ], - "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": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PingRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/V20CredExRecordListResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PingRequestResponse" + } + } + }, "description": "" } }, + "summary": "Send a trust ping to a connection", + "tags": ["trustping"], + "x-codegen-request-body-name": "body" + } + }, + "/connections/{conn_id}/start-introduction": { + "post": { "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": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } }, { + "description": "Target connection identifier", "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" + "name": "target_connection_id", + "required": true, + "schema": { + "type": "string" + } }, { + "description": "Message", "in": "query", - "name": "thread_id", - "required": false, - "type": "string", - "format": "uuid", - "description": "Thread identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "name": "message", + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntroModuleResponse" + } + } + }, "description": "" } }, + "summary": "Start an introduction between two connections", + "tags": ["introduction"] + } + }, + "/credential-definitions": { + "post": { "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" + "description": "Connection identifier", + "in": "query", + "name": "conn_id", + "schema": { + "type": "string" + } + }, + { + "description": "Create Transaction For Endorser's signature", + "in": "query", + "name": "create_transaction_for_endorser", + "schema": { + "type": "boolean" + } } ], - "tags": ["issue-credential v2.0"], - "summary": "Fetch a single credential exchange record", - "produces": ["application/json"] - }, - "delete": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CredentialDefinitionSendRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { - "$ref": "#/definitions/V20IssueCredentialModuleResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TxnOrCredentialDefinitionSendResult" + } + } }, "description": "" } }, + "summary": "Sends a credential definition to the ledger", + "tags": ["credential-definition"], + "x-codegen-request-body-name": "body" + } + }, + "/credential-definitions/created": { + "get": { "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" + "description": "Credential definition id", + "in": "query", + "name": "cred_def_id", + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + } + }, + { + "description": "Issuer DID", + "in": "query", + "name": "issuer_did", + "schema": { + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + } + }, + { + "description": "Schema identifier", + "in": "query", + "name": "schema_id", + "schema": { + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + } + }, + { + "description": "Schema issuer DID", + "in": "query", + "name": "schema_issuer_did", + "schema": { + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + } + }, + { + "description": "Schema name", + "in": "query", + "name": "schema_name", + "schema": { + "type": "string" + } + }, + { + "description": "Schema version", + "in": "query", + "name": "schema_version", + "schema": { + "pattern": "^[0-9.]+$", + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialDefinitionsCreatedResult" + } + } + }, "description": "" } }, + "summary": "Search for matching credential definitions that agent originated", + "tags": ["credential-definition"] + } + }, + "/credential-definitions/{cred_def_id}": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V20CredIssueRequest" } - }, - { + "description": "Credential definition identifier", "in": "path", - "name": "cred_ex_id", + "name": "cred_def_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" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + } } ], - "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" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialDefinitionGetResult" + } + } }, "description": "" } }, + "summary": "Gets a credential definition from the ledger", + "tags": ["credential-definition"] + } + }, + "/credential-definitions/{cred_def_id}/write_record": { + "post": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { - "$ref": "#/definitions/V20CredIssueProblemReportRequest" - } - }, - { + "description": "Credential definition identifier", "in": "path", - "name": "cred_ex_id", + "name": "cred_def_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" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialDefinitionGetResult" + } + } + }, "description": "" } }, + "summary": "Writes a credential definition non-secret record to the wallet", + "tags": ["credential-definition"] + } + }, + "/credential/mime-types/{credential_id}": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V20CredBoundOfferRequest" } - }, - { + "description": "Credential identifier", "in": "path", - "name": "cred_ex_id", + "name": "credential_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" + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AttributeMimeTypesResult" + } + } + }, "description": "" } }, + "summary": "Get attribute MIME types from wallet", + "tags": ["credentials"] + } + }, + "/credential/revoked/{credential_id}": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V20CredRequestRequest" } - }, - { + "description": "Credential identifier", "in": "path", - "name": "cred_ex_id", + "name": "credential_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" + "schema": { + "type": "string" + } + }, + { + "description": "Earliest epoch of revocation status interval of interest", + "in": "query", + "name": "from", + "schema": { + "pattern": "^[0-9]*$", + "type": "string" + } + }, + { + "description": "Latest epoch of revocation status interval of interest", + "in": "query", + "name": "to", + "schema": { + "pattern": "^[0-9]*$", + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredRevokedResult" + } + } + }, "description": "" } }, + "summary": "Query credential revocation status by id", + "tags": ["credentials"] + } + }, + "/credential/w3c/{credential_id}": { + "delete": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V20CredStoreRequest" } - }, - { + "description": "Credential identifier", "in": "path", - "name": "cred_ex_id", + "name": "credential_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" + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HolderModuleResponse" + } + } + }, "description": "" } }, + "summary": "Remove W3C credential from wallet by id", + "tags": ["credentials"] + }, + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V20CredExFree" } + "description": "Credential identifier", + "in": "path", + "name": "credential_id", + "required": true, + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VCRecord" + } + } + }, "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"] + "summary": "Fetch W3C credential from wallet by id", + "tags": ["credentials"] } }, - "/issue-credential-2.0/send-proposal": { - "post": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/V20CredExRecord" }, - "description": "" - } - }, + "/credential/{credential_id}": { + "delete": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V20CredExFree" } + "description": "Credential identifier", + "in": "path", + "name": "credential_id", + "required": true, + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HolderModuleResponse" + } + } + }, "description": "" } }, + "summary": "Remove credential from wallet by id", + "tags": ["credentials"] + }, + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V20CredRequestFree" } + "description": "Credential identifier", + "in": "path", + "name": "credential_id", + "required": true, + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndyCredInfo" + } + } + }, "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"] + "summary": "Fetch credential from wallet by id", + "tags": ["credentials"] } }, - "/issue-credential/create-offer": { - "post": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/V10CredentialExchange" }, - "description": "" - } - }, + "/credentials": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", + "description": "Maximum number to retrieve", + "in": "query", + "name": "count", + "schema": { + "pattern": "^[1-9][0-9]*$", + "type": "string" + } + }, + { + "description": "Start index", + "in": "query", + "name": "start", + "schema": { + "pattern": "^[0-9]*$", + "type": "string" + } + }, + { + "description": "(JSON) WQL query", + "in": "query", + "name": "wql", "schema": { - "$ref": "#/definitions/V10CredentialConnFreeOfferRequest" + "pattern": "^{.*}$", + "type": "string" } } ], - "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" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredInfoList" + } + } }, "description": "" } }, + "summary": "Fetch credentials from wallet", + "tags": ["credentials"] + } + }, + "/credentials/w3c": { + "post": { "parameters": [ { + "description": "Maximum number to retrieve", "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" + "name": "count", + "schema": { + "pattern": "^[1-9][0-9]*$", + "type": "string" + } }, { + "description": "Start index", "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" + "name": "start", + "schema": { + "pattern": "^[0-9]*$", + "type": "string" + } }, { + "description": "(JSON) WQL query", "in": "query", - "name": "thread_id", - "required": false, - "type": "string", - "format": "uuid", - "description": "Thread identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "name": "wql", + "schema": { + "pattern": "^{.*}$", + "type": "string" + } } ], - "tags": ["issue-credential v1.0"], - "summary": "Fetch all credential exchange records", - "produces": ["application/json"] - } - }, - "/issue-credential/records/{cred_ex_id}": { - "get": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/W3CCredentialsListRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VCRecordList" + } + } + }, "description": "" } }, + "summary": "Fetch W3C credentials from wallet", + "tags": ["credentials"], + "x-codegen-request-body-name": "body" + } + }, + "/did-rotate/{conn_id}/hangup": { + "post": { "parameters": [ { + "description": "Connection identifier", "in": "path", - "name": "cred_ex_id", + "name": "conn_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" + "schema": { + "type": "string" + } } ], - "tags": ["issue-credential v1.0"], - "summary": "Fetch a single credential exchange record", - "produces": ["application/json"] - }, - "delete": { "responses": { "200": { - "schema": { "$ref": "#/definitions/IssueCredentialModuleResponse" }, - "description": "" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Hangup" + } + } + }, + "description": "Hangup agent message for observer" } }, - "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"] + "summary": "Send hangup of DID rotation as a rotator", + "tags": ["did-rotate"] } }, - "/issue-credential/records/{cred_ex_id}/issue": { + "/did-rotate/{conn_id}/rotate": { "post": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/V10CredentialExchange" }, - "description": "" - } - }, "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V10CredentialIssueRequest" } - }, - { + "description": "Connection identifier", "in": "path", - "name": "cred_ex_id", + "name": "conn_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" + "type": "string" } - }, - { - "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": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DIDRotateRequestJSON" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/V10CredentialExchange" }, - "description": "" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Rotate" + } + } + }, + "description": "Rotate agent message for observer" } }, - "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"] + "summary": "Begin rotation of a DID as a rotator", + "tags": ["did-rotate"], + "x-codegen-request-body-name": "body" } }, - "/issue-credential/records/{cred_ex_id}/send-request": { + "/didexchange/create-request": { "post": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/V10CredentialExchange" }, - "description": "" - } - }, "parameters": [ { - "in": "body", - "required": false, - "name": "body", + "description": "Qualified public DID to which to request connection", + "in": "query", + "name": "their_public_did", + "required": true, "schema": { - "$ref": "#/definitions/V10CredentialExchangeAutoRemoveRequest" + "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" } }, { - "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" - } + "description": "Alias for connection", + "in": "query", + "name": "alias", + "schema": { + "type": "string" + } + }, + { + "description": "Auto-accept connection (defaults to configuration)", + "in": "query", + "name": "auto_accept", + "schema": { + "type": "boolean" + } + }, + { + "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", + "in": "query", + "name": "goal", + "schema": { + "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", + "in": "query", + "name": "goal_code", + "schema": { + "type": "string" + } + }, + { + "description": "Identifier for active mediation record to be used", + "in": "query", + "name": "mediation_id", + "schema": { + "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" + } + }, + { + "description": "My URL endpoint", + "in": "query", + "name": "my_endpoint", + "schema": { + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + } + }, + { + "description": "Label for connection request", + "in": "query", + "name": "my_label", + "schema": { + "type": "string" + } + }, + { + "description": "Which DID Exchange Protocol version to use", + "in": "query", + "name": "protocol", + "schema": { + "enum": ["didexchange/1.0", "didexchange/1.1"], + "type": "string" + } + }, + { + "description": "The DID to use to for this connection", + "in": "query", + "name": "use_did", + "schema": { + "type": "string" + } + }, + { + "description": "The DID method to use to generate a DID for this connection", + "in": "query", + "name": "use_did_method", + "schema": { + "enum": ["did:peer:2", "did:peer:4"], + "type": "string" + } + }, + { + "description": "Use public DID for this connection", + "in": "query", + "name": "use_public_did", + "schema": { + "type": "boolean" + } + } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnRecord" + } + } + }, "description": "" } }, + "summary": "Create and send a request against public DID's implicit invitation", + "tags": ["did-exchange"] + } + }, + "/didexchange/receive-request": { + "post": { + "deprecated": true, "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V10CredentialStoreRequest" } + "description": "Alias for connection", + "in": "query", + "name": "alias", + "schema": { + "type": "string" + } + }, + { + "description": "Auto-accept connection (defaults to configuration)", + "in": "query", + "name": "auto_accept", + "schema": { + "type": "boolean" + } }, { - "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" + "description": "Identifier for active mediation record to be used", + "in": "query", + "name": "mediation_id", + "schema": { + "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" + } + }, + { + "description": "My URL endpoint", + "in": "query", + "name": "my_endpoint", + "schema": { + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + } } ], - "tags": ["issue-credential v1.0"], - "summary": "Store a received credential", - "produces": ["application/json"] - } - }, - "/issue-credential/send": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DIDXRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/V10CredentialExchange" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnRecord" + } + } + }, "description": "" } }, + "summary": "Receive request against public DID's implicit invitation", + "tags": ["did-exchange"], + "x-codegen-request-body-name": "body" + } + }, + "/didexchange/{conn_id}/accept-invitation": { + "post": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", + "description": "Connection identifier", + "in": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "My URL endpoint", + "in": "query", + "name": "my_endpoint", + "schema": { + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + } + }, + { + "description": "Label for connection request", + "in": "query", + "name": "my_label", + "schema": { + "type": "string" + } + }, + { + "description": "The DID to use to for this connection", + "in": "query", + "name": "use_did", + "schema": { + "type": "string" + } + }, + { + "description": "The DID method to use to generate a DID for this connection", + "in": "query", + "name": "use_did_method", "schema": { - "$ref": "#/definitions/V10CredentialProposalRequestMand" + "enum": ["did:peer:2", "did:peer:4"], + "type": "string" } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnRecord" + } + } + }, "description": "" } }, + "summary": "Accept a stored connection invitation", + "tags": ["did-exchange"] + } + }, + "/didexchange/{conn_id}/accept-request": { + "post": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V10CredentialFreeOfferRequest" } + "description": "Connection identifier", + "in": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Identifier for active mediation record to be used", + "in": "query", + "name": "mediation_id", + "schema": { + "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" + } + }, + { + "description": "My URL endpoint", + "in": "query", + "name": "my_endpoint", + "schema": { + "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type": "string" + } + }, + { + "description": "Use public DID for this connection", + "in": "query", + "name": "use_public_did", + "schema": { + "type": "boolean" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnRecord" + } + } + }, "description": "" } }, + "summary": "Accept a stored connection request", + "tags": ["did-exchange"] + } + }, + "/didexchange/{conn_id}/reject": { + "post": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", + "description": "Connection identifier", + "in": "path", + "name": "conn_id", + "required": true, "schema": { - "$ref": "#/definitions/V10CredentialProposalRequestOpt" + "type": "string" } } ], - "tags": ["issue-credential v1.0"], - "summary": "Send issuer a credential proposal", - "produces": ["application/json"] - } - }, - "/jsonld/sign": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DIDXRejectRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/SignResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnRecord" + } + } + }, "description": "" } }, + "summary": "Abandon or reject a DID Exchange", + "tags": ["did-exchange"], + "x-codegen-request-body-name": "body" + } + }, + "/discover-features-2.0/queries": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/SignRequest" } - } + "description": "Connection identifier, if none specified, then the query will provide features for this agent.", + "in": "query", + "name": "connection_id", + "schema": { + "type": "string" + } + }, + { + "description": "Goal-code feature-type query", + "in": "query", + "name": "query_goal_code", + "schema": { + "type": "string" + } + }, + { + "description": "Protocol feature-type query", + "in": "query", + "name": "query_protocol", + "schema": { + "type": "string" + } + } ], - "tags": ["jsonld"], - "summary": "Sign a JSON-LD structure and return it", - "produces": ["application/json"] - } - }, - "/jsonld/verify": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/VerifyResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20DiscoveryExchangeResult" + } + } + }, "description": "" } }, + "summary": "Query supported features", + "tags": ["discover-features v2.0"] + } + }, + "/discover-features-2.0/records": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/VerifyRequest" } + "description": "Connection identifier", + "in": "query", + "name": "connection_id", + "schema": { + "type": "string" + } } ], - "tags": ["jsonld"], - "summary": "Verify a JSON-LD structure.", - "produces": ["application/json"] - } - }, - "/ledger/config": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/LedgerConfigList" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20DiscoveryExchangeListResult" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["ledger"], - "summary": "Fetch the multiple ledger configuration currently in use", - "produces": ["application/json"] + "summary": "Discover Features v2.0 records", + "tags": ["discover-features v2.0"] } }, - "/ledger/did-endpoint": { + "/discover-features/query": { "get": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/GetDIDEndpointResponse" }, - "description": "" - } - }, "parameters": [ { + "description": "Comment", "in": "query", - "name": "did", - "required": true, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", - "description": "DID of interest", - "example": "WgWxqztrNooG92RXvxSTWv" + "name": "comment", + "schema": { + "type": "string" + } }, { + "description": "Connection identifier, if none specified, then the query will provide features for this agent.", "in": "query", - "name": "endpoint_type", - "required": false, - "type": "string", - "enum": ["Endpoint", "Profile", "LinkedDomains"], - "description": "Endpoint type of interest (default 'Endpoint')", - "example": "Endpoint" + "name": "connection_id", + "schema": { + "type": "string" + } + }, + { + "description": "Protocol feature query", + "in": "query", + "name": "query", + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10DiscoveryRecord" + } + } + }, "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"] + "summary": "Query supported features", + "tags": ["discover-features"] } }, - "/ledger/get-nym-role": { + "/discover-features/records": { "get": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/GetNymRoleResponse" }, - "description": "" - } - }, "parameters": [ { + "description": "Connection identifier", "in": "query", - "name": "did", - "required": true, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", - "description": "DID of interest", - "example": "WgWxqztrNooG92RXvxSTWv" + "name": "connection_id", + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10DiscoveryExchangeListResult" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["ledger"], - "summary": "Fetch the current write ledger", - "produces": ["application/json"] + "summary": "Discover Features records", + "tags": ["discover-features"] } }, - "/ledger/get-write-ledgers": { - "get": { + "/issue-credential-2.0/create": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20IssueCredSchemaCore" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/ConfigurableWriteLedgers" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecord" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["ledger"], - "summary": "Fetch list of available write ledgers", - "produces": ["application/json"] + "summary": "Create a credential record without sending (generally for use with Out-Of-Band)", + "tags": ["issue-credential v2.0"], + "x-codegen-request-body-name": "body" } }, - "/ledger/register-nym": { + "/issue-credential-2.0/create-offer": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20CredOfferConnFreeRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { - "$ref": "#/definitions/TxnOrRegisterLedgerNymResponse" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecord" + } + } }, "description": "" } }, + "summary": "Create a credential offer, independent of any proposal or connection", + "tags": ["issue-credential v2.0"], + "x-codegen-request-body-name": "body" + } + }, + "/issue-credential-2.0/records": { + "get": { "parameters": [ { + "description": "Connection identifier", "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" + "name": "connection_id", + "schema": { + "type": "string" + } }, { + "description": "Role assigned in credential exchange", "in": "query", - "name": "conn_id", - "required": false, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "name": "role", + "schema": { + "enum": ["issuer", "holder"], + "type": "string" + } }, { + "description": "Credential exchange state", "in": "query", - "name": "create_transaction_for_endorser", - "required": false, - "type": "boolean", - "description": "Create Transaction For Endorser's signature" + "name": "state", + "schema": { + "enum": [ + "proposal-sent", + "proposal-received", + "offer-sent", + "offer-received", + "request-sent", + "request-received", + "credential-issued", + "credential-received", + "done", + "credential-revoked", + "abandoned" + ], + "type": "string" + } }, { + "description": "Thread identifier", "in": "query", - "name": "role", - "required": false, - "type": "string", - "enum": [ - "STEWARD", - "TRUSTEE", - "ENDORSER", - "NETWORK_MONITOR", - "reset" - ], - "description": "Role" + "name": "thread_id", + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecordListResult" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["ledger"], - "summary": "Rotate key pair for public DID.", - "produces": ["application/json"] + "summary": "Fetch all credential exchange records", + "tags": ["issue-credential v2.0"] } }, - "/ledger/taa": { - "get": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/TAAResult" }, - "description": "" + "/issue-credential-2.0/records/{cred_ex_id}": { + "delete": { + "parameters": [ + { + "description": "Credential exchange identifier", + "in": "path", + "name": "cred_ex_id", + "required": true, + "schema": { + "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" + } } - }, - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20IssueCredentialModuleResponse" + } + } + }, "description": "" } }, + "summary": "Remove an existing credential exchange record", + "tags": ["issue-credential v2.0"] + }, + "get": { "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": { + "description": "Credential exchange identifier", + "in": "path", + "name": "cred_ex_id", + "required": true, + "schema": { + "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": { - "schema": { "$ref": "#/definitions/WriteLedger" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecordDetail" + } + } + }, "description": "" } }, + "summary": "Fetch a single credential exchange record", + "tags": ["issue-credential v2.0"] + } + }, + "/issue-credential-2.0/records/{cred_ex_id}/issue": { + "post": { "parameters": [ { + "description": "Credential exchange identifier", "in": "path", - "name": "ledger_id", + "name": "cred_ex_id", "required": true, - "type": "string" + "schema": { + "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" + } } ], - "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": "" - } + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20CredIssueRequest" + } + } + }, + "required": false }, - "parameters": [], - "tags": ["mediation"], - "summary": "Clear default mediator", - "produces": ["application/json"] - } - }, - "/mediation/keylists": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/Keylist" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecordDetail" + } + } + }, "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"] + "summary": "Send holder a credential", + "tags": ["issue-credential v2.0"], + "x-codegen-request-body-name": "body" } }, - "/mediation/keylists/{mediation_id}/send-keylist-query": { + "/issue-credential-2.0/records/{cred_ex_id}/problem-report": { "post": { - "responses": { - "201": { - "schema": { "$ref": "#/definitions/KeylistQuery" }, - "description": "" - } - }, "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/KeylistQueryFilterRequest" } - }, - { + "description": "Credential exchange identifier", "in": "path", - "name": "mediation_id", + "name": "cred_ex_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" + "schema": { + "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" + } } ], - "tags": ["mediation"], - "summary": "Send keylist query to mediator", - "produces": ["application/json"] - } - }, - "/mediation/keylists/{mediation_id}/send-keylist-update": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20CredIssueProblemReportRequest" + } + } + }, + "required": false + }, "responses": { - "201": { - "schema": { "$ref": "#/definitions/KeylistUpdate" }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20IssueCredentialModuleResponse" + } + } + }, "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"] + "summary": "Send a problem report for credential exchange", + "tags": ["issue-credential v2.0"], + "x-codegen-request-body-name": "body" } }, - "/mediation/request/{conn_id}": { + "/issue-credential-2.0/records/{cred_ex_id}/send-offer": { "post": { - "responses": { - "201": { - "schema": { "$ref": "#/definitions/MediationRecord" }, - "description": "" - } - }, "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/MediationCreateRequest" } - }, - { + "description": "Credential exchange identifier", "in": "path", - "name": "conn_id", + "name": "cred_ex_id", "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "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" + } } ], - "tags": ["mediation"], - "summary": "Request mediation from connection", - "produces": ["application/json"] - } - }, - "/mediation/requests": { - "get": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20CredBoundOfferRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/MediationList" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecord" + } + } + }, "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"] + "summary": "Send holder a credential offer in reference to a proposal with preview", + "tags": ["issue-credential v2.0"], + "x-codegen-request-body-name": "body" } }, - "/mediation/requests/{mediation_id}": { - "get": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/MediationRecord" }, - "description": "" - } - }, + "/issue-credential-2.0/records/{cred_ex_id}/send-request": { + "post": { "parameters": [ { + "description": "Credential exchange identifier", "in": "path", - "name": "mediation_id", + "name": "cred_ex_id", "required": true, - "type": "string", - "format": "uuid", - "description": "Mediation record identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "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" + } } ], - "tags": ["mediation"], - "summary": "Retrieve mediation request record", - "produces": ["application/json"] - }, - "delete": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20CredRequestRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/MediationRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecord" + } + } + }, "description": "" } }, + "summary": "Send issuer a credential request", + "tags": ["issue-credential v2.0"], + "x-codegen-request-body-name": "body" + } + }, + "/issue-credential-2.0/records/{cred_ex_id}/store": { + "post": { "parameters": [ { + "description": "Credential exchange identifier", "in": "path", - "name": "mediation_id", + "name": "cred_ex_id", "required": true, - "type": "string", - "format": "uuid", - "description": "Mediation record identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "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" + } } ], - "tags": ["mediation"], - "summary": "Delete mediation request by ID", - "produces": ["application/json"] - } - }, - "/mediation/requests/{mediation_id}/deny": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20CredStoreRequest" + } + } + }, + "required": false + }, "responses": { - "201": { - "schema": { "$ref": "#/definitions/MediationDeny" }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecordDetail" + } + } + }, "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"] + "summary": "Store a received credential", + "tags": ["issue-credential v2.0"], + "x-codegen-request-body-name": "body" } }, - "/mediation/requests/{mediation_id}/grant": { + "/issue-credential-2.0/send": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20CredExFree" + } + } + }, + "required": false + }, "responses": { - "201": { - "schema": { "$ref": "#/definitions/MediationGrant" }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecord" + } + } + }, "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"] + "summary": "Send holder a credential, automating entire flow", + "tags": ["issue-credential v2.0"], + "x-codegen-request-body-name": "body" } }, - "/mediation/update-keylist/{conn_id}": { + "/issue-credential-2.0/send-offer": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20CredOfferRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/KeylistUpdate" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecord" + } + } + }, "description": "" } }, - "parameters": [ - { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/MediationIdMatchInfo" } + "summary": "Send holder a credential offer, independent of any proposal", + "tags": ["issue-credential v2.0"], + "x-codegen-request-body-name": "body" + } + }, + "/issue-credential-2.0/send-proposal": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20CredExFree" + } + } }, - { - "in": "path", - "name": "conn_id", - "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecord" + } + } + }, + "description": "" } - ], - "tags": ["mediation"], - "summary": "Update keylist for a connection", - "produces": ["application/json"] + }, + "summary": "Send issuer a credential proposal", + "tags": ["issue-credential v2.0"], + "x-codegen-request-body-name": "body" } }, - "/mediation/{mediation_id}/default-mediator": { - "put": { + "/issue-credential-2.0/send-request": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20CredRequestFree" + } + } + }, + "required": false + }, "responses": { - "201": { - "schema": { "$ref": "#/definitions/MediationRecord" }, + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20CredExRecord" + } + } + }, "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"] + "summary": "Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request", + "tags": ["issue-credential v2.0"], + "x-codegen-request-body-name": "body" } }, - "/multitenancy/wallet": { + "/issue-credential/create": { "post": { + "deprecated": true, + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10CredentialCreate" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/CreateWalletResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchange" + } + } + }, "description": "" } }, - "parameters": [ - { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/CreateWalletRequest" } - } - ], - "tags": ["multitenancy"], - "summary": "Create a subwallet", - "produces": ["application/json"] + "summary": "Create a credential record without sending (generally for use with Out-Of-Band)", + "tags": ["issue-credential v1.0"], + "x-codegen-request-body-name": "body" } }, - "/multitenancy/wallet/{wallet_id}": { - "get": { + "/issue-credential/create-offer": { + "post": { + "deprecated": true, + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10CredentialConnFreeOfferRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/WalletRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchange" + } + } + }, "description": "" } }, + "summary": "Create a credential offer, independent of any proposal or connection", + "tags": ["issue-credential v1.0"], + "x-codegen-request-body-name": "body" + } + }, + "/issue-credential/records": { + "get": { + "deprecated": true, "parameters": [ { - "in": "path", - "name": "wallet_id", - "required": true, - "type": "string", - "description": "Subwallet identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "description": "Connection identifier", + "in": "query", + "name": "connection_id", + "schema": { + "type": "string" + } + }, + { + "description": "Role assigned in credential exchange", + "in": "query", + "name": "role", + "schema": { + "enum": ["issuer", "holder"], + "type": "string" + } + }, + { + "description": "Credential exchange state", + "in": "query", + "name": "state", + "schema": { + "enum": [ + "proposal_sent", + "proposal_received", + "offer_sent", + "offer_received", + "request_sent", + "request_received", + "credential_issued", + "credential_received", + "credential_acked", + "credential_revoked", + "abandoned" + ], + "type": "string" + } + }, + { + "description": "Thread identifier", + "in": "query", + "name": "thread_id", + "schema": { + "type": "string" + } } ], - "tags": ["multitenancy"], - "summary": "Get a single subwallet", - "produces": ["application/json"] - }, - "put": { "responses": { "200": { - "schema": { "$ref": "#/definitions/WalletRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchangeListResult" + } + } + }, "description": "" } }, + "summary": "Fetch all credential exchange records", + "tags": ["issue-credential v1.0"] + } + }, + "/issue-credential/records/{cred_ex_id}": { + "delete": { + "deprecated": true, "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/UpdateWalletRequest" } - }, - { + "description": "Credential exchange identifier", "in": "path", - "name": "wallet_id", + "name": "cred_ex_id", "required": true, - "type": "string", - "description": "Subwallet identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "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" + } } ], - "tags": ["multitenancy"], - "summary": "Update a subwallet", - "produces": ["application/json"] - } - }, - "/multitenancy/wallet/{wallet_id}/remove": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/MultitenantModuleResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IssueCredentialModuleResponse" + } + } + }, "description": "" } }, + "summary": "Remove an existing credential exchange record", + "tags": ["issue-credential v1.0"] + }, + "get": { + "deprecated": true, "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/RemoveWalletRequest" } - }, - { + "description": "Credential exchange identifier", "in": "path", - "name": "wallet_id", + "name": "cred_ex_id", "required": true, - "type": "string", - "description": "Subwallet identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "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" + } } ], - "tags": ["multitenancy"], - "summary": "Remove a subwallet", - "produces": ["application/json"] - } - }, - "/multitenancy/wallet/{wallet_id}/token": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/CreateWalletTokenResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchange" + } + } + }, "description": "" } }, + "summary": "Fetch a single credential exchange record", + "tags": ["issue-credential v1.0"] + } + }, + "/issue-credential/records/{cred_ex_id}/issue": { + "post": { + "deprecated": true, "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/CreateWalletTokenRequest" } - }, - { + "description": "Credential exchange identifier", "in": "path", - "name": "wallet_id", + "name": "cred_ex_id", "required": true, - "type": "string" + "schema": { + "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" + } } ], - "tags": ["multitenancy"], - "summary": "Get auth token for a subwallet", - "produces": ["application/json"] - } - }, - "/multitenancy/wallets": { - "get": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10CredentialIssueRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/WalletList" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchange" + } + } + }, "description": "" } }, + "summary": "Send holder a credential", + "tags": ["issue-credential v1.0"], + "x-codegen-request-body-name": "body" + } + }, + "/issue-credential/records/{cred_ex_id}/problem-report": { + "post": { + "deprecated": true, "parameters": [ { - "in": "query", - "name": "wallet_name", - "required": false, - "type": "string", - "description": "Wallet name", - "example": "MyNewWallet" + "description": "Credential exchange identifier", + "in": "path", + "name": "cred_ex_id", + "required": true, + "schema": { + "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" + } } ], - "tags": ["multitenancy"], - "summary": "Query subwallets", - "produces": ["application/json"] - } - }, - "/out-of-band/create-invitation": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10CredentialProblemReportRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/InvitationRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IssueCredentialModuleResponse" + } + } + }, "description": "" } }, + "summary": "Send a problem report for credential exchange", + "tags": ["issue-credential v1.0"], + "x-codegen-request-body-name": "body" + } + }, + "/issue-credential/records/{cred_ex_id}/send-offer": { + "post": { + "deprecated": true, "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)" + "description": "Credential exchange identifier", + "in": "path", + "name": "cred_ex_id", + "required": true, + "schema": { + "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" + } } ], - "tags": ["out-of-band"], - "summary": "Create a new connection invitation", - "produces": ["application/json"] + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10CredentialBoundOfferRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchange" + } + } + }, + "description": "" + } + }, + "summary": "Send holder a credential offer in reference to a proposal with preview", + "tags": ["issue-credential v1.0"], + "x-codegen-request-body-name": "body" } }, - "/out-of-band/receive-invitation": { + "/issue-credential/records/{cred_ex_id}/send-request": { "post": { + "deprecated": true, + "parameters": [ + { + "description": "Credential exchange identifier", + "in": "path", + "name": "cred_ex_id", + "required": true, + "schema": { + "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" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchangeAutoRemoveRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/OobRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchange" + } + } + }, "description": "" } }, + "summary": "Send issuer a credential request", + "tags": ["issue-credential v1.0"], + "x-codegen-request-body-name": "body" + } + }, + "/issue-credential/records/{cred_ex_id}/store": { + "post": { + "deprecated": true, "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" + "description": "Credential exchange identifier", + "in": "path", + "name": "cred_ex_id", + "required": true, + "schema": { + "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" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10CredentialStoreRequest" + } + } }, - { - "in": "query", - "name": "auto_accept", - "required": false, - "type": "boolean", - "description": "Auto-accept connection (defaults to configuration)" + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchange" + } + } + }, + "description": "" + } + }, + "summary": "Store a received credential", + "tags": ["issue-credential v1.0"], + "x-codegen-request-body-name": "body" + } + }, + "/issue-credential/send": { + "post": { + "deprecated": true, + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10CredentialProposalRequestMand" + } + } }, - { - "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" + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchange" + } + } + }, + "description": "" + } + }, + "summary": "Send holder a credential, automating entire flow", + "tags": ["issue-credential v1.0"], + "x-codegen-request-body-name": "body" + } + }, + "/issue-credential/send-offer": { + "post": { + "deprecated": true, + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10CredentialFreeOfferRequest" + } + } }, - { - "in": "query", - "name": "use_existing_connection", - "required": false, - "type": "boolean", - "description": "Use an existing connection, if possible" + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchange" + } + } + }, + "description": "" } - ], - "tags": ["out-of-band"], - "summary": "Receive a new connection invitation", - "produces": ["application/json"] + }, + "summary": "Send holder a credential offer, independent of any proposal", + "tags": ["issue-credential v1.0"], + "x-codegen-request-body-name": "body" } }, - "/plugins": { - "get": { + "/issue-credential/send-proposal": { + "post": { + "deprecated": true, + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10CredentialProposalRequestOpt" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/AdminModules" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10CredentialExchange" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["server"], - "summary": "Fetch the list of loaded plugins", - "produces": ["application/json"] + "summary": "Send issuer a credential proposal", + "tags": ["issue-credential v1.0"], + "x-codegen-request-body-name": "body" } }, - "/present-proof-2.0/create-request": { + "/jsonld/sign": { "post": { + "deprecated": true, + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SignRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignResponse" + } + } + }, "description": "" } }, - "parameters": [ - { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V20PresCreateRequestRequest" } + "summary": "Sign a JSON-LD structure and return it", + "tags": ["jsonld"], + "x-codegen-request-body-name": "body" + } + }, + "/jsonld/verify": { + "post": { + "deprecated": true, + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VerifyRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyResponse" + } + } + }, + "description": "" } - ], - "tags": ["present-proof v2.0"], - "summary": "Creates a presentation request not bound to any proposal or connection", - "produces": ["application/json"] + }, + "summary": "Verify a JSON-LD structure.", + "tags": ["jsonld"], + "x-codegen-request-body-name": "body" } }, - "/present-proof-2.0/records": { + "/ledger/config": { "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/V20PresExRecordList" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LedgerConfigList" + } + } + }, "description": "" } }, + "summary": "Fetch the multiple ledger configuration currently in use", + "tags": ["ledger"] + } + }, + "/ledger/did-endpoint": { + "get": { "parameters": [ { + "description": "DID of interest", "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" + "name": "did", + "required": true, + "schema": { + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + } }, { + "description": "Endpoint type of interest (default 'Endpoint')", "in": "query", - "name": "thread_id", - "required": false, - "type": "string", - "format": "uuid", - "description": "Thread identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "name": "endpoint_type", + "schema": { + "enum": ["Endpoint", "Profile", "LinkedDomains"], + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDIDEndpointResponse" + } + } + }, "description": "" } }, + "summary": "Get the endpoint for a DID from the ledger.", + "tags": ["ledger"] + } + }, + "/ledger/did-verkey": { + "get": { "parameters": [ { - "in": "path", - "name": "pres_ex_id", + "description": "DID of interest", + "in": "query", + "name": "did", "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" + "schema": { + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + } } ], - "tags": ["present-proof v2.0"], - "summary": "Fetch a single presentation exchange record", - "produces": ["application/json"] - }, - "delete": { "responses": { "200": { - "schema": { "$ref": "#/definitions/V20PresentProofModuleResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetDIDVerkeyResponse" + } + } + }, "description": "" } }, + "summary": "Get the verkey for a DID from the ledger.", + "tags": ["ledger"] + } + }, + "/ledger/get-nym-role": { + "get": { "parameters": [ { - "in": "path", - "name": "pres_ex_id", + "description": "DID of interest", + "in": "query", + "name": "did", "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" + "schema": { + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + } } ], - "tags": ["present-proof v2.0"], - "summary": "Remove an existing presentation exchange record", - "produces": ["application/json"] + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetNymRoleResponse" + } + } + }, + "description": "" + } + }, + "summary": "Get the role from the NYM registration of a public DID.", + "tags": ["ledger"] } }, - "/present-proof-2.0/records/{pres_ex_id}/credentials": { + "/ledger/get-write-ledger": { "get": { "responses": { "200": { - "schema": { - "type": "array", - "items": { "$ref": "#/definitions/IndyCredPrecis" } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WriteLedger" + } + } + }, + "description": "" + } + }, + "summary": "Fetch the current write ledger", + "tags": ["ledger"] + } + }, + "/ledger/get-write-ledgers": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigurableWriteLedgers" + } + } }, "description": "" } }, + "summary": "Fetch list of available write ledgers", + "tags": ["ledger"] + } + }, + "/ledger/register-nym": { + "post": { "parameters": [ { - "in": "path", - "name": "pres_ex_id", + "description": "DID to register", + "in": "query", + "name": "did", "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" + "schema": { + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + } }, { + "description": "Verification key", "in": "query", - "name": "count", - "required": false, - "type": "string", - "pattern": "^[1-9][0-9]*$", - "description": "Maximum number to retrieve", - "example": "1" + "name": "verkey", + "required": true, + "schema": { + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + } }, { + "description": "Alias", "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\"}}" + "name": "alias", + "schema": { + "type": "string" + } }, { + "description": "Connection identifier", "in": "query", - "name": "referent", - "required": false, - "type": "string", - "description": "Proof request referents of interest, comma-separated", - "example": "1_name_uuid,2_score_uuid" + "name": "conn_id", + "schema": { + "type": "string" + } }, { + "description": "Create Transaction For Endorser's signature", "in": "query", - "name": "start", - "required": false, - "type": "string", - "pattern": "^[0-9]*$", - "description": "Start index", - "example": "0" + "name": "create_transaction_for_endorser", + "schema": { + "type": "boolean" + } + }, + { + "description": "Role", + "in": "query", + "name": "role", + "schema": { + "enum": [ + "STEWARD", + "TRUSTEE", + "ENDORSER", + "NETWORK_MONITOR", + "reset" + ], + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TxnOrRegisterLedgerNymResponse" + } + } + }, "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"] + "summary": "Send a NYM registration to the ledger.", + "tags": ["ledger"] } }, - "/present-proof-2.0/records/{pres_ex_id}/send-presentation": { - "post": { + "/ledger/rotate-public-did-keypair": { + "patch": { "responses": { "200": { - "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LedgerModulesResult" + } + } + }, "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"] + "summary": "Rotate key pair for public DID.", + "tags": ["ledger"] } }, - "/present-proof-2.0/records/{pres_ex_id}/send-request": { - "post": { + "/ledger/taa": { + "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TAAResult" + } + } + }, "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"] + "summary": "Fetch the current transaction author agreement, if any", + "tags": ["ledger"] } }, - "/present-proof-2.0/records/{pres_ex_id}/verify-presentation": { + "/ledger/taa/accept": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/TAAAccept" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LedgerModulesResult" + } + } + }, "description": "" } }, + "summary": "Accept the transaction author agreement", + "tags": ["ledger"], + "x-codegen-request-body-name": "body" + } + }, + "/ledger/{ledger_id}/set-write-ledger": { + "put": { "parameters": [ { "in": "path", - "name": "pres_ex_id", + "name": "ledger_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" + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WriteLedger" + } + } + }, "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"] + "summary": "Set write ledger", + "tags": ["ledger"] } }, - "/present-proof-2.0/send-request": { - "post": { + "/mediation/default-mediator": { + "delete": { "responses": { - "200": { - "schema": { "$ref": "#/definitions/V20PresExRecord" }, + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediationRecord" + } + } + }, "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": { + "summary": "Clear default mediator", + "tags": ["mediation"] + }, + "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediationRecord" + } + } + }, "description": "" } }, + "summary": "Get default mediator", + "tags": ["mediation"] + } + }, + "/mediation/keylists": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", + "description": "Connection identifier (optional)", + "in": "query", + "name": "conn_id", + "schema": { + "type": "string" + } + }, + { + "description": "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent", + "in": "query", + "name": "role", "schema": { - "$ref": "#/definitions/V10PresentationCreateRequestRequest" + "default": "server", + "enum": ["client", "server"], + "type": "string" } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Keylist" + } + } + }, "description": "" } }, + "summary": "Retrieve keylists by connection or role", + "tags": ["mediation"] + } + }, + "/mediation/keylists/{mediation_id}/send-keylist-query": { + "post": { "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" + "description": "Mediation record identifier", + "in": "path", + "name": "mediation_id", + "required": true, + "schema": { + "type": "string" + } }, { + "description": "limit number of results", "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" + "name": "paginate_limit", + "schema": { + "default": -1, + "format": "int32", + "type": "integer" + } }, { + "description": "offset to use in pagination", "in": "query", - "name": "thread_id", - "required": false, - "type": "string", - "format": "uuid", - "description": "Thread identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "name": "paginate_offset", + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } } ], - "tags": ["present-proof v1.0"], - "summary": "Fetch all present-proof exchange records", - "produces": ["application/json"] - } - }, - "/present-proof/records/{pres_ex_id}": { - "get": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/KeylistQueryFilterRequest" + } + } + }, + "required": false + }, "responses": { - "200": { - "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KeylistQuery" + } + } + }, "description": "" } }, + "summary": "Send keylist query to mediator", + "tags": ["mediation"], + "x-codegen-request-body-name": "body" + } + }, + "/mediation/keylists/{mediation_id}/send-keylist-update": { + "post": { "parameters": [ { + "description": "Mediation record identifier", "in": "path", - "name": "pres_ex_id", + "name": "mediation_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" + "schema": { + "type": "string" + } } ], - "tags": ["present-proof v1.0"], - "summary": "Fetch a single presentation exchange record", - "produces": ["application/json"] - }, - "delete": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/KeylistUpdateRequest" + } + } + }, + "required": false + }, "responses": { - "200": { - "schema": { "$ref": "#/definitions/V10PresentProofModuleResponse" }, + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KeylistUpdate" + } + } + }, "description": "" } }, + "summary": "Send keylist update to mediator", + "tags": ["mediation"], + "x-codegen-request-body-name": "body" + } + }, + "/mediation/request/{conn_id}": { + "post": { "parameters": [ { + "description": "Connection identifier", "in": "path", - "name": "pres_ex_id", + "name": "conn_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" + "schema": { + "type": "string" + } } ], - "tags": ["present-proof v1.0"], - "summary": "Remove an existing presentation exchange record", - "produces": ["application/json"] - } - }, - "/present-proof/records/{pres_ex_id}/credentials": { - "get": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MediationCreateRequest" + } + } + }, + "required": false + }, "responses": { - "200": { - "schema": { - "type": "array", - "items": { "$ref": "#/definitions/IndyCredPrecis" } + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediationRecord" + } + } }, "description": "" } }, + "summary": "Request mediation from connection", + "tags": ["mediation"], + "x-codegen-request-body-name": "body" + } + }, + "/mediation/requests": { + "get": { "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\"}}" - }, - { + "description": "Connection identifier (optional)", "in": "query", - "name": "referent", - "required": false, - "type": "string", - "description": "Proof request referents of interest, comma-separated", - "example": "1_name_uuid,2_score_uuid" + "name": "conn_id", + "schema": { + "type": "string" + } }, { + "description": "Mediation state (optional)", "in": "query", - "name": "start", - "required": false, - "type": "string", - "pattern": "^[0-9]*$", - "description": "Start index", - "example": "0" + "name": "state", + "schema": { + "enum": ["request", "granted", "denied"], + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediationList" + } + } + }, "description": "" } }, + "summary": "Query mediation requests, returns list of all mediation records", + "tags": ["mediation"] + } + }, + "/mediation/requests/{mediation_id}": { + "delete": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { - "$ref": "#/definitions/V10PresentationProblemReportRequest" - } - }, - { + "description": "Mediation record identifier", "in": "path", - "name": "pres_ex_id", + "name": "mediation_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" + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediationRecord" + } + } + }, "description": "" } }, + "summary": "Delete mediation request by ID", + "tags": ["mediation"] + }, + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V10PresentationSendRequest" } - }, - { + "description": "Mediation record identifier", "in": "path", - "name": "pres_ex_id", + "name": "mediation_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" + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediationRecord" + } + } + }, "description": "" } }, + "summary": "Retrieve mediation request record", + "tags": ["mediation"] + } + }, + "/mediation/requests/{mediation_id}/deny": { + "post": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { - "$ref": "#/definitions/V10PresentationSendRequestToProposal" - } - }, - { + "description": "Mediation record identifier", "in": "path", - "name": "pres_ex_id", + "name": "mediation_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" + "schema": { + "type": "string" + } } ], - "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": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/AdminMediationDeny" + } + } + }, + "required": false + }, "responses": { - "200": { - "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediationDeny" + } + } + }, "description": "" } }, + "summary": "Deny a stored mediation request", + "tags": ["mediation"], + "x-codegen-request-body-name": "body" + } + }, + "/mediation/requests/{mediation_id}/grant": { + "post": { "parameters": [ { + "description": "Mediation record identifier", "in": "path", - "name": "pres_ex_id", + "name": "mediation_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" + "schema": { + "type": "string" + } } ], - "tags": ["present-proof v1.0"], - "summary": "Verify a received presentation", - "produces": ["application/json"] - } - }, - "/present-proof/send-proposal": { - "post": { "responses": { - "200": { - "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediationGrant" + } + } + }, "description": "" } }, + "summary": "Grant received mediation", + "tags": ["mediation"] + } + }, + "/mediation/update-keylist/{conn_id}": { + "post": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/V10PresentationProposalRequest" } + "description": "Connection identifier", + "in": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } } ], - "tags": ["present-proof v1.0"], - "summary": "Sends a presentation proposal", - "produces": ["application/json"] - } - }, - "/present-proof/send-request": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/MediationIdMatchInfo" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/V10PresentationExchange" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KeylistUpdate" + } + } + }, "description": "" } }, + "summary": "Update keylist for a connection", + "tags": ["mediation"], + "x-codegen-request-body-name": "body" + } + }, + "/mediation/{mediation_id}/default-mediator": { + "put": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", + "description": "Mediation record identifier", + "in": "path", + "name": "mediation_id", + "required": true, "schema": { - "$ref": "#/definitions/V10PresentationSendRequestRequest" + "type": "string" } } ], - "tags": ["present-proof v1.0"], - "summary": "Sends a free presentation request not bound to any proposal", - "produces": ["application/json"] + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediationRecord" + } + } + }, + "description": "" + } + }, + "summary": "Set default mediator", + "tags": ["mediation"] } }, - "/resolver/resolve/{did}": { - "get": { + "/multitenancy/wallet": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateWalletRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/ResolutionResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateWalletResponse" + } + } + }, "description": "" } }, + "summary": "Create a subwallet", + "tags": ["multitenancy"], + "x-codegen-request-body-name": "body" + } + }, + "/multitenancy/wallet/{wallet_id}": { + "get": { "parameters": [ { + "description": "Subwallet identifier", "in": "path", - "name": "did", + "name": "wallet_id", "required": true, - "type": "string", - "pattern": "^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$", - "description": "DID", - "example": "did:ted:WgWxqztrNooG92RXvxSTWv" + "schema": { + "type": "string" + } } ], - "tags": ["resolver"], - "summary": "Retrieve doc for requested did", - "produces": ["application/json"] - } - }, - "/revocation/active-registry/{cred_def_id}": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/RevRegResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WalletRecord" + } + } + }, "description": "" } }, + "summary": "Get a single subwallet", + "tags": ["multitenancy"] + }, + "put": { "parameters": [ { + "description": "Subwallet identifier", "in": "path", - "name": "cred_def_id", + "name": "wallet_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" + "schema": { + "type": "string" + } } ], - "tags": ["revocation"], - "summary": "Get current active revocation registry by credential definition id", - "produces": ["application/json"] - } - }, - "/revocation/active-registry/{cred_def_id}/rotate": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UpdateWalletRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/RevRegsCreated" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WalletRecord" + } + } + }, "description": "" } }, + "summary": "Update a subwallet", + "tags": ["multitenancy"], + "x-codegen-request-body-name": "body" + } + }, + "/multitenancy/wallet/{wallet_id}/remove": { + "post": { "parameters": [ { + "description": "Subwallet identifier", "in": "path", - "name": "cred_def_id", + "name": "wallet_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" + "schema": { + "type": "string" + } } ], - "tags": ["revocation"], - "summary": "Rotate revocation registry", - "produces": ["application/json"] - } - }, - "/revocation/clear-pending-revocations": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/RemoveWalletRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/PublishRevocations" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MultitenantModuleResponse" + } + } + }, "description": "" } }, + "summary": "Remove a subwallet", + "tags": ["multitenancy"], + "x-codegen-request-body-name": "body" + } + }, + "/multitenancy/wallet/{wallet_id}/token": { + "post": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/ClearPendingRevocationsRequest" } + "in": "path", + "name": "wallet_id", + "required": true, + "schema": { + "type": "string" + } } ], - "tags": ["revocation"], - "summary": "Clear pending revocations", - "produces": ["application/json"] - } - }, - "/revocation/create-registry": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/CreateWalletTokenRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/RevRegResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateWalletTokenResponse" + } + } + }, "description": "" } }, + "summary": "Get auth token for a subwallet", + "tags": ["multitenancy"], + "x-codegen-request-body-name": "body" + } + }, + "/multitenancy/wallets": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/RevRegCreateRequest" } + "description": "Wallet name", + "in": "query", + "name": "wallet_name", + "schema": { + "type": "string" + } } ], - "tags": ["revocation"], - "summary": "Creates a new revocation registry", - "produces": ["application/json"] - } - }, - "/revocation/credential-record": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/CredRevRecordResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WalletList" + } + } + }, "description": "" } }, + "summary": "Query subwallets", + "tags": ["multitenancy"] + } + }, + "/out-of-band/create-invitation": { + "post": { "parameters": [ { + "description": "Auto-accept connection (defaults to configuration)", "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" + "name": "auto_accept", + "schema": { + "type": "boolean" + } }, { + "description": "Create unique DID for this invitation (default false)", "in": "query", - "name": "cred_rev_id", - "required": false, - "type": "string", - "pattern": "^[1-9][0-9]*$", - "description": "Credential revocation identifier", - "example": "12345" + "name": "create_unique_did", + "schema": { + "type": "boolean" + } }, { + "description": "Create invitation for multiple use (default false)", "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" + "name": "multi_use", + "schema": { + "type": "boolean" + } } ], - "tags": ["revocation"], - "summary": "Get credential revocation status", - "produces": ["application/json"] - } - }, - "/revocation/publish-revocations": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/InvitationCreateRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/TxnOrPublishRevocationsResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationRecord" + } + } + }, "description": "" } }, + "summary": "Create a new connection invitation", + "tags": ["out-of-band"], + "x-codegen-request-body-name": "body" + } + }, + "/out-of-band/invitations/{invi_msg_id}": { + "delete": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/PublishRevocations" } + "description": "Invitation Message identifier", + "in": "path", + "name": "invi_msg_id", + "required": true, + "schema": { + "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" + } } ], - "tags": ["revocation"], - "summary": "Publish pending revocations to ledger", - "produces": ["application/json"] - } - }, - "/revocation/registries/created": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/RevRegsCreated" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationRecordResponse" + } + } + }, "description": "" } }, + "summary": "Delete records associated with invitation", + "tags": ["out-of-band"] + } + }, + "/out-of-band/receive-invitation": { + "post": { "parameters": [ { + "description": "Alias for connection", "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" + "name": "alias", + "schema": { + "type": "string" + } }, { + "description": "Auto-accept connection (defaults to configuration)", "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" + "name": "auto_accept", + "schema": { + "type": "boolean" + } }, { + "description": "Identifier for active mediation record to be used", "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" + "name": "mediation_id", + "schema": { + "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" + } + }, + { + "description": "Use an existing connection, if possible", + "in": "query", + "name": "use_existing_connection", + "schema": { + "type": "boolean" + } } ], - "tags": ["revocation"], - "summary": "Delete the tail files", - "produces": ["application/json"] - } - }, - "/revocation/registry/{rev_reg_id}": { - "get": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/InvitationMessage" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/RevRegResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OobRecord" + } + } + }, "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": { + "summary": "Receive a new connection invitation", + "tags": ["out-of-band"], + "x-codegen-request-body-name": "body" + } + }, + "/plugins": { + "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/RevRegResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdminModules" + } + } + }, "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"] + "summary": "Fetch the list of loaded plugins", + "tags": ["server"] } }, - "/revocation/registry/{rev_reg_id}/definition": { + "/present-proof-2.0/create-request": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20PresCreateRequestRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/TxnOrRevRegResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20PresExRecord" + } + } + }, "description": "" } }, + "summary": "Creates a presentation request not bound to any proposal or connection", + "tags": ["present-proof v2.0"], + "x-codegen-request-body-name": "body" + } + }, + "/present-proof-2.0/records": { + "get": { "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" + "description": "Connection identifier", + "in": "query", + "name": "connection_id", + "schema": { + "type": "string" + } }, { + "description": "Role assigned in presentation exchange", "in": "query", - "name": "conn_id", - "required": false, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "name": "role", + "schema": { + "enum": ["prover", "verifier"], + "type": "string" + } }, { + "description": "Presentation exchange state", "in": "query", - "name": "create_transaction_for_endorser", - "required": false, - "type": "boolean", - "description": "Create Transaction For Endorser's signature" + "name": "state", + "schema": { + "enum": [ + "proposal-sent", + "proposal-received", + "request-sent", + "request-received", + "presentation-sent", + "presentation-received", + "done", + "abandoned" + ], + "type": "string" + } + }, + { + "description": "Thread identifier", + "in": "query", + "name": "thread_id", + "schema": { + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20PresExRecordList" + } + } + }, "description": "" } }, + "summary": "Fetch all present-proof exchange records", + "tags": ["present-proof v2.0"] + } + }, + "/present-proof-2.0/records/{pres_ex_id}": { + "delete": { "parameters": [ { + "description": "Presentation exchange identifier", "in": "path", - "name": "rev_reg_id", + "name": "pres_ex_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" + "schema": { + "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" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20PresentProofModuleResponse" + } + } + }, "description": "" } }, + "summary": "Remove an existing presentation exchange record", + "tags": ["present-proof v2.0"] + }, + "get": { "parameters": [ { + "description": "Presentation exchange identifier", "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", + "name": "pres_ex_id", "required": true, - "type": "boolean", - "description": "Apply updated accumulator transaction to ledger" + "schema": { + "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" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20PresExRecord" + } + } + }, "description": "" } }, + "summary": "Fetch a single presentation exchange record", + "tags": ["present-proof v2.0"] + } + }, + "/present-proof-2.0/records/{pres_ex_id}/credentials": { + "get": { "parameters": [ { + "description": "Presentation exchange identifier", "in": "path", - "name": "rev_reg_id", + "name": "pres_ex_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" + "schema": { + "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" + } + }, + { + "description": "Maximum number to retrieve", + "in": "query", + "name": "count", + "schema": { + "pattern": "^[1-9][0-9]*$", + "type": "string" + } + }, + { + "description": "(JSON) object mapping referents to extra WQL queries", + "in": "query", + "name": "extra_query", + "schema": { + "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", + "type": "string" + } + }, + { + "description": "Proof request referents of interest, comma-separated", + "in": "query", + "name": "referent", + "schema": { + "type": "string" + } + }, + { + "description": "Start index", + "in": "query", + "name": "start", + "schema": { + "pattern": "^[0-9]*$", + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/IndyCredPrecis" + }, + "type": "array" + } + } + }, "description": "" } }, + "summary": "Fetch credentials from wallet for presentation request", + "tags": ["present-proof v2.0"] + } + }, + "/present-proof-2.0/records/{pres_ex_id}/problem-report": { + "post": { "parameters": [ { + "description": "Presentation exchange identifier", "in": "path", - "name": "rev_reg_id", + "name": "pres_ex_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" + "schema": { + "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" + } } ], - "tags": ["revocation"], - "summary": "Get details of credentials issued against revocation registry", - "produces": ["application/json"] - } - }, - "/revocation/registry/{rev_reg_id}/issued/indy_recs": { - "get": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20PresProblemReportRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/CredRevIndyRecordsResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20PresentProofModuleResponse" + } + } + }, "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"] + "summary": "Send a problem report for presentation exchange", + "tags": ["present-proof v2.0"], + "x-codegen-request-body-name": "body" } }, - "/revocation/registry/{rev_reg_id}/set-state": { - "patch": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/RevRegResult" }, - "description": "" - } - }, + "/present-proof-2.0/records/{pres_ex_id}/send-presentation": { + "post": { "parameters": [ { + "description": "Presentation exchange identifier", "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", + "name": "pres_ex_id", "required": true, - "type": "string", - "enum": ["init", "generated", "posted", "active", "full"], - "description": "Revocation registry state to set" + "schema": { + "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" + } } ], - "tags": ["revocation"], - "summary": "Set revocation registry state manually", - "produces": ["application/json"] - } - }, - "/revocation/registry/{rev_reg_id}/tails-file": { - "put": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20PresSpecByFormatRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/RevocationModuleResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20PresExRecord" + } + } + }, "description": "" } }, + "summary": "Sends a proof presentation", + "tags": ["present-proof v2.0"], + "x-codegen-request-body-name": "body" + } + }, + "/present-proof-2.0/records/{pres_ex_id}/send-request": { + "post": { "parameters": [ { + "description": "Presentation exchange identifier", "in": "path", - "name": "rev_reg_id", + "name": "pres_ex_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" + "schema": { + "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" + } } ], - "tags": ["revocation"], - "summary": "Upload local tails file to server", - "produces": ["application/json"] - }, - "get": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20PresentationSendRequestToProposal" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "type": "string", "format": "binary" }, - "description": "tails file" + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20PresExRecord" + } + } + }, + "description": "" } }, + "summary": "Sends a presentation request in reference to a proposal", + "tags": ["present-proof v2.0"], + "x-codegen-request-body-name": "body" + } + }, + "/present-proof-2.0/records/{pres_ex_id}/verify-presentation": { + "post": { "parameters": [ { + "description": "Presentation exchange identifier", "in": "path", - "name": "rev_reg_id", + "name": "pres_ex_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" + "schema": { + "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" + } } ], - "tags": ["revocation"], - "summary": "Download tails file", - "produces": ["application/octet-stream"] + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20PresExRecord" + } + } + }, + "description": "" + } + }, + "summary": "Verify a received presentation", + "tags": ["present-proof v2.0"] } }, - "/revocation/revoke": { + "/present-proof-2.0/send-proposal": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20PresProposalRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/RevocationModuleResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20PresExRecord" + } + } + }, "description": "" } }, - "parameters": [ - { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/RevokeRequest" } - } - ], - "tags": ["revocation"], - "summary": "Revoke an issued credential", - "produces": ["application/json"] + "summary": "Sends a presentation proposal", + "tags": ["present-proof v2.0"], + "x-codegen-request-body-name": "body" } }, - "/schemas": { + "/present-proof-2.0/send-request": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V20PresSendRequestRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/TxnOrSchemaSendResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V20PresExRecord" + } + } + }, "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"] + "summary": "Sends a free presentation request not bound to any proposal", + "tags": ["present-proof v2.0"], + "x-codegen-request-body-name": "body" } }, - "/schemas/created": { - "get": { + "/present-proof/create-request": { + "post": { + "deprecated": true, + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10PresentationCreateRequestRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/SchemasCreatedResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10PresentationExchange" + } + } + }, "description": "" } }, + "summary": "Creates a presentation request not bound to any proposal or connection", + "tags": ["present-proof v1.0"], + "x-codegen-request-body-name": "body" + } + }, + "/present-proof/records": { + "get": { + "deprecated": true, "parameters": [ { + "description": "Connection identifier", "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" + "name": "connection_id", + "schema": { + "type": "string" + } }, { + "description": "Role assigned in presentation exchange", "in": "query", - "name": "schema_issuer_did", - "required": false, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", - "description": "Schema issuer DID", - "example": "WgWxqztrNooG92RXvxSTWv" + "name": "role", + "schema": { + "enum": ["prover", "verifier"], + "type": "string" + } }, { + "description": "Presentation exchange state", "in": "query", - "name": "schema_name", - "required": false, - "type": "string", - "description": "Schema name", - "example": "membership" + "name": "state", + "schema": { + "enum": [ + "proposal_sent", + "proposal_received", + "request_sent", + "request_received", + "presentation_sent", + "presentation_received", + "verified", + "presentation_acked", + "abandoned" + ], + "type": "string" + } }, { + "description": "Thread identifier", "in": "query", - "name": "schema_version", - "required": false, - "type": "string", - "pattern": "^[0-9.]+$", - "description": "Schema version", - "example": "1.0" + "name": "thread_id", + "schema": { + "type": "string" + } } ], - "tags": ["schema"], - "summary": "Search for matching schema that agent originated", - "produces": ["application/json"] - } - }, - "/schemas/{schema_id}": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/SchemaGetResult" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10PresentationExchangeList" + } + } + }, "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"] + "summary": "Fetch all present-proof exchange records", + "tags": ["present-proof v1.0"] } }, - "/schemas/{schema_id}/write_record": { - "post": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/SchemaGetResult" }, - "description": "" - } - }, + "/present-proof/records/{pres_ex_id}": { + "delete": { + "deprecated": true, "parameters": [ { + "description": "Presentation exchange identifier", "in": "path", - "name": "schema_id", + "name": "pres_ex_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" + "schema": { + "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" + } } ], - "tags": ["schema"], - "summary": "Writes a schema non-secret record to the wallet", - "produces": ["application/json"] - } - }, - "/settings": { - "put": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ProfileSettings" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10PresentProofModuleResponse" + } + } + }, "description": "" } }, + "summary": "Remove an existing presentation exchange record", + "tags": ["present-proof v1.0"] + }, + "get": { + "deprecated": true, "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/UpdateProfileSettings" } + "description": "Presentation exchange identifier", + "in": "path", + "name": "pres_ex_id", + "required": true, + "schema": { + "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" + } } ], - "tags": ["settings"], - "summary": "Update configurable settings associated with the profile.", - "produces": ["application/json"] - }, - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ProfileSettings" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10PresentationExchange" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["settings"], - "summary": "Get the configurable settings associated with the profile.", - "produces": ["application/json"] + "summary": "Fetch a single presentation exchange record", + "tags": ["present-proof v1.0"] } }, - "/shutdown": { + "/present-proof/records/{pres_ex_id}/credentials": { "get": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/AdminShutdown" }, - "description": "" + "deprecated": true, + "parameters": [ + { + "description": "Presentation exchange identifier", + "in": "path", + "name": "pres_ex_id", + "required": true, + "schema": { + "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" + } + }, + { + "description": "Maximum number to retrieve", + "in": "query", + "name": "count", + "schema": { + "pattern": "^[1-9][0-9]*$", + "type": "string" + } + }, + { + "description": "(JSON) object mapping referents to extra WQL queries", + "in": "query", + "name": "extra_query", + "schema": { + "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", + "type": "string" + } + }, + { + "description": "Proof request referents of interest, comma-separated", + "in": "query", + "name": "referent", + "schema": { + "type": "string" + } + }, + { + "description": "Start index", + "in": "query", + "name": "start", + "schema": { + "pattern": "^[0-9]*$", + "type": "string" + } } - }, - "parameters": [], - "tags": ["server"], - "summary": "Shut down server", - "produces": ["application/json"] - } - }, - "/status": { - "get": { + ], "responses": { "200": { - "schema": { "$ref": "#/definitions/AdminStatus" }, + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/IndyCredPrecis" + }, + "type": "array" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["server"], - "summary": "Fetch the server status", - "produces": ["application/json"] + "summary": "Fetch credentials for a presentation request from wallet", + "tags": ["present-proof v1.0"] } }, - "/status/config": { - "get": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/AdminConfig" }, - "description": "" + "/present-proof/records/{pres_ex_id}/problem-report": { + "post": { + "deprecated": true, + "parameters": [ + { + "description": "Presentation exchange identifier", + "in": "path", + "name": "pres_ex_id", + "required": true, + "schema": { + "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" + } } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10PresentationProblemReportRequest" + } + } + }, + "required": false }, - "parameters": [], - "tags": ["server"], - "summary": "Fetch the server configuration", - "produces": ["application/json"] - } - }, - "/status/live": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/AdminStatusLiveliness" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10PresentProofModuleResponse" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["server"], - "summary": "Liveliness check", - "produces": ["application/json"] + "summary": "Send a problem report for presentation exchange", + "tags": ["present-proof v1.0"], + "x-codegen-request-body-name": "body" } }, - "/status/ready": { - "get": { + "/present-proof/records/{pres_ex_id}/send-presentation": { + "post": { + "deprecated": true, + "parameters": [ + { + "description": "Presentation exchange identifier", + "in": "path", + "name": "pres_ex_id", + "required": true, + "schema": { + "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" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10PresentationSendRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/AdminStatusReadiness" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10PresentationExchange" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["server"], - "summary": "Readiness check", - "produces": ["application/json"] + "summary": "Sends a proof presentation", + "tags": ["present-proof v1.0"], + "x-codegen-request-body-name": "body" } }, - "/status/reset": { + "/present-proof/records/{pres_ex_id}/send-request": { "post": { + "deprecated": true, + "parameters": [ + { + "description": "Presentation exchange identifier", + "in": "path", + "name": "pres_ex_id", + "required": true, + "schema": { + "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" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10PresentationSendRequestToProposal" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/AdminReset" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10PresentationExchange" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["server"], - "summary": "Reset statistics", - "produces": ["application/json"] + "summary": "Sends a presentation request in reference to a proposal", + "tags": ["present-proof v1.0"], + "x-codegen-request-body-name": "body" } }, - "/transaction/{tran_id}/resend": { + "/present-proof/records/{pres_ex_id}/verify-presentation": { "post": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/TransactionRecord" }, - "description": "" - } - }, + "deprecated": true, "parameters": [ { + "description": "Presentation exchange identifier", "in": "path", - "name": "tran_id", + "name": "pres_ex_id", "required": true, - "type": "string", - "description": "Transaction identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "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" + } } ], - "tags": ["endorse-transaction"], - "summary": "For Author to resend a particular transaction request", - "produces": ["application/json"] - } - }, - "/transactions": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/TransactionList" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10PresentationExchange" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["endorse-transaction"], - "summary": "Query transactions", - "produces": ["application/json"] + "summary": "Verify a received presentation", + "tags": ["present-proof v1.0"] } }, - "/transactions/create-request": { + "/present-proof/send-proposal": { "post": { + "deprecated": true, + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10PresentationProposalRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/TransactionRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10PresentationExchange" + } + } + }, "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"] + "summary": "Sends a presentation proposal", + "tags": ["present-proof v1.0"], + "x-codegen-request-body-name": "body" } }, - "/transactions/{conn_id}/set-endorser-info": { + "/present-proof/send-request": { "post": { + "deprecated": true, + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/V10PresentationSendRequestRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/EndorserInfo" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V10PresentationExchange" + } + } + }, "description": "" } }, + "summary": "Sends a free presentation request not bound to any proposal", + "tags": ["present-proof v1.0"], + "x-codegen-request-body-name": "body" + } + }, + "/resolver/resolve/{did}": { + "get": { "parameters": [ { + "description": "DID", "in": "path", - "name": "conn_id", - "required": true, - "type": "string", - "description": "Connection identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - }, - { - "in": "query", - "name": "endorser_did", + "name": "did", "required": true, - "type": "string", - "description": "Endorser DID" - }, - { - "in": "query", - "name": "endorser_name", - "required": false, - "type": "string", - "description": "Endorser Name" + "schema": { + "pattern": "^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$", + "type": "string" + } } ], - "tags": ["endorse-transaction"], - "summary": "Set Endorser Info", - "produces": ["application/json"] - } - }, - "/transactions/{conn_id}/set-endorser-role": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/TransactionJobs" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResolutionResult" + } + } + }, "description": "" } }, + "summary": "Retrieve doc for requested did", + "tags": ["resolver"] + } + }, + "/revocation/active-registry/{cred_def_id}": { + "get": { "parameters": [ { + "description": "Credential definition identifier", "in": "path", - "name": "conn_id", + "name": "cred_def_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" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + } } ], - "tags": ["endorse-transaction"], - "summary": "Set transaction jobs", - "produces": ["application/json"] - } - }, - "/transactions/{tran_id}": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/TransactionRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegResult" + } + } + }, "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"] + "summary": "Get current active revocation registry by credential definition id", + "tags": ["revocation"] } }, - "/transactions/{tran_id}/cancel": { + "/revocation/active-registry/{cred_def_id}/rotate": { "post": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/TransactionRecord" }, - "description": "" - } - }, "parameters": [ { + "description": "Credential definition identifier", "in": "path", - "name": "tran_id", + "name": "cred_def_id", "required": true, - "type": "string", - "description": "Transaction identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegsCreated" + } + } + }, "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"] + "summary": "Rotate revocation registry", + "tags": ["revocation"] } }, - "/transactions/{tran_id}/refuse": { + "/revocation/clear-pending-revocations": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ClearPendingRevocationsRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/TransactionRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublishRevocationsSchemaAnoncreds" + } + } + }, "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"] + "summary": "Clear pending revocations", + "tags": ["revocation"], + "x-codegen-request-body-name": "body" } }, - "/transactions/{tran_id}/write": { + "/revocation/create-registry": { "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/RevRegCreateRequest" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/TransactionRecord" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegResult" + } + } + }, "description": "" } }, + "summary": "Creates a new revocation registry", + "tags": ["revocation"], + "x-codegen-request-body-name": "body" + } + }, + "/revocation/credential-record": { + "get": { "parameters": [ { - "in": "path", - "name": "tran_id", - "required": true, - "type": "string", - "description": "Transaction identifier", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + "description": "Credential exchange identifier", + "in": "query", + "name": "cred_ex_id", + "schema": { + "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" + } + }, + { + "description": "Credential revocation identifier", + "in": "query", + "name": "cred_rev_id", + "schema": { + "pattern": "^[1-9][0-9]*$", + "type": "string" + } + }, + { + "description": "Revocation registry identifier", + "in": "query", + "name": "rev_reg_id", + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "tags": ["endorse-transaction"], - "summary": "For Author / Endorser to write an endorsed transaction to the ledger", - "produces": ["application/json"] - } - }, - "/vc/credentials": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ListCredentialsResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredRevRecordResultSchemaAnoncreds" + } + } + }, "description": "" } }, - "parameters": [], - "tags": ["vc-api"], - "summary": "List credentials", - "produces": ["application/json"] + "summary": "Get credential revocation status", + "tags": ["revocation"] } }, - "/vc/credentials/issue": { + "/revocation/publish-revocations": { "post": { + "parameters": [ + { + "description": "Connection identifier", + "in": "query", + "name": "conn_id", + "schema": { + "type": "string" + } + }, + { + "description": "Create Transaction For Endorser's signature", + "in": "query", + "name": "create_transaction_for_endorser", + "schema": { + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/PublishRevocationsSchemaAnoncreds" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/IssueCredentialResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TxnOrPublishRevocationsResult" + } + } + }, "description": "" } }, + "summary": "Publish pending revocations to ledger", + "tags": ["revocation"], + "x-codegen-request-body-name": "body" + } + }, + "/revocation/registries/created": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/IssueCredentialRequest" } + "description": "Credential definition identifier", + "in": "query", + "name": "cred_def_id", + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + } + }, + { + "description": "Revocation registry state", + "in": "query", + "name": "state", + "schema": { + "enum": [ + "init", + "generated", + "posted", + "active", + "full", + "decommissioned" + ], + "type": "string" + } } ], - "tags": ["vc-api"], - "summary": "Issue a credential", - "produces": ["application/json"] - } - }, - "/vc/credentials/store": { - "post": { - "responses": {}, - "parameters": [], - "tags": ["vc-api"], - "summary": "Store a credential", - "produces": ["application/json"] - } - }, - "/vc/credentials/verify": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/VerifyCredentialResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegsCreated" + } + } + }, "description": "" } }, + "summary": "Search for matching revocation registries that current agent created", + "tags": ["revocation"] + } + }, + "/revocation/registry/delete-tails-file": { + "delete": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/VerifyCredentialRequest" } + "description": "Credential definition identifier", + "in": "query", + "name": "cred_def_id", + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type": "string" + } + }, + { + "description": "Revocation registry identifier", + "in": "query", + "name": "rev_reg_id", + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "tags": ["vc-api"], - "summary": "Verify a credential", - "produces": ["application/json"] - } - }, - "/vc/credentials/{credential_id}": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/FetchCredentialResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TailsDeleteResponse" + } + } + }, "description": "" } }, + "summary": "Delete the tail files", + "tags": ["revocation"] + } + }, + "/revocation/registry/{rev_reg_id}": { + "get": { "parameters": [ { + "description": "Revocation Registry identifier", "in": "path", - "name": "credential_id", + "name": "rev_reg_id", "required": true, - "type": "string" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "tags": ["vc-api"], - "summary": "Fetch credential by ID", - "produces": ["application/json"] - } - }, - "/vc/presentations/prove": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/ProvePresentationResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegResult" + } + } + }, "description": "" } }, + "summary": "Get revocation registry by revocation registry id", + "tags": ["revocation"] + }, + "patch": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/ProvePresentationRequest" } + "description": "Revocation Registry identifier", + "in": "path", + "name": "rev_reg_id", + "required": true, + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "tags": ["vc-api"], - "summary": "Prove a presentation", - "produces": ["application/json"] - } - }, - "/vc/presentations/verify": { - "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/RevRegUpdateTailsFileUri" + } + } + }, + "required": false + }, "responses": { "200": { - "schema": { "$ref": "#/definitions/VerifyPresentationResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegResult" + } + } + }, "description": "" } }, - "parameters": [ - { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/VerifyPresentationRequest" } - } - ], - "tags": ["vc-api"], - "summary": "Verify a Presentation", - "produces": ["application/json"] + "summary": "Update revocation registry with new public URI to its tails file", + "tags": ["revocation"], + "x-codegen-request-body-name": "body" } }, - "/wallet/did": { - "get": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/DIDList" }, - "description": "" - } - }, + "/revocation/registry/{rev_reg_id}/definition": { + "post": { "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" + "description": "Revocation Registry identifier", + "in": "path", + "name": "rev_reg_id", + "required": true, + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } }, { + "description": "Connection identifier", "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" + "name": "conn_id", + "schema": { + "type": "string" + } }, { + "description": "Create Transaction For Endorser's signature", "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" } + "name": "create_transaction_for_endorser", + "schema": { + "type": "boolean" + } } ], - "tags": ["wallet"], - "summary": "Create a local DID", - "produces": ["application/json"] - } - }, - "/wallet/did/local/rotate-keypair": { - "patch": { "responses": { "200": { - "schema": { "$ref": "#/definitions/WalletModuleResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TxnOrRevRegResult" + } + } + }, "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"] + "summary": "Send revocation registry definition to ledger", + "tags": ["revocation"] } }, - "/wallet/did/public": { - "get": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/DIDResult" }, - "description": "" - } - }, - "parameters": [], - "tags": ["wallet"], - "summary": "Fetch the current public DID", - "produces": ["application/json"] - }, + "/revocation/registry/{rev_reg_id}/entry": { "post": { - "responses": { - "200": { - "schema": { "$ref": "#/definitions/DIDResult" }, - "description": "" - } - }, "parameters": [ { - "in": "query", - "name": "did", + "description": "Revocation Registry identifier", + "in": "path", + "name": "rev_reg_id", "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" + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } }, { + "description": "Connection identifier", "in": "query", "name": "conn_id", - "required": false, - "type": "string", - "description": "Connection identifier" + "schema": { + "type": "string" + } }, { + "description": "Create Transaction For Endorser's signature", "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" + "schema": { + "type": "boolean" + } } ], - "tags": ["wallet"], - "summary": "Assign the current public DID", - "produces": ["application/json"] - } - }, - "/wallet/get-did-endpoint": { - "get": { "responses": { "200": { - "schema": { "$ref": "#/definitions/DIDEndpoint" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegResult" + } + } + }, "description": "" } }, + "summary": "Send revocation registry entry to ledger", + "tags": ["revocation"] + } + }, + "/revocation/registry/{rev_reg_id}/fix-revocation-entry-state": { + "put": { "parameters": [ { + "description": "Revocation Registry identifier", + "in": "path", + "name": "rev_reg_id", + "required": true, + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } + }, + { + "description": "Apply updated accumulator transaction to ledger", "in": "query", - "name": "did", + "name": "apply_ledger_update", "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" + "schema": { + "type": "boolean" + } } ], - "tags": ["wallet"], - "summary": "Query DID endpoint in wallet", - "produces": ["application/json"] - } - }, - "/wallet/jwt/sign": { - "post": { "responses": { "200": { - "schema": { "$ref": "#/definitions/WalletModuleResponse" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegWalletUpdatedResult" + } + } + }, "description": "" } }, + "summary": "Fix revocation state in wallet and return number of updated entries", + "tags": ["revocation"] + } + }, + "/revocation/registry/{rev_reg_id}/issued": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/JWSCreate" } + "description": "Revocation Registry identifier", + "in": "path", + "name": "rev_reg_id", + "required": true, + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegIssuedResult" + } + } + }, "description": "" } }, + "summary": "Get number of credentials issued against revocation registry", + "tags": ["revocation"] + } + }, + "/revocation/registry/{rev_reg_id}/issued/details": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/JWSVerify" } + "description": "Revocation Registry identifier", + "in": "path", + "name": "rev_reg_id", + "required": true, + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredRevRecordDetailsResult" + } + } + }, "description": "" } }, + "summary": "Get details of credentials issued against revocation registry", + "tags": ["revocation"] + } + }, + "/revocation/registry/{rev_reg_id}/issued/indy_recs": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/SDJWSCreate" } + "description": "Revocation Registry identifier", + "in": "path", + "name": "rev_reg_id", + "required": true, + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredRevIndyRecordsResult" + } + } + }, "description": "" } }, + "summary": "Get details of revoked credentials from ledger", + "tags": ["revocation"] + } + }, + "/revocation/registry/{rev_reg_id}/set-state": { + "patch": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/SDJWSVerify" } + "description": "Revocation Registry identifier", + "in": "path", + "name": "rev_reg_id", + "required": true, + "schema": { + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + } + }, + { + "description": "Revocation registry state to set", + "in": "query", + "name": "state", + "required": true, + "schema": { + "enum": ["init", "generated", "posted", "active", "full"], + "type": "string" + } } ], - "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" }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegResult" + } + } + }, "description": "" } }, + "summary": "Set revocation registry state manually", + "tags": ["revocation"] + } + }, + "/revocation/registry/{rev_reg_id}/tails-file": { + "get": { "parameters": [ { - "in": "body", - "required": false, - "name": "body", - "schema": { "$ref": "#/definitions/DIDEndpointWithType" } - }, + "description": "Revocation Registry identifier", + "in": "path", + "name": "rev_reg_id", + "required": true, + "schema": { + "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": { + "content": { + "application/octet-stream": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "description": "tails file" + } + }, + "summary": "Download tails file", + "tags": ["revocation"] + }, + "put": { + "parameters": [ + { + "description": "Revocation Registry identifier", + "in": "path", + "name": "rev_reg_id", + "required": true, + "schema": { + "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": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevocationModuleResponse" + } + } + }, + "description": "" + } + }, + "summary": "Upload local tails file to server", + "tags": ["revocation"] + } + }, + "/revocation/revoke": { + "post": { + "parameters": [ { + "description": "Connection identifier", "in": "query", "name": "conn_id", - "required": false, - "type": "string", - "description": "Connection identifier" + "schema": { + "type": "string" + } }, { + "description": "Create Transaction For Endorser's signature", "in": "query", "name": "create_transaction_for_endorser", - "required": false, - "type": "boolean", - "description": "Create Transaction For Endorser's signature" + "schema": { + "type": "boolean" + } } ], - "tags": ["wallet"], - "summary": "Update endpoint in wallet and on ledger if posted to it", - "produces": ["application/json"] + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/RevokeRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevocationModuleResponse" + } + } + }, + "description": "" + } + }, + "summary": "Revoke an issued credential", + "tags": ["revocation"], + "x-codegen-request-body-name": "body" } - } - }, - "info": { "title": "Aries Cloud Agent", "version": "v0.12.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" + }, + "/schemas": { + "post": { + "parameters": [ + { + "description": "Connection identifier", + "in": "query", + "name": "conn_id", + "schema": { + "type": "string" + } }, - "type": "object", - "x-nullable": true - } - }, - "type": "object" + { + "description": "Create Transaction For Endorser's signature", + "in": "query", + "name": "create_transaction_for_endorser", + "schema": { + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SchemaSendRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TxnOrSchemaSendResult" + } + } + }, + "description": "" + } + }, + "summary": "Sends a schema to the ledger", + "tags": ["schema"], + "x-codegen-request-body-name": "body" + } + }, + "/schemas/created": { + "get": { + "parameters": [ + { + "description": "Schema identifier", + "in": "query", + "name": "schema_id", + "schema": { + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + } + }, + { + "description": "Schema issuer DID", + "in": "query", + "name": "schema_issuer_did", + "schema": { + "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type": "string" + } + }, + { + "description": "Schema name", + "in": "query", + "name": "schema_name", + "schema": { + "type": "string" + } + }, + { + "description": "Schema version", + "in": "query", + "name": "schema_version", + "schema": { + "pattern": "^[0-9.]+$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SchemasCreatedResult" + } + } + }, + "description": "" + } + }, + "summary": "Search for matching schema that agent originated", + "tags": ["schema"] + } + }, + "/schemas/{schema_id}": { + "get": { + "parameters": [ + { + "description": "Schema identifier", + "in": "path", + "name": "schema_id", + "required": true, + "schema": { + "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SchemaGetResult" + } + } + }, + "description": "" + } + }, + "summary": "Gets a schema from the ledger", + "tags": ["schema"] + } + }, + "/schemas/{schema_id}/write_record": { + "post": { + "parameters": [ + { + "description": "Schema identifier", + "in": "path", + "name": "schema_id", + "required": true, + "schema": { + "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SchemaGetResult" + } + } + }, + "description": "" + } + }, + "summary": "Writes a schema non-secret record to the wallet", + "tags": ["schema"] + } }, - "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" } + "/settings": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProfileSettings" + } + } + }, + "description": "" + } + }, + "summary": "Get the configurable settings associated with the profile.", + "tags": ["settings"] }, - "type": "object" + "put": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UpdateProfileSettings" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProfileSettings" + } + } + }, + "description": "" + } + }, + "summary": "Update configurable settings associated with the profile.", + "tags": ["settings"], + "x-codegen-request-body-name": "body" + } + }, + "/shutdown": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdminShutdown" + } + } + }, + "description": "" + } + }, + "summary": "Shut down server", + "tags": ["server"] + } }, - "ClearPendingRevocationsRequest": { - "properties": { - "purge": { - "additionalProperties": { + "/status": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdminStatus" + } + } + }, + "description": "" + } + }, + "summary": "Fetch the server status", + "tags": ["server"] + } + }, + "/status/config": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdminConfig" + } + } + }, + "description": "" + } + }, + "summary": "Fetch the server configuration", + "tags": ["server"] + } + }, + "/status/live": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdminStatusLiveliness" + } + } + }, + "description": "" + } + }, + "summary": "Liveliness check", + "tags": ["server"] + } + }, + "/status/ready": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdminStatusReadiness" + } + } + }, + "description": "" + } + }, + "summary": "Readiness check", + "tags": ["server"] + } + }, + "/status/reset": { + "post": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdminReset" + } + } + }, + "description": "" + } + }, + "summary": "Reset statistics", + "tags": ["server"] + } + }, + "/transaction/{tran_id}/resend": { + "post": { + "parameters": [ + { + "description": "Transaction identifier", + "in": "path", + "name": "tran_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRecord" + } + } + }, + "description": "" + } + }, + "summary": "For Author to resend a particular transaction request", + "tags": ["endorse-transaction"] + } + }, + "/transactions": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionList" + } + } + }, + "description": "" + } + }, + "summary": "Query transactions", + "tags": ["endorse-transaction"] + } + }, + "/transactions/create-request": { + "post": { + "parameters": [ + { + "description": "Transaction identifier", + "in": "query", + "name": "tran_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/Date" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRecord" + } + } + }, + "description": "" + } + }, + "summary": "For author to send a transaction request", + "tags": ["endorse-transaction"], + "x-codegen-request-body-name": "body" + } + }, + "/transactions/{conn_id}/set-endorser-info": { + "post": { + "parameters": [ + { + "description": "Connection identifier", + "in": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Endorser DID", + "in": "query", + "name": "endorser_did", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Endorser Name", + "in": "query", + "name": "endorser_name", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EndorserInfo" + } + } + }, + "description": "" + } + }, + "summary": "Set Endorser Info", + "tags": ["endorse-transaction"] + } + }, + "/transactions/{conn_id}/set-endorser-role": { + "post": { + "parameters": [ + { + "description": "Connection identifier", + "in": "path", + "name": "conn_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Transaction related jobs", + "in": "query", + "name": "transaction_my_job", + "schema": { + "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionJobs" + } + } + }, + "description": "" + } + }, + "summary": "Set transaction jobs", + "tags": ["endorse-transaction"] + } + }, + "/transactions/{tran_id}": { + "get": { + "parameters": [ + { + "description": "Transaction identifier", + "in": "path", + "name": "tran_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRecord" + } + } + }, + "description": "" + } + }, + "summary": "Fetch a single transaction record", + "tags": ["endorse-transaction"] + } + }, + "/transactions/{tran_id}/cancel": { + "post": { + "parameters": [ + { + "description": "Transaction identifier", + "in": "path", + "name": "tran_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRecord" + } + } + }, + "description": "" + } + }, + "summary": "For Author to cancel a particular transaction request", + "tags": ["endorse-transaction"] + } + }, + "/transactions/{tran_id}/endorse": { + "post": { + "parameters": [ + { + "description": "Transaction identifier", + "in": "path", + "name": "tran_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Endorser DID", + "in": "query", + "name": "endorser_did", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRecord" + } + } + }, + "description": "" + } + }, + "summary": "For Endorser to endorse a particular transaction record", + "tags": ["endorse-transaction"] + } + }, + "/transactions/{tran_id}/refuse": { + "post": { + "parameters": [ + { + "description": "Transaction identifier", + "in": "path", + "name": "tran_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRecord" + } + } + }, + "description": "" + } + }, + "summary": "For Endorser to refuse a particular transaction record", + "tags": ["endorse-transaction"] + } + }, + "/transactions/{tran_id}/write": { + "post": { + "parameters": [ + { + "description": "Transaction identifier", + "in": "path", + "name": "tran_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TransactionRecord" + } + } + }, + "description": "" + } + }, + "summary": "For Author / Endorser to write an endorsed transaction to the ledger", + "tags": ["endorse-transaction"] + } + }, + "/vc/credentials": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListCredentialsResponse" + } + } + }, + "description": "" + } + }, + "summary": "List credentials", + "tags": ["vc-api"] + } + }, + "/vc/credentials/issue": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/IssueCredentialRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IssueCredentialResponse" + } + } + }, + "description": "" + } + }, + "summary": "Issue a credential", + "tags": ["vc-api"], + "x-codegen-request-body-name": "body" + } + }, + "/vc/credentials/store": { + "post": { + "summary": "Store a credential", + "tags": ["vc-api"] + } + }, + "/vc/credentials/verify": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VerifyCredentialRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyCredentialResponse" + } + } + }, + "description": "" + } + }, + "summary": "Verify a credential", + "tags": ["vc-api"], + "x-codegen-request-body-name": "body" + } + }, + "/vc/credentials/{credential_id}": { + "get": { + "parameters": [ + { + "in": "path", + "name": "credential_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FetchCredentialResponse" + } + } + }, + "description": "" + } + }, + "summary": "Fetch credential by ID", + "tags": ["vc-api"] + } + }, + "/vc/presentations/prove": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ProvePresentationRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProvePresentationResponse" + } + } + }, + "description": "" + } + }, + "summary": "Prove a presentation", + "tags": ["vc-api"], + "x-codegen-request-body-name": "body" + } + }, + "/vc/presentations/verify": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/VerifyPresentationRequest" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerifyPresentationResponse" + } + } + }, + "description": "" + } + }, + "summary": "Verify a Presentation", + "tags": ["vc-api"], + "x-codegen-request-body-name": "body" + } + }, + "/wallet/did": { + "get": { + "parameters": [ + { + "description": "DID of interest", + "in": "query", + "name": "did", + "schema": { + "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" + } + }, + { + "description": "Key type to query for.", + "in": "query", + "name": "key_type", + "schema": { + "enum": ["ed25519", "bls12381g2"], + "type": "string" + } + }, + { + "description": "DID method to query for. e.g. sov to only fetch indy/sov DIDs", + "in": "query", + "name": "method", + "schema": { + "enum": ["key", "sov", "did:peer:2", "did:peer:4"], + "type": "string" + } + }, + { + "description": "Whether DID is current public DID, posted to ledger but current public DID, or local to the wallet", + "in": "query", + "name": "posture", + "schema": { + "enum": ["public", "posted", "wallet_only"], + "type": "string" + } + }, + { + "description": "Verification key of interest", + "in": "query", + "name": "verkey", + "schema": { + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DIDList" + } + } + }, + "description": "" + } + }, + "summary": "List wallet DIDs", + "tags": ["wallet"] + } + }, + "/wallet/did/create": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DIDCreate" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DIDResult" + } + } + }, + "description": "" + } + }, + "summary": "Create a local DID", + "tags": ["wallet"], + "x-codegen-request-body-name": "body" + } + }, + "/wallet/did/local/rotate-keypair": { + "patch": { + "parameters": [ + { + "description": "DID of interest", + "in": "query", + "name": "did", + "required": true, + "schema": { + "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": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WalletModuleResponse" + } + } + }, + "description": "" + } + }, + "summary": "Rotate keypair for a DID not posted to the ledger", + "tags": ["wallet"] + } + }, + "/wallet/did/public": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DIDResult" + } + } + }, + "description": "" + } + }, + "summary": "Fetch the current public DID", + "tags": ["wallet"] + }, + "post": { + "parameters": [ + { + "description": "DID of interest", + "in": "query", + "name": "did", + "required": true, + "schema": { + "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" + } + }, + { + "description": "Connection identifier", + "in": "query", + "name": "conn_id", + "schema": { + "type": "string" + } + }, + { + "description": "Create Transaction For Endorser's signature", + "in": "query", + "name": "create_transaction_for_endorser", + "schema": { + "type": "boolean" + } + }, + { + "description": "Mediation identifier", + "in": "query", + "name": "mediation_id", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DIDResult" + } + } + }, + "description": "" + } + }, + "summary": "Assign the current public DID", + "tags": ["wallet"] + } + }, + "/wallet/get-did-endpoint": { + "get": { + "parameters": [ + { + "description": "DID of interest", + "in": "query", + "name": "did", + "required": true, + "schema": { + "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": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DIDEndpoint" + } + } + }, + "description": "" + } + }, + "summary": "Query DID endpoint in wallet", + "tags": ["wallet"] + } + }, + "/wallet/jwt/sign": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/JWSCreate" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WalletModuleResponse" + } + } + }, + "description": "" + } + }, + "summary": "Create a EdDSA jws using did keys with a given payload", + "tags": ["wallet"], + "x-codegen-request-body-name": "body" + } + }, + "/wallet/jwt/verify": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/JWSVerify" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JWSVerifyResponse" + } + } + }, + "description": "" + } + }, + "summary": "Verify a EdDSA jws using did keys with a given JWS", + "tags": ["wallet"], + "x-codegen-request-body-name": "body" + } + }, + "/wallet/sd-jwt/sign": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SDJWSCreate" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WalletModuleResponse" + } + } + }, + "description": "" + } + }, + "summary": "Create a EdDSA sd-jws using did keys with a given payload", + "tags": ["wallet"], + "x-codegen-request-body-name": "body" + } + }, + "/wallet/sd-jwt/verify": { + "post": { + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/SDJWSVerify" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SDJWSVerifyResponse" + } + } + }, + "description": "" + } + }, + "summary": "Verify a EdDSA sd-jws using did keys with a given SD-JWS with optional key binding", + "tags": ["wallet"], + "x-codegen-request-body-name": "body" + } + }, + "/wallet/set-did-endpoint": { + "post": { + "parameters": [ + { + "description": "Connection identifier", + "in": "query", + "name": "conn_id", + "schema": { + "type": "string" + } + }, + { + "description": "Create Transaction For Endorser's signature", + "in": "query", + "name": "create_transaction_for_endorser", + "schema": { + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/DIDEndpointWithType" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WalletModuleResponse" + } + } + }, + "description": "" + } + }, + "summary": "Update endpoint in wallet and on ledger if posted to it", + "tags": ["wallet"], + "x-codegen-request-body-name": "body" + } + } + }, + "components": { + "schemas": { + "AMLRecord": { + "properties": { + "aml": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "amlContext": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "ActionMenuFetchResult": { + "properties": { + "result": { + "allOf": [ + { + "$ref": "#/components/schemas/Menu" + } + ], + "description": "Action menu", + "type": "object" + } + }, + "type": "object" + }, + "ActionMenuModulesResult": { + "type": "object" + }, + "AdminConfig": { + "properties": { + "config": { + "description": "Configuration settings", + "properties": {}, + "type": "object" + } + }, + "required": ["config"], + "type": "object" + }, + "AdminMediationDeny": { + "type": "object" + }, + "AdminModules": { + "properties": { + "result": { + "description": "List of admin modules", + "items": { + "description": "admin module", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdminReset": { + "type": "object" + }, + "AdminShutdown": { + "type": "object" + }, + "AdminStatus": { + "properties": { + "conductor": { + "description": "Conductor statistics", + "properties": {}, + "type": "object" + }, + "label": { + "description": "Default label", + "nullable": true, + "type": "string" + }, + "timing": { + "description": "Timing results", + "properties": {}, + "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" + }, + "AnonCredsSchema": { + "properties": { + "attrNames": { + "description": "Schema attribute names", + "items": { + "description": "Attribute name", + "example": "score", + "type": "string" + }, + "type": "array" + }, + "issuerId": { + "description": "Issuer Identifier of the credential definition or schema", + "example": "WgWxqztrNooG92RXvxSTWv", + "type": "string" + }, + "name": { + "description": "Schema name", + "example": "Example schema", + "type": "string" + }, + "version": { + "description": "Schema version", + "example": "1.0", + "type": "string" + } + }, + "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": "#/components/schemas/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\"}", + "type": "object" + }, + "jws": { + "allOf": [ + { + "$ref": "#/components/schemas/AttachDecoratorDataJWS" + } + ], + "description": "Detached Java Web Signature", + "type": "object" + }, + "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": "#/components/schemas/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": "#/components/schemas/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": "#/components/schemas/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" + }, + "nullable": true, + "type": "object" + } + }, + "type": "object" + }, + "BasicMessageModuleResponse": { + "type": "object" + }, + "ClaimFormat": { + "properties": { + "jwt": { + "properties": {}, + "type": "object" + }, + "jwt_vc": { + "properties": {}, + "type": "object" + }, + "jwt_vp": { + "properties": {}, + "type": "object" + }, + "ldp": { + "properties": {}, + "type": "object" + }, + "ldp_vc": { + "properties": {}, + "type": "object" + }, + "ldp_vp": { + "properties": {}, + "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", "didexchange/1.1"], + "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": "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" + }, + "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": "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" + }, + "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" + } + }, + "required": ["connection_id"], + "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", + "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", + "nullable": true, + "type": "string" + }, + "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": "#/components/schemas/ConnRecord" + }, + "type": "array" + } + }, + "required": ["results"], + "type": "object" + }, + "ConnectionMetadata": { + "properties": { + "results": { + "description": "Dictionary of metadata associated with connection.", + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "ConnectionMetadataSetRequest": { + "properties": { + "metadata": { + "description": "Dictionary of metadata to set for connection.", + "properties": {}, + "type": "object" + } + }, + "required": ["metadata"], + "type": "object" + }, + "ConnectionModuleResponse": { + "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": "#/components/schemas/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": "#/components/schemas/DIFField" + }, + "type": "array" + }, + "is_holder": { + "items": { + "$ref": "#/components/schemas/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", + "properties": {}, + "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", + "properties": {}, + "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. Must be same as base wallet.", + "enum": ["askar", "askar-anoncreds", "in_memory", "indy"], + "example": "askar", + "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.", + "properties": {}, + "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 unmanaged 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", + "nullable": true, + "type": "string" + }, + "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" + }, + "CredDef": { + "properties": { + "issuerId": { + "description": "Issuer Identifier of the credential definition or schema", + "example": "WgWxqztrNooG92RXvxSTWv", + "type": "string" + }, + "schemaId": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "type": "string" + }, + "tag": { + "description": "The tag value passed in by the Issuer to an AnonCred's Credential Definition create and store implementation.", + "example": "default", + "type": "string" + }, + "type": { + "enum": ["CL"], + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/CredDefValueSchemaAnoncreds" + } + }, + "type": "object" + }, + "CredDefPostOptions": { + "properties": { + "create_transaction_for_endorser": { + "description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", + "example": false, + "type": "boolean" + }, + "endorser_connection_id": { + "description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "revocation_registry_size": { + "description": "Maximum number of credential revocations per registry", + "example": 1000, + "format": "int32", + "type": "integer" + }, + "support_revocation": { + "description": "Support credential revocation", + "type": "boolean" + } + }, + "type": "object" + }, + "CredDefPostRequest": { + "properties": { + "credential_definition": { + "$ref": "#/components/schemas/InnerCredDef" + }, + "options": { + "$ref": "#/components/schemas/CredDefPostOptions" + } + }, + "type": "object" + }, + "CredDefResult": { + "properties": { + "credential_definition_metadata": { + "properties": {}, + "type": "object" + }, + "credential_definition_state": { + "$ref": "#/components/schemas/CredDefState" + }, + "job_id": { + "type": "string" + }, + "registration_metadata": { + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "CredDefState": { + "properties": { + "credential_definition": { + "allOf": [ + { + "$ref": "#/components/schemas/CredDef" + } + ], + "description": "credential definition", + "type": "object" + }, + "credential_definition_id": { + "description": "credential definition id", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "nullable": true, + "type": "string" + }, + "state": { + "enum": ["finished", "failed", "action", "wait"], + "type": "string" + } + }, + "type": "object" + }, + "CredDefValue": { + "properties": { + "primary": { + "allOf": [ + { + "$ref": "#/components/schemas/CredDefValuePrimary" + } + ], + "description": "Primary value for credential definition", + "type": "object" + }, + "revocation": { + "allOf": [ + { + "$ref": "#/components/schemas/CredDefValueRevocation" + } + ], + "description": "Revocation value for credential definition", + "type": "object" + } + }, + "type": "object" + }, + "CredDefValuePrimary": { + "properties": { + "n": { + "example": "0", + "pattern": "^[0-9]*$", + "type": "string" + }, + "r": { + "$ref": "#/components/schemas/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" + }, + "CredDefValuePrimarySchemaAnoncreds": { + "properties": { + "n": { + "example": "0", + "pattern": "^[0-9]*$", + "type": "string" + }, + "r": { + "properties": {}, + "type": "object" + }, + "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" + }, + "CredDefValueRevocationSchemaAnoncreds": { + "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" + }, + "CredDefValueSchemaAnoncreds": { + "properties": { + "primary": { + "allOf": [ + { + "$ref": "#/components/schemas/CredDefValuePrimarySchemaAnoncreds" + } + ], + "description": "Primary value for credential definition", + "type": "object" + }, + "revocation": { + "allOf": [ + { + "$ref": "#/components/schemas/CredDefValueRevocationSchemaAnoncreds" + } + ], + "description": "Revocation value for credential definition", + "type": "object" + } + }, + "type": "object" + }, + "CredInfoList": { + "properties": { + "results": { + "items": { + "$ref": "#/components/schemas/IndyCredInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "CredRevIndyRecordsResult": { + "properties": { + "rev_reg_delta": { + "description": "Indy revocation registry delta", + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "CredRevIndyRecordsResultSchemaAnoncreds": { + "properties": { + "rev_reg_delta": { + "description": "Indy revocation registry delta", + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "CredRevRecordDetailsResult": { + "properties": { + "results": { + "items": { + "$ref": "#/components/schemas/IssuerCredRevRecord" + }, + "type": "array" + } + }, + "type": "object" + }, + "CredRevRecordDetailsResultSchemaAnoncreds": { + "properties": { + "results": { + "items": { + "$ref": "#/components/schemas/IssuerCredRevRecordSchemaAnoncreds" + }, + "type": "array" + } + }, + "type": "object" + }, + "CredRevRecordResult": { + "properties": { + "result": { + "$ref": "#/components/schemas/IssuerCredRevRecordSchemaAnoncreds" + } + }, + "type": "object" + }, + "CredRevRecordResultSchemaAnoncreds": { + "properties": { + "result": { + "$ref": "#/components/schemas/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": "object" + }, + "type": "array" + }, + "credentialStatus": { + "example": "", + "type": "object" + }, + "credentialSubject": { + "example": "", + "type": "object" + }, + "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": { + "description": "The ID of the credential", + "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", + "type": "object" + }, + "proof": { + "allOf": [ + { + "$ref": "#/components/schemas/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": "object" + }, + "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": { + "description": "Signature type: CL for Camenisch-Lysyanskaya", + "example": "CL", + "type": "object" + }, + "value": { + "allOf": [ + { + "$ref": "#/components/schemas/CredDefValue" + } + ], + "description": "Credential definition primary and revocation values", + "type": "object" + }, + "ver": { + "description": "Node protocol version", + "example": "1.0", + "pattern": "^[0-9.]+$", + "type": "string" + } + }, + "type": "object" + }, + "CredentialDefinitionGetResult": { + "properties": { + "credential_definition": { + "$ref": "#/components/schemas/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" + } + }, + "required": ["credential_definition_id"], + "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", + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "nullable": true, + "type": "string" + }, + "credential_preview": { + "$ref": "#/components/schemas/CredentialPreview" + }, + "offers~attach": { + "items": { + "$ref": "#/components/schemas/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": "#/components/schemas/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", + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "nullable": true, + "type": "string" + }, + "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": "#/components/schemas/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" + }, + "metadata": { + "description": "Additional metadata associated with the DID", + "properties": {}, + "type": "object" + }, + "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" + } + }, + "required": ["did", "key_type", "method", "posture", "verkey"], + "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": "#/components/schemas/DIDCreateOptions" + } + ], + "description": "To define a key type and/or a did depending on chosen DID method.", + "type": "object" + }, + "seed": { + "description": "Optional seed to use for DID, Must be enabled 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": "#/components/schemas/DID" + }, + "type": "array" + } + }, + "type": "object" + }, + "DIDResult": { + "properties": { + "result": { + "$ref": "#/components/schemas/DID" + } + }, + "type": "object" + }, + "DIDRotateRequestJSON": { + "properties": { + "to_did": { + "description": "The DID the rotating party is rotating to", + "example": "did:web:example.com", + "type": "string" + } + }, + "required": ["to_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", + "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": "#/components/schemas/AttachDecorator" + } + ], + "description": "As signed attachment, DID Doc associated with DID", + "type": "object" + }, + "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": "#/components/schemas/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": "#/components/schemas/PresentationDefinition" + }, + "record_ids": { + "description": "Mapping of input_descriptor id to list of stored W3C credential record_id", + "example": { + "": ["", ""], + "": [""] + }, + "properties": {}, + "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"] + }, + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "DIFProofProposal": { + "properties": { + "input_descriptors": { + "items": { + "$ref": "#/components/schemas/InputDescriptors" + }, + "type": "array" + }, + "options": { + "$ref": "#/components/schemas/DIFOptions" + } + }, + "type": "object" + }, + "DIFProofRequest": { + "properties": { + "options": { + "$ref": "#/components/schemas/DIFOptions" + }, + "presentation_definition": { + "$ref": "#/components/schemas/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", + "type": "string" + }, + "protocols": { + "description": "List of protocol descriptors", + "items": { + "$ref": "#/components/schemas/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", + "type": "string" + }, + "disclosures": { + "description": "List of protocol or goal_code descriptors", + "items": { + "type": "object" + }, + "type": "array" + } + }, + "required": ["disclosures"], + "type": "object" + }, + "Doc": { + "properties": { + "credential": { + "description": "Credential to sign", + "properties": {}, + "type": "object" + }, + "options": { + "allOf": [ + { + "$ref": "#/components/schemas/SignatureOptions" + } + ], + "description": "Signature options", + "type": "object" + } + }, + "required": ["credential", "options"], + "type": "object" + }, + "DocumentVerificationResult": { + "properties": { + "document": { + "properties": {}, + "type": "object" + }, + "errors": { + "items": { + "type": "string" + }, + "type": "array" + }, + "results": { + "items": { + "$ref": "#/components/schemas/ProofResult" + }, + "type": "array" + }, + "verified": { + "type": "boolean" + } + }, + "required": ["verified"], + "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" + }, + "FetchCredentialResponse": { + "properties": { + "results": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "type": "object" + }, + "Filter": { + "properties": { + "const": { + "description": "Const", + "type": "object" + }, + "enum": { + "items": { + "description": "Enum", + "type": "object" + }, + "type": "array" + }, + "exclusiveMaximum": { + "description": "ExclusiveMaximum", + "type": "object" + }, + "exclusiveMinimum": { + "description": "ExclusiveMinimum", + "type": "object" + }, + "format": { + "description": "Format", + "type": "string" + }, + "maxLength": { + "description": "Max Length", + "example": 1234, + "format": "int32", + "type": "integer" + }, + "maximum": { + "description": "Maximum", + "type": "object" + }, + "minLength": { + "description": "Min Length", + "example": 1234, + "format": "int32", + "type": "integer" + }, + "minimum": { + "description": "Minimum", + "type": "object" + }, + "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" + }, + "GetCredDefResult": { + "properties": { + "credential_definition": { + "allOf": [ + { + "$ref": "#/components/schemas/CredDef" + } + ], + "description": "credential definition", + "type": "object" + }, + "credential_definition_id": { + "description": "credential definition id", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "type": "string" + }, + "credential_definitions_metadata": { + "properties": {}, + "type": "object" + }, + "resolution_metadata": { + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "GetCredDefsResponse": { + "properties": { + "credential_definition_ids": { + "items": { + "description": "credential definition identifiers", + "example": "GvLGiRogTJubmj5B36qhYz:3:CL:8:faber.agent.degree_schema", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetDIDEndpointResponse": { + "properties": { + "endpoint": { + "description": "Full verification key", + "example": "https://myhost:8021", + "nullable": true, + "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" + }, + "GetDIDVerkeyResponse": { + "properties": { + "verkey": { + "description": "Full verification key", + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "nullable": true, + "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type": "string" + } + }, + "type": "object" + }, + "GetNymRoleResponse": { + "properties": { + "role": { + "description": "Ledger role", + "enum": [ + "STEWARD", + "TRUSTEE", + "ENDORSER", + "NETWORK_MONITOR", + "USER", + "ROLE_REMOVE" + ], + "example": "ENDORSER", + "type": "string" + } + }, + "type": "object" + }, + "GetSchemaResult": { + "properties": { + "resolution_metadata": { + "properties": {}, + "type": "object" + }, + "schema": { + "$ref": "#/components/schemas/AnonCredsSchema" + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "type": "string" + }, + "schema_metadata": { + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "GetSchemasResponse": { + "properties": { + "schema_ids": { + "items": { + "description": "Schema identifiers", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Hangup": { + "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" + } + }, + "type": "object" + }, + "HolderModuleResponse": { + "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": "#/components/schemas/IndyKeyCorrectnessProof" + } + ], + "description": "Key correctness proof", + "type": "object" + }, + "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", + "nullable": true, + "pattern": "^[1-9][0-9]*$", + "type": "string" + }, + "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", + "nullable": true, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + }, + "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": "#/components/schemas/IndyCredInfo" + } + ], + "description": "Credential info", + "type": "object" + }, + "interval": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyNonRevocationInterval" + } + ], + "description": "Non-revocation interval from presentation request", + "type": "object" + }, + "presentation_referents": { + "items": { + "description": "presentation referent", + "example": "1_age_uuid", + "type": "string" + }, + "type": "array" + } + }, + "required": ["cred_info"], + "type": "object" + }, + "IndyCredRequest": { + "properties": { + "blinded_ms": { + "description": "Blinded master secret", + "properties": {}, + "type": "object" + }, + "blinded_ms_correctness_proof": { + "description": "Blinded master secret correctness proof", + "properties": {}, + "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/Random String/UUID", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "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", + "nullable": true, + "properties": {}, + "type": "object" + }, + "rev_reg_id": { + "description": "Revocation registry identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "nullable": true, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + }, + "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", + "properties": {}, + "type": "object" + }, + "signature_correctness_proof": { + "description": "Credential signature correctness proof", + "properties": {}, + "type": "object" + }, + "values": { + "additionalProperties": { + "allOf": [ + { + "$ref": "#/definitions/IndyAttrValue" + } + ], + "description": "Attribute value", + "type": "object" + }, + "description": "Credential attributes", + "type": "object" + }, + "witness": { + "description": "Witness for revocation proof", + "nullable": true, + "properties": {}, + "type": "object" + } + }, + "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": "#/components/schemas/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": "https://didcomm.org/present-proof/1.0/presentation-preview", + "type": "string" + }, + "attributes": { + "items": { + "$ref": "#/components/schemas/IndyPresAttrSpec" + }, + "type": "array" + }, + "predicates": { + "items": { + "$ref": "#/components/schemas/IndyPresPredSpec" + }, + "type": "array" + } + }, + "required": ["attributes", "predicates"], + "type": "object" + }, + "IndyPresSpec": { + "properties": { + "requested_attributes": { + "additionalProperties": { + "$ref": "#/components/schemas/IndyRequestedCredsRequestedAttr" + }, + "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers", + "type": "object" + }, + "requested_predicates": { + "additionalProperties": { + "$ref": "#/components/schemas/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": { + "$ref": "#/components/schemas/IndyPrimaryProof_eq_proof" + }, + "ge_proofs": { + "description": "Indy GE proofs", + "items": { + "$ref": "#/components/schemas/IndyGEProof" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "IndyProof": { + "properties": { + "identifiers": { + "description": "Indy proof.identifiers content", + "items": { + "$ref": "#/components/schemas/IndyProofIdentifier" + }, + "type": "array" + }, + "proof": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyProofProof" + } + ], + "description": "Indy proof.proof content", + "type": "object" + }, + "requested_proof": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyProofRequestedProof" + } + ], + "description": "Indy proof.requested_proof content", + "type": "object" + } + }, + "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", + "nullable": true, + "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type": "string" + }, + "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, + "nullable": true, + "type": "integer" + } + }, + "type": "object" + }, + "IndyProofProof": { + "properties": { + "aggregated_proof": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyProofProofAggregatedProof" + } + ], + "description": "Indy proof aggregated proof", + "type": "object" + }, + "proofs": { + "description": "Indy proof proofs", + "items": { + "$ref": "#/components/schemas/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": { + "$ref": "#/components/schemas/IndyProofProofProofsProof_non_revoc_proof" + }, + "primary_proof": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyPrimaryProof" + } + ], + "description": "Indy primary proof", + "type": "object" + } + }, + "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": { + "$ref": "#/components/schemas/IndyProofReqAttrSpec_non_revoked" + }, + "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": { + "$ref": "#/components/schemas/IndyProofReqPredSpec_non_revoked" + }, + "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": { + "$ref": "#/components/schemas/IndyProofRequest_non_revoked" + }, + "nonce": { + "description": "Nonce", + "example": "1", + "pattern": "^[1-9][0-9]*$", + "type": "string" + }, + "requested_attributes": { + "additionalProperties": { + "$ref": "#/components/schemas/IndyProofReqAttrSpec" + }, + "description": "Requested attribute specifications of proof request", + "type": "object" + }, + "requested_predicates": { + "additionalProperties": { + "$ref": "#/components/schemas/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": "#/components/schemas/IndyProofRequestedProofPredicate" + }, + "description": "Proof requested proof predicates.", + "type": "object" + }, + "revealed_attr_groups": { + "additionalProperties": { + "$ref": "#/components/schemas/IndyProofRequestedProofRevealedAttrGroup" + }, + "description": "Proof requested proof revealed attribute groups", + "nullable": true, + "type": "object" + }, + "revealed_attrs": { + "additionalProperties": { + "$ref": "#/components/schemas/IndyProofRequestedProofRevealedAttr" + }, + "description": "Proof requested proof revealed attributes", + "nullable": true, + "type": "object" + }, + "self_attested_attrs": { + "description": "Proof requested proof self-attested attributes", + "properties": {}, + "type": "object" + }, + "unrevealed_attrs": { + "description": "Unrevealed attributes", + "properties": {}, + "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": "#/components/schemas/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": "#/components/schemas/IndyRevRegDefValue" + } + ], + "description": "Revocation registry definition value", + "type": "object" + }, + "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": "#/components/schemas/IndyRevRegDefValuePublicKeys" + } + ], + "description": "Public keys", + "type": "object" + }, + "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": "#/components/schemas/IndyRevRegDefValuePublicKeysAccumKey" + } + }, + "type": "object" + }, + "IndyRevRegDefValuePublicKeysAccumKey": { + "properties": { + "z": { + "description": "Value for z", + "example": "1 120F522F81E6B7 1 09F7A59005C4939854", + "type": "string" + } + }, + "type": "object" + }, + "IndyRevRegEntry": { + "properties": { + "value": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyRevRegEntryValue" + } + ], + "description": "Revocation registry entry value", + "type": "object" + }, + "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" + }, + "InnerCredDef": { + "properties": { + "issuerId": { + "description": "Issuer Identifier of the credential definition", + "example": "WgWxqztrNooG92RXvxSTWv", + "type": "string" + }, + "schemaId": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "type": "string" + }, + "tag": { + "description": "Credential definition tag", + "example": "default", + "type": "string" + } + }, + "required": ["issuerId", "schemaId", "tag"], + "type": "object" + }, + "InnerRevRegDef": { + "properties": { + "credDefId": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "type": "string" + }, + "issuerId": { + "description": "Issuer Identifier of the credential definition or schema", + "example": "WgWxqztrNooG92RXvxSTWv", + "type": "string" + }, + "maxCredNum": { + "description": "Maximum number of credential revocations per registry", + "example": 777, + "format": "int32", + "type": "integer" + }, + "tag": { + "description": "tag for revocation registry", + "example": "default", + "type": "string" + } + }, + "type": "object" + }, + "InputDescriptors": { + "properties": { + "constraints": { + "$ref": "#/components/schemas/Constraints" + }, + "group": { + "items": { + "description": "Group", + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "ID", + "type": "string" + }, + "metadata": { + "description": "Metadata dictionary", + "properties": {}, + "type": "object" + }, + "name": { + "description": "Name", + "type": "string" + }, + "purpose": { + "description": "Purpose", + "type": "string" + }, + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/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" + } + }, + "type": "object" + }, + "IntroModuleResponse": { + "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": "#/components/schemas/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": "https://didcomm.org/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", + "properties": {}, + "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_did": { + "description": "DID to use in invitation", + "example": "did:example:123", + "type": "string" + }, + "use_did_method": { + "description": "DID method to use in invitation", + "enum": ["did:peer:2", "did:peer:4"], + "example": "did:peer:2", + "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": "https://didcomm.org/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", + "nullable": true, + "type": "string" + }, + "label": { + "description": "Optional label", + "example": "Bob", + "type": "string" + }, + "requests~attach": { + "description": "Optional request attachment", + "items": { + "$ref": "#/components/schemas/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": "object" + }, + "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": "#/components/schemas/InvitationMessage" + } + ], + "description": "Out of band invitation message", + "type": "object" + }, + "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" + }, + "InvitationRecordResponse": { + "type": "object" + }, + "InvitationResult": { + "properties": { + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "invitation": { + "$ref": "#/components/schemas/ConnectionInvitation" + }, + "invitation_url": { + "description": "Invitation URL", + "example": "http://192.168.56.101:8020/invite?c_i=eyJAdHlwZSI6Li4ufQ==", + "type": "string" + } + }, + "required": ["connection_id", "invitation", "invitation_url"], + "type": "object" + }, + "IssueCredentialModuleResponse": { + "type": "object" + }, + "IssueCredentialRequest": { + "properties": { + "credential": { + "$ref": "#/components/schemas/Credential" + }, + "options": { + "$ref": "#/components/schemas/LDProofVCOptions" + } + }, + "type": "object" + }, + "IssueCredentialResponse": { + "properties": { + "verifiableCredential": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "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" + }, + "IssuerCredRevRecordSchemaAnoncreds": { + "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", + "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", + "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", + "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": "#/components/schemas/IndyRevRegDef" + } + ], + "description": "Revocation registry definition", + "type": "object" + }, + "revoc_reg_entry": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyRevRegEntry" + } + ], + "description": "Revocation registry entry", + "type": "object" + }, + "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": { + "properties": {}, + "type": "object" + }, + "payload": { + "properties": {}, + "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.", + "properties": {}, + "type": "object" + }, + "kid": { + "description": "kid of signer", + "type": "string" + }, + "payload": { + "description": "Payload from verified JWT", + "properties": {}, + "type": "object" + }, + "valid": { + "type": "boolean" + } + }, + "required": ["headers", "kid", "payload", "valid"], + "type": "object" + }, + "Keylist": { + "properties": { + "results": { + "description": "List of keylist records", + "items": { + "$ref": "#/components/schemas/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", + "type": "string" + }, + "filter": { + "description": "Query dictionary object", + "example": { + "filter": {} + }, + "properties": {}, + "type": "object" + }, + "paginate": { + "allOf": [ + { + "$ref": "#/components/schemas/KeylistQueryPaginate" + } + ], + "description": "Pagination info", + "type": "object" + } + }, + "type": "object" + }, + "KeylistQueryFilterRequest": { + "properties": { + "filter": { + "description": "Filter for keylist query", + "properties": {}, + "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", + "type": "string" + }, + "updates": { + "description": "List of update rules", + "items": { + "$ref": "#/components/schemas/KeylistUpdateRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "KeylistUpdateRequest": { + "properties": { + "updates": { + "items": { + "$ref": "#/components/schemas/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": "#/components/schemas/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"] + }, + "type": "object" + }, + "options": { + "allOf": [ + { + "$ref": "#/components/schemas/LDProofVCOptions" + } + ], + "description": "Options for specifying how the linked data proof is created.", + "example": { + "proofType": "Ed25519Signature2018" + }, + "type": "object" + } + }, + "required": ["credential", "options"], + "type": "object" + }, + "LDProofVCOptions": { + "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": "#/components/schemas/CredentialStatusOptions" + } + ], + "description": "The credential status mechanism to use for the credential. Omitting the property indicates the issued credential will not include a credential status", + "type": "object" + }, + "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" + }, + "verificationMethod": { + "description": "The verification method to use for the proof. Should match a verification method in the wallet", + "example": "did:example:123456#key-1", + "type": "string" + } + }, + "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": "#/components/schemas/LedgerConfigInstance" + }, + "type": "array" + } + }, + "required": ["ledger_config_list"], + "type": "object" + }, + "LedgerModulesResult": { + "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": "https://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" + }, + "ListCredentialsResponse": { + "type": "object" + }, + "MediationCreateRequest": { + "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", + "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", + "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", + "type": "string" + } + }, + "required": ["mediation_id"], + "type": "object" + }, + "MediationList": { + "properties": { + "results": { + "description": "List of mediation records", + "items": { + "$ref": "#/components/schemas/MediationRecord" + }, + "type": "array" + } + }, + "required": ["results"], + "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", + "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": "#/components/schemas/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": "#/components/schemas/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": "#/components/schemas/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": "#/components/schemas/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": { + "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": "#/components/schemas/InvitationMessage" + } + ], + "description": "Out of band invitation message", + "type": "object" + }, + "multi_use": { + "description": "Allow for multiple uses of the oob invitation", + "example": true, + "type": "boolean" + }, + "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": "#/components/schemas/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", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "PingRequestResponse": { + "properties": { + "thread_id": { + "description": "Thread ID of the ping message", + "type": "string" + } + }, + "type": "object" + }, + "Presentation": { + "properties": { + "@context": { + "description": "The JSON-LD context of the presentation", + "example": ["https://www.w3.org/2018/credentials/v1"], + "items": { + "type": "object" + }, + "type": "array" + }, + "holder": { + "description": "The JSON-LD Verifiable Credential Holder. Either string of object with id field.", + "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", + "type": "object" + }, + "id": { + "description": "The ID of the presentation", + "example": "http://example.edu/presentations/1872", + "pattern": "\\w+:(\\/?\\/?)[^\\s]+", + "type": "string" + }, + "proof": { + "allOf": [ + { + "$ref": "#/components/schemas/LinkedDataProof" + } + ], + "description": "The proof of the presentation", + "example": { + "created": "2019-12-11T03:50:55", + "jws": "eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ", + "proofPurpose": "assertionMethod", + "type": "Ed25519Signature2018", + "verificationMethod": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL" + }, + "type": "object" + }, + "type": { + "description": "The JSON-LD type of the presentation", + "example": ["VerifiablePresentation"], + "items": { + "type": "string" + }, + "type": "array" + }, + "verifiableCredential": { + "items": { + "properties": {}, + "type": "object" + }, + "type": "array" + } + }, + "required": ["@context", "type"], + "type": "object" + }, + "PresentationDefinition": { + "properties": { + "format": { + "$ref": "#/components/schemas/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": "#/components/schemas/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": "#/components/schemas/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", + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "nullable": true, + "type": "string" + }, + "presentation_proposal": { + "$ref": "#/components/schemas/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", + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "nullable": true, + "type": "string" + }, + "request_presentations~attach": { + "items": { + "$ref": "#/components/schemas/AttachDecorator" + }, + "type": "array" + } + }, + "required": ["request_presentations~attach"], + "type": "object" + }, + "PresentationVerificationResult": { + "properties": { + "credential_results": { + "items": { + "$ref": "#/components/schemas/DocumentVerificationResult" + }, + "type": "array" + }, + "errors": { + "items": { + "type": "string" + }, + "type": "array" + }, + "presentation_result": { + "$ref": "#/components/schemas/DocumentVerificationResult" + }, + "verified": { + "type": "boolean" + } + }, + "required": ["verified"], + "type": "object" + }, + "ProfileSettings": { + "properties": { + "settings": { + "description": "Profile settings dict", + "example": { + "debug.invite_public": true, + "log.level": "INFO", + "public_invites": false + }, + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "ProofResult": { + "properties": { + "error": { + "type": "string" + }, + "proof": { + "properties": {}, + "type": "object" + }, + "purpose_result": { + "$ref": "#/components/schemas/PurposeResult" + }, + "verified": { + "type": "boolean" + } + }, + "type": "object" + }, + "ProtocolDescriptor": { + "properties": { + "pid": { + "type": "string" + }, + "roles": { + "description": "List of roles", + "items": { + "description": "Role: requester or responder", + "example": "requester", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "required": ["pid"], + "type": "object" + }, + "ProvePresentationRequest": { + "properties": { + "options": { + "$ref": "#/components/schemas/LDProofVCOptions" + }, + "presentation": { + "$ref": "#/components/schemas/Presentation" + } + }, + "type": "object" + }, + "ProvePresentationResponse": { + "properties": { + "verifiablePresentation": { + "$ref": "#/components/schemas/VerifiablePresentation" + } + }, + "type": "object" + }, + "PublishRevocations": { + "properties": { + "options": { + "$ref": "#/components/schemas/PublishRevocationsOptions" + }, + "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" + }, + "PublishRevocationsOptions": { + "properties": { + "create_transaction_for_endorser": { + "description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", + "example": false, + "type": "boolean" + }, + "endorser_connection_id": { + "description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + } + }, + "type": "object" + }, + "PublishRevocationsResult": { + "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" + }, + "PublishRevocationsSchemaAnoncreds": { + "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" + }, + "PurposeResult": { + "properties": { + "controller": { + "properties": {}, + "type": "object" + }, + "error": { + "type": "string" + }, + "valid": { + "type": "boolean" + } + }, + "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", + "type": "string" + }, + "queries": { + "items": { + "$ref": "#/components/schemas/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", + "type": "string" + }, + "comment": { + "nullable": true, + "type": "string" + }, + "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", + "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", + "nullable": true, + "type": "string" + }, + "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", + "properties": {}, + "type": "object" + }, + "metadata": { + "description": "Resolution metadata", + "properties": {}, + "type": "object" + } + }, + "required": ["did_document", "metadata"], + "type": "object" + }, + "RevList": { + "properties": { + "currentAccumulator": { + "description": "The current accumulator value", + "example": "21 118...1FB", + "type": "string" + }, + "issuerId": { + "description": "Issuer Identifier of the credential definition or schema", + "example": "WgWxqztrNooG92RXvxSTWv", + "type": "string" + }, + "revRegDefId": { + "description": "The ID of the revocation registry definition", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "type": "string" + }, + "revocationList": { + "description": "Bit list representing revoked credentials", + "example": [0, 1, 1, 0], + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "timestamp": { + "description": "Timestamp at which revocation list is applicable", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "RevListCreateRequest": { + "properties": { + "options": { + "$ref": "#/components/schemas/RevListOptions" + }, + "rev_reg_def_id": { + "description": "Revocation registry definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "type": "string" + } + }, + "type": "object" + }, + "RevListOptions": { + "properties": { + "create_transaction_for_endorser": { + "description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", + "example": false, + "type": "boolean" + }, + "endorser_connection_id": { + "description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + } + }, + "type": "object" + }, + "RevListResult": { + "properties": { + "job_id": { + "type": "string" + }, + "registration_metadata": { + "properties": {}, + "type": "object" + }, + "revocation_list_metadata": { + "properties": {}, + "type": "object" + }, + "revocation_list_state": { + "$ref": "#/components/schemas/RevListState" + } + }, + "type": "object" + }, + "RevListState": { + "properties": { + "revocation_list": { + "allOf": [ + { + "$ref": "#/components/schemas/RevList" + } + ], + "description": "revocation list", + "type": "object" + }, + "state": { + "enum": ["finished", "failed", "action", "wait"], + "type": "string" + } + }, + "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" + }, + "RevRegCreateRequestSchemaAnoncreds": { + "properties": { + "options": { + "$ref": "#/components/schemas/RevRegDefOptions" + }, + "revocation_registry_definition": { + "$ref": "#/components/schemas/InnerRevRegDef" + } + }, + "type": "object" + }, + "RevRegDef": { + "properties": { + "credDefId": { + "description": "Credential definition identifier", + "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "type": "string" + }, + "issuerId": { + "description": "Issuer Identifier of the credential definition or schema", + "example": "WgWxqztrNooG92RXvxSTWv", + "type": "string" + }, + "revocDefType": { + "type": "string" + }, + "tag": { + "description": "tag for the revocation registry definition", + "example": "default", + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/RevRegDefValue" + } + }, + "type": "object" + }, + "RevRegDefOptions": { + "properties": { + "create_transaction_for_endorser": { + "description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", + "example": false, + "type": "boolean" + }, + "endorser_connection_id": { + "description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + } + }, + "type": "object" + }, + "RevRegDefResult": { + "properties": { + "job_id": { + "type": "string" + }, + "registration_metadata": { + "properties": {}, + "type": "object" + }, + "revocation_registry_definition_metadata": { + "properties": {}, + "type": "object" + }, + "revocation_registry_definition_state": { + "$ref": "#/components/schemas/RevRegDefState" + } + }, + "type": "object" + }, + "RevRegDefState": { + "properties": { + "revocation_registry_definition": { + "allOf": [ + { + "$ref": "#/components/schemas/RevRegDef" + } + ], + "description": "revocation registry definition", + "type": "object" + }, + "revocation_registry_definition_id": { + "description": "revocation registry definition id", + "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "type": "string" + }, + "state": { + "enum": [ + "finished", + "failed", + "action", + "wait", + "decommissioned", + "full" + ], + "type": "string" + } + }, + "type": "object" + }, + "RevRegDefValue": { + "properties": { + "maxCredNum": { + "example": 777, + "format": "int32", + "type": "integer" + }, + "publicKeys": { + "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "properties": {}, + "type": "object" + }, + "tailsHash": { + "example": "7Qen9RDyemMuV7xGQvp7NjwMSpyHieJyBakycxN7dX7P", + "type": "string" + }, + "tailsLocation": { + "example": "https://tails-server.com/hash/7Qen9RDyemMuV7xGQvp7NjwMSpyHieJyBakycxN7dX7P", + "type": "string" + } + }, + "type": "object" + }, + "RevRegIssuedResult": { + "properties": { + "result": { + "description": "Number of credentials issued against revocation registry", + "example": 0, + "format": "int32", + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "RevRegIssuedResultSchemaAnoncreds": { + "properties": { + "result": { + "description": "Number of credentials issued against revocation registry", + "example": 0, + "format": "int32", + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "RevRegResult": { + "properties": { + "result": { + "$ref": "#/components/schemas/IssuerRevRegRecord" + } + }, + "type": "object" + }, + "RevRegResultSchemaAnoncreds": { + "properties": { + "result": { + "$ref": "#/components/schemas/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", + "properties": {}, + "type": "object" + }, + "accum_fixed": { + "description": "Applied ledger transaction to fix revocations", + "properties": {}, + "type": "object" + }, + "rev_reg_delta": { + "description": "Indy revocation registry delta", + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "RevRegWalletUpdatedResultSchemaAnoncreds": { + "properties": { + "accum_calculated": { + "description": "Calculated accumulator for phantom revocations", + "properties": {}, + "type": "object" + }, + "accum_fixed": { + "description": "Applied ledger transaction to fix revocations", + "properties": {}, + "type": "object" + }, + "rev_reg_delta": { + "description": "Indy revocation registry delta", + "properties": {}, + "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" + }, + "RevRegsCreatedSchemaAnoncreds": { + "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" + }, + "RevocationAnoncredsModuleResponse": { + "type": "object" + }, + "RevocationModuleResponse": { + "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" + }, + "RevokeRequestSchemaAnoncreds": { + "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" + }, + "Rotate": { + "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" + }, + "to_did": { + "description": "The DID the rotating party is rotating to", + "example": "did:example:newdid", + "type": "string" + } + }, + "required": ["to_did"], + "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": { + "properties": {}, + "type": "object" + }, + "non_sd_list": { + "items": { + "example": "", + "pattern": "[a-z0-9:\\[\\]_\\.@?\\(\\)]", + "type": "string" + }, + "type": "array" + }, + "payload": { + "properties": {}, + "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": "object" + }, + "type": "array" + }, + "type": "array" + }, + "error": { + "description": "Error text", + "type": "string" + }, + "headers": { + "description": "Headers from verified JWT.", + "properties": {}, + "type": "object" + }, + "kid": { + "description": "kid of signer", + "type": "string" + }, + "payload": { + "description": "Payload from verified JWT", + "properties": {}, + "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": "#/components/schemas/Schema" + } + }, + "type": "object" + }, + "SchemaInputDescriptor": { + "properties": { + "required": { + "description": "Required", + "type": "boolean" + }, + "uri": { + "description": "URI", + "type": "string" + } + }, + "type": "object" + }, + "SchemaPostOption": { + "properties": { + "create_transaction_for_endorser": { + "description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", + "example": false, + "type": "boolean" + }, + "endorser_connection_id": { + "description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + } + }, + "type": "object" + }, + "SchemaPostRequest": { + "properties": { + "options": { + "$ref": "#/components/schemas/SchemaPostOption" + }, + "schema": { + "$ref": "#/components/schemas/AnonCredsSchema" + } + }, + "type": "object" + }, + "SchemaResult": { + "properties": { + "job_id": { + "type": "string" + }, + "registration_metadata": { + "properties": {}, + "type": "object" + }, + "schema_metadata": { + "properties": {}, + "type": "object" + }, + "schema_state": { + "$ref": "#/components/schemas/SchemaState" + } + }, + "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": "#/components/schemas/Schema" + } + ], + "description": "Schema definition", + "type": "object" + }, + "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" + }, + "SchemaState": { + "properties": { + "schema": { + "$ref": "#/components/schemas/AnonCredsSchema" + }, + "schema_id": { + "description": "Schema identifier", + "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "type": "string" + }, + "state": { + "enum": ["finished", "failed", "action", "wait"], + "type": "string" + } + }, + "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": "#/components/schemas/SchemaInputDescriptor" + }, + "type": "array" + }, + "type": "array" + } + }, + "type": "object" + }, + "SendMenu": { + "properties": { + "menu": { + "allOf": [ + { + "$ref": "#/components/schemas/MenuJson" + } + ], + "description": "Menu to send to connection", + "type": "object" + } + }, + "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": "#/components/schemas/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", + "properties": {}, + "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": "#/components/schemas/SignatureOptions" + } + ], + "description": "Linked data proof", + "type": "object" + } + }, + "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": "#/components/schemas/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": "#/components/schemas/AMLRecord" + }, + "taa_accepted": { + "$ref": "#/components/schemas/TAAAcceptance" + }, + "taa_record": { + "$ref": "#/components/schemas/TAARecord" + }, + "taa_required": { + "type": "boolean" + } + }, + "type": "object" + }, + "TAARecord": { + "properties": { + "digest": { + "type": "string" + }, + "text": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + }, + "TAAResult": { + "properties": { + "result": { + "$ref": "#/components/schemas/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": "#/components/schemas/TransactionRecord" + }, + "type": "array" + } + }, + "type": "object" + }, + "TransactionRecord": { + "properties": { + "_type": { + "description": "Transaction type", + "example": "101", + "type": "string" + }, + "connection_id": { + "description": "The connection identifier for this 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": "Request Endorser to write the ledger transaction, this parameter is deprecated and no longer supported.", + "example": false, + "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" + }, + "properties": {}, + "type": "object" + }, + "type": "array" + }, + "meta_data": { + "example": { + "context": { + "param1": "param1_value", + "param2": "param2_value" + }, + "post_process": [ + { + "topic": "topic_value", + "other": "other_value" + } + ] + }, + "properties": {}, + "type": "object" + }, + "signature_request": { + "items": { + "example": { + "author_goal_code": "aries.transaction.ledger.write", + "context": "did:sov", + "method": "add-signature", + "signature_type": "default", + "signer_goal_code": "aries.transaction.endorse" + }, + "properties": {}, + "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" + }, + "properties": {}, + "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" + }, + "properties": {}, + "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": "#/components/schemas/CredentialDefinitionSendResult" + }, + "txn": { + "allOf": [ + { + "$ref": "#/components/schemas/TransactionRecord" + } + ], + "description": "Credential definition transaction to endorse", + "type": "object" + } + }, + "type": "object" + }, + "TxnOrPublishRevocationsResult": { + "properties": { + "sent": { + "$ref": "#/components/schemas/PublishRevocationsSchemaAnoncreds" + }, + "txn": { + "allOf": [ + { + "$ref": "#/components/schemas/TransactionRecord" + } + ], + "description": "Revocation registry revocations transaction to endorse", + "type": "object" + } + }, + "type": "object" + }, + "TxnOrRegisterLedgerNymResponse": { + "properties": { + "success": { + "description": "Success of nym registration operation", + "example": true, + "type": "boolean" + }, + "txn": { + "allOf": [ + { + "$ref": "#/components/schemas/TransactionRecord" + } + ], + "description": "DID transaction to endorse", + "type": "object" + } + }, + "type": "object" + }, + "TxnOrRevRegResult": { + "properties": { + "sent": { + "$ref": "#/components/schemas/RevRegResult" + }, + "txn": { + "allOf": [ + { + "$ref": "#/components/schemas/TransactionRecord" + } + ], + "description": "Revocation registry definition transaction to endorse", + "type": "object" + } + }, + "type": "object" + }, + "TxnOrSchemaSendResult": { + "properties": { + "sent": { + "allOf": [ + { + "$ref": "#/components/schemas/SchemaSendResult" + } + ], + "description": "Content sent", + "type": "object" + }, + "txn": { + "allOf": [ + { + "$ref": "#/components/schemas/TransactionRecord" + } + ], + "description": "Schema transaction to endorse", + "type": "object" + } + }, + "type": "object" + }, + "UpdateProfileSettings": { + "properties": { + "extra_settings": { + "description": "Agent config key-value pairs", + "example": { + "ACAPY_INVITE_PUBLIC": true, + "log-level": "INFO", + "public-invites": false + }, + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "UpdateWalletRequest": { + "properties": { + "extra_settings": { + "description": "Agent config key-value pairs", + "properties": {}, + "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": "#/components/schemas/CredentialProposal" + } + ], + "description": "Optional counter-proposal", + "type": "object" + } + }, + "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", + "nullable": true, + "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": "#/components/schemas/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", + "nullable": true, + "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": "#/components/schemas/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": "#/components/schemas/IndyCredInfo" + } + ], + "description": "Credential as stored", + "type": "object" + }, + "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": "#/components/schemas/IndyCredAbstract" + } + ], + "description": "(Indy) credential offer", + "type": "object" + }, + "credential_offer_dict": { + "allOf": [ + { + "$ref": "#/components/schemas/CredentialOffer" + } + ], + "description": "Credential offer message", + "type": "object" + }, + "credential_proposal_dict": { + "allOf": [ + { + "$ref": "#/components/schemas/CredentialProposal" + } + ], + "description": "Credential proposal message", + "type": "object" + }, + "credential_request": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyCredRequest" + } + ], + "description": "(Indy) credential request", + "type": "object" + }, + "credential_request_metadata": { + "description": "(Indy) credential request metadata", + "properties": {}, + "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": "#/components/schemas/IndyCredential" + } + ], + "description": "Credential as received, prior to storage in holder wallet", + "type": "object" + }, + "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": "#/components/schemas/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", + "nullable": true, + "type": "string" + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "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": "#/components/schemas/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", + "nullable": true, + "type": "string" + } + }, + "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", + "nullable": true, + "type": "string" + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "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": "#/components/schemas/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", + "nullable": true, + "type": "string" + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "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": "#/components/schemas/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": "#/components/schemas/V10DiscoveryRecord" + } + ], + "description": "Discover Features v1.0 exchange record", + "type": "object" + }, + "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": "#/components/schemas/Disclose" + } + ], + "description": "Disclose message", + "type": "object" + }, + "discovery_exchange_id": { + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "query_msg": { + "allOf": [ + { + "$ref": "#/components/schemas/Query" + } + ], + "description": "Query message", + "type": "object" + }, + "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": { + "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": { + "nullable": true, + "type": "string" + }, + "proof_request": { + "$ref": "#/components/schemas/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": "#/components/schemas/IndyProof" + } + ], + "description": "(Indy) presentation (also known as proof)", + "type": "object" + }, + "presentation_exchange_id": { + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "presentation_proposal_dict": { + "allOf": [ + { + "$ref": "#/components/schemas/PresentationProposal" + } + ], + "description": "Presentation proposal message", + "type": "object" + }, + "presentation_request": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyProofRequest" + } + ], + "description": "(Indy) presentation request (also known as proof request)", + "type": "object" + }, + "presentation_request_dict": { + "allOf": [ + { + "$ref": "#/components/schemas/PresentationRequest" + } + ], + "description": "Presentation request message", + "type": "object" + }, + "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": "#/components/schemas/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", + "nullable": true, + "type": "string" + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "presentation_proposal": { + "$ref": "#/components/schemas/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": "#/components/schemas/IndyRequestedCredsRequestedAttr" + }, + "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers", + "type": "object" + }, + "requested_predicates": { + "additionalProperties": { + "$ref": "#/components/schemas/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": { + "nullable": true, + "type": "string" + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "proof_request": { + "$ref": "#/components/schemas/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", + "nullable": true, + "type": "string" + }, + "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": "#/components/schemas/V20CredPreview" + } + ], + "description": "Optional content for counter-proposal", + "type": "object" + }, + "filter": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredFilter" + } + ], + "description": "Credential specification criteria by format", + "type": "object" + } + }, + "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", + "nullable": true, + "type": "string" + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "credential_preview": { + "$ref": "#/components/schemas/V20CredPreview" + }, + "filter": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredFilter" + } + ], + "description": "Credential specification criteria by format", + "type": "object" + }, + "replacement_id": { + "description": "Optional identifier used to manage credential replacement", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "nullable": true, + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + }, + "verification_method": { + "description": "For ld-proofs. Verification method for signing.", + "nullable": true, + "type": "string" + } + }, + "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": "#/components/schemas/V20CredExRecordByFormat" + } + ], + "description": "Attachment content by format for proposal, offer, request, and issue", + "type": "object" + }, + "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": "#/components/schemas/V20CredIssue" + } + ], + "description": "Serialized credential issue message", + "type": "object" + }, + "cred_offer": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredOffer" + } + ], + "description": "Credential offer message", + "type": "object" + }, + "cred_preview": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredPreview" + } + ], + "description": "Credential preview from credential proposal", + "type": "object" + }, + "cred_proposal": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredProposal" + } + ], + "description": "Credential proposal message", + "type": "object" + }, + "cred_request": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredRequest" + } + ], + "description": "Serialized credential request message", + "type": "object" + }, + "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": { + "properties": {}, + "type": "object" + }, + "cred_offer": { + "properties": {}, + "type": "object" + }, + "cred_proposal": { + "properties": {}, + "type": "object" + }, + "cred_request": { + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "V20CredExRecordDetail": { + "properties": { + "cred_ex_record": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredExRecord" + } + ], + "description": "Credential exchange record", + "type": "object" + }, + "indy": { + "$ref": "#/components/schemas/V20CredExRecordIndy" + }, + "ld_proof": { + "$ref": "#/components/schemas/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", + "properties": {}, + "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": "#/components/schemas/V20CredExRecordDetail" + }, + "type": "array" + } + }, + "type": "object" + }, + "V20CredFilter": { + "properties": { + "indy": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredFilterIndy" + } + ], + "description": "Credential filter for indy", + "type": "object" + }, + "ld_proof": { + "allOf": [ + { + "$ref": "#/components/schemas/LDProofVCDetail" + } + ], + "description": "Credential filter for linked data proof", + "type": "object" + } + }, + "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": "#/components/schemas/LDProofVCDetail" + } + ], + "description": "Credential filter for linked data proof", + "type": "object" + } + }, + "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", + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "nullable": true, + "type": "string" + }, + "credentials~attach": { + "description": "Credential attachments", + "items": { + "$ref": "#/components/schemas/AttachDecorator" + }, + "type": "array" + }, + "formats": { + "description": "Acceptable attachment formats", + "items": { + "$ref": "#/components/schemas/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", + "nullable": true, + "type": "string" + } + }, + "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", + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "nullable": true, + "type": "string" + }, + "credential_preview": { + "$ref": "#/components/schemas/V20CredPreview" + }, + "formats": { + "description": "Acceptable credential formats", + "items": { + "$ref": "#/components/schemas/V20CredFormat" + }, + "type": "array" + }, + "offers~attach": { + "description": "Offer attachments", + "items": { + "$ref": "#/components/schemas/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", + "nullable": true, + "type": "string" + }, + "credential_preview": { + "$ref": "#/components/schemas/V20CredPreview" + }, + "filter": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredFilter" + } + ], + "description": "Credential specification criteria by format", + "type": "object" + }, + "replacement_id": { + "description": "Optional identifier used to manage credential replacement", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "nullable": true, + "type": "string" + }, + "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", + "nullable": true, + "type": "string" + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "credential_preview": { + "$ref": "#/components/schemas/V20CredPreview" + }, + "filter": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredFilter" + } + ], + "description": "Credential specification criteria by format", + "type": "object" + }, + "replacement_id": { + "description": "Optional identifier used to manage credential replacement", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "nullable": true, + "type": "string" + }, + "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": "#/components/schemas/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", + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "nullable": true, + "type": "string" + }, + "credential_preview": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredPreview" + } + ], + "description": "Credential preview", + "type": "object" + }, + "filters~attach": { + "description": "Credential filter per acceptable format on corresponding identifier", + "items": { + "$ref": "#/components/schemas/AttachDecorator" + }, + "type": "array" + }, + "formats": { + "description": "Attachment formats", + "items": { + "$ref": "#/components/schemas/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", + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "nullable": true, + "type": "string" + }, + "formats": { + "description": "Acceptable attachment formats", + "items": { + "$ref": "#/components/schemas/V20CredFormat" + }, + "type": "array" + }, + "requests~attach": { + "description": "Request attachments", + "items": { + "$ref": "#/components/schemas/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", + "nullable": true, + "type": "string" + }, + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "filter": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredFilterLDProof" + } + ], + "description": "Credential specification criteria by format", + "type": "object" + }, + "holder_did": { + "description": "Holder DID to substitute for the credentialSubject.id", + "example": "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", + "nullable": true, + "type": "string" + }, + "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", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "V20CredStoreRequest": { + "properties": { + "credential_id": { + "type": "string" + } + }, + "type": "object" + }, + "V20DiscoveryExchangeListResult": { + "properties": { + "results": { + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/V20DiscoveryRecord" + } + ], + "description": "Discover Features v2.0 exchange record", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "V20DiscoveryExchangeResult": { + "properties": { + "results": { + "allOf": [ + { + "$ref": "#/components/schemas/V20DiscoveryRecord" + } + ], + "description": "Discover Features v2.0 exchange record", + "type": "object" + } + }, + "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": "#/components/schemas/Disclosures" + } + ], + "description": "Disclosures message", + "type": "object" + }, + "discovery_exchange_id": { + "description": "Credential exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "queries_msg": { + "allOf": [ + { + "$ref": "#/components/schemas/Queries" + } + ], + "description": "Queries message", + "type": "object" + }, + "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", + "nullable": true, + "type": "string" + }, + "credential_preview": { + "$ref": "#/components/schemas/V20CredPreview" + }, + "filter": { + "allOf": [ + { + "$ref": "#/components/schemas/V20CredFilter" + } + ], + "description": "Credential specification criteria by format", + "type": "object" + }, + "replacement_id": { + "description": "Optional identifier used to manage credential replacement", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "nullable": true, + "type": "string" + }, + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + } + }, + "required": ["filter"], + "type": "object" + }, + "V20IssueCredentialModuleResponse": { + "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", + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "nullable": true, + "type": "string" + }, + "formats": { + "description": "Acceptable attachment formats", + "items": { + "$ref": "#/components/schemas/V20PresFormat" + }, + "type": "array" + }, + "presentations~attach": { + "items": { + "$ref": "#/components/schemas/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": { + "nullable": true, + "type": "string" + }, + "presentation_request": { + "$ref": "#/components/schemas/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": "#/components/schemas/V20PresExRecordByFormat" + } + ], + "description": "Attachment content by format for proposal, request, and presentation", + "type": "object" + }, + "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": "#/components/schemas/V20Pres" + } + ], + "description": "Presentation message", + "type": "object" + }, + "pres_ex_id": { + "description": "Presentation exchange identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type": "string" + }, + "pres_proposal": { + "allOf": [ + { + "$ref": "#/components/schemas/V20PresProposal" + } + ], + "description": "Presentation proposal message", + "type": "object" + }, + "pres_request": { + "allOf": [ + { + "$ref": "#/components/schemas/V20PresRequest" + } + ], + "description": "Presentation request message", + "type": "object" + }, + "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": { + "properties": {}, + "type": "object" + }, + "pres_proposal": { + "properties": {}, + "type": "object" + }, + "pres_request": { + "properties": {}, + "type": "object" + } + }, + "type": "object" + }, + "V20PresExRecordList": { + "properties": { + "results": { + "description": "Presentation exchange records", + "items": { + "$ref": "#/components/schemas/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", + "type": "string" + }, + "comment": { + "description": "Human-readable comment", + "type": "string" + }, + "formats": { + "description": "Acceptable attachment formats", "items": { - "description": "Credential revocation identifier", - "example": "12345", - "pattern": "^[1-9][0-9]*$", - "type": "string" + "$ref": "#/components/schemas/V20PresFormat" }, "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" + "proposals~attach": { + "description": "Attachment per acceptable format on corresponding identifier", + "items": { + "$ref": "#/components/schemas/AttachDecorator" + }, + "type": "array" + } + }, + "required": ["formats", "proposals~attach"], + "type": "object" + }, + "V20PresProposalByFormat": { + "properties": { + "dif": { + "allOf": [ + { + "$ref": "#/components/schemas/DIFProofProposal" + } + ], + "description": "Presentation proposal for DIF", + "type": "object" }, - "type": "array" + "indy": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyProofRequest" + } + ], + "description": "Presentation proposal for indy", + "type": "object" + } }, - "routingKeys": { - "description": "List of routing keys", - "items": { - "description": "Routing key", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "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", + "nullable": true, "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}$", + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string" }, - "type": "array" + "presentation_proposal": { + "$ref": "#/components/schemas/V20PresProposalByFormat" + }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } }, - "routing_keys": { - "description": "List of routing keys", - "items": { - "description": "Routing key", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "required": ["connection_id", "presentation_proposal"], + "type": "object" + }, + "V20PresRequest": { + "properties": { + "@id": { + "description": "Message identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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": { + "description": "Message type", + "example": "https://didcomm.org/my-family/1.0/my-message-type", "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}", + "comment": { + "description": "Human-readable comment", "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" + "formats": { + "description": "Acceptable attachment formats", + "items": { + "$ref": "#/components/schemas/V20PresFormat" + }, + "type": "array" + }, + "request_presentations~attach": { + "description": "Attachment per acceptable format on corresponding identifier", + "items": { + "$ref": "#/components/schemas/AttachDecorator" + }, + "type": "array" + }, + "will_confirm": { + "description": "Whether verifier will send confirmation ack", + "type": "boolean" + } }, - "domain": { - "description": "Domain protect against replay attack", - "example": "4jt78h47fh47", - "type": "string" - } + "required": ["formats", "request_presentations~attach"], + "type": "object" }, - "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": { - "": ["", ""], - "": [""] + "V20PresRequestByFormat": { + "properties": { + "dif": { + "allOf": [ + { + "$ref": "#/components/schemas/DIFProofRequest" + } + ], + "description": "Presentation request for DIF", + "type": "object" }, - "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" + "indy": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyProofRequest" + } ], - "@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" - }, - "FetchCredentialResponse": { - "properties": { - "results": { "$ref": "#/definitions/VerifiableCredential" } - }, - "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]*$", + "description": "Presentation request for indy", + "type": "object" + } + }, + "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": { + "nullable": true, "type": "string" }, - "type": "object" - }, - "m2": { "example": "0", "pattern": "^[0-9]*$", "type": "string" }, - "revealed_attrs": { - "additionalProperties": { - "example": "-1", - "pattern": "^-?[0-9]*$", + "connection_id": { + "description": "Connection identifier", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string" }, - "type": "object" + "presentation_request": { + "$ref": "#/components/schemas/V20PresRequestByFormat" + }, + "trace": { + "description": "Whether to trace event (default false)", + "example": false, + "type": "boolean" + } }, - "v": { "example": "0", "pattern": "^[0-9]*$", "type": "string" } + "required": ["connection_id", "presentation_request"], + "type": "object" }, - "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" + "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": "#/components/schemas/DIFPresSpec" + } + ], + "description": "Optional Presentation specification for DIF, overrides the PresentationExchange record's PresRequest", + "type": "object" + }, + "indy": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyPresSpec" + } + ], + "description": "Presentation specification for indy", + "type": "object" }, - "type": "object" + "trace": { + "description": "Record trace information, based on agent configuration", + "type": "boolean" + } }, - "t": { - "additionalProperties": { - "example": "0", - "pattern": "^[0-9]*$", - "type": "string" + "type": "object" + }, + "V20PresentProofModuleResponse": { + "type": "object" + }, + "V20PresentationSendRequestToProposal": { + "properties": { + "auto_remove": { + "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type": "boolean" }, - "type": "object" + "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" + } }, - "u": { - "additionalProperties": { - "example": "0", - "pattern": "^[0-9]*$", - "type": "string" + "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" }, - "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": { + "cred_tags": { "additionalProperties": { - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "description": "Retrieval tag value", "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" + "cred_value": { + "description": "(JSON-serializable) credential value", + "properties": {}, + "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" + } }, - "to": { - "description": "Latest time of interest in non-revocation interval", - "example": 1640995199, - "format": "int32", - "maximum": 18446744073709551615, - "minimum": 0, - "type": "integer" - } + "type": "object" }, - "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" + "VCRecordList": { + "properties": { + "results": { + "items": { + "$ref": "#/components/schemas/VCRecord" + }, + "type": "array" + } }, - "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" + }, + "VerifiableCredential": { + "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": "object" }, + "type": "array" + }, + "credentialStatus": { + "example": "", "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" } - ], + "credentialSubject": { + "example": "", + "type": "object" + }, + "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": { + "description": "The ID of the credential", + "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", + "type": "object" + }, + "proof": { + "allOf": [ { - "oneof_filter": [ - [{ "uri": "https://www.w3.org/Test1#Test1" }], - [{ "uri": "https://www.w3.org/Test2#Test2" }] - ] + "$ref": "#/components/schemas/LinkedDataProof" } - ] - } - } - }, - "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" }, - "IssueCredentialRequest": { - "properties": { - "credential": { "$ref": "#/definitions/Credential" }, - "options": { "$ref": "#/definitions/LDProofVCOptions" } - }, - "type": "object" - }, - "IssueCredentialResponse": { - "properties": { - "verifiableCredential": { "$ref": "#/definitions/VerifiableCredential" } - }, - "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": { + "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": "object" + }, + "type": { + "description": "The JSON-LD type of the credential", + "example": ["VerifiableCredential", "AlumniCredential"], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "@context", + "credentialSubject", + "issuanceDate", + "issuer", + "proof", + "type" + ], + "type": "object" + }, + "VerifiablePresentation": { + "properties": { + "@context": { + "description": "The JSON-LD context of the presentation", + "example": ["https://www.w3.org/2018/credentials/v1"], + "items": { + "type": "object" + }, + "type": "array" + }, + "holder": { + "description": "The JSON-LD Verifiable Credential Holder. Either string of object with id field.", "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" + "type": "object" }, - "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", + "id": { + "description": "The ID of the presentation", + "example": "http://example.edu/presentations/1872", + "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string" }, - "type": "array", - "x-nullable": true - } - }, - "required": ["pid"], - "type": "object" - }, - "ProvePresentationRequest": { - "properties": { - "options": { "$ref": "#/definitions/LDProofVCOptions" }, - "presentation": { "$ref": "#/definitions/Presentation" } - }, - "type": "object" - }, - "ProvePresentationResponse": { - "properties": { - "verifiablePresentation": { - "$ref": "#/definitions/VerifiablePresentation" - } - }, - "type": "object" - }, - "PublishRevocations": { - "properties": { - "rrid2crid": { - "additionalProperties": { + "proof": { + "allOf": [ + { + "$ref": "#/components/schemas/LinkedDataProof" + } + ], + "description": "The proof of the presentation", + "example": { + "created": "2019-12-11T03:50:55", + "jws": "eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ", + "proofPurpose": "assertionMethod", + "type": "Ed25519Signature2018", + "verificationMethod": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL" + }, + "type": "object" + }, + "type": { + "description": "The JSON-LD type of the presentation", + "example": ["VerifiablePresentation"], "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" + "verifiableCredential": { + "items": { + "properties": {}, + "type": "object" + }, + "type": "array" + } }, - "routingKeys": { - "description": "List of routing keys", - "items": { - "description": "Routing key", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", - "type": "string" + "required": ["@context", "proof", "type"], + "type": "object" + }, + "VerifyCredentialRequest": { + "properties": { + "options": { + "$ref": "#/components/schemas/LDProofVCOptions" }, - "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" + "verifiableCredential": { + "$ref": "#/components/schemas/VerifiableCredential" + } + }, + "type": "object" + }, + "VerifyCredentialResponse": { + "properties": { + "results": { + "$ref": "#/components/schemas/PresentationVerificationResult" + } + }, + "type": "object" + }, + "VerifyPresentationRequest": { + "properties": { + "options": { + "$ref": "#/components/schemas/LDProofVCOptions" }, - "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]" + "verifiablePresentation": { + "$ref": "#/components/schemas/VerifiablePresentation" + } + }, + "type": "object" + }, + "VerifyPresentationResponse": { + "properties": { + "results": { + "$ref": "#/components/schemas/PresentationVerificationResult" + } + }, + "type": "object" + }, + "VerifyRequest": { + "properties": { + "doc": { + "allOf": [ + { + "$ref": "#/components/schemas/SignedDoc" + } ], - "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.]+$", + "description": "Signed document", + "type": "object" + }, + "verkey": { + "description": "Verkey to use for doc verification", + "type": "string" + } + }, + "required": ["doc"], + "type": "object" + }, + "VerifyResponse": { + "properties": { + "error": { + "description": "Error text", "type": "string" }, - "type": "array" - } + "valid": { + "type": "boolean" + } + }, + "required": ["valid"], + "type": "object" }, - "type": "object" - }, - "SchemasInputDescriptorFilter": { - "properties": { - "oneof_filter": { "description": "oneOf", "type": "boolean" }, - "uri_groups": { - "items": { - "items": { "$ref": "#/definitions/SchemaInputDescriptor" }, + "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" }, - "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}$", + "given_id": { + "description": "Given credential id to match", "type": "string" }, - "type": "array" - }, - "routingKeys": { - "description": "List of routing keys", - "items": { - "description": "Routing key", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "issuer_id": { + "description": "Credential issuer identifier to match", "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" + "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": "object" + "type": "array" }, - "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" + "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": "object" + "type": "array" }, - "type": "array" - }, - "meta_data": { - "example": { - "context": { "param1": "param1_value", "param2": "param2_value" }, - "post_process": [{ "topic": "topic_value", "other": "other_value" }] + "subject_ids": { + "description": "Subject identifiers, all of which to match", + "items": { + "description": "Subject identifier", + "type": "string" + }, + "type": "array" }, - "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" + "tag_query": { + "additionalProperties": { + "description": "Tag value", + "type": "string" }, + "description": "Tag filter", "type": "object" }, - "type": "array" + "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" + } }, - "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" + "type": "object" + }, + "WalletList": { + "properties": { + "results": { + "description": "List of wallet records", + "items": { + "$ref": "#/components/schemas/WalletRecord" + }, + "type": "array" + } }, - "cred_tags": { - "additionalProperties": { - "description": "Retrieval tag value", + "type": "object" + }, + "WalletModuleResponse": { + "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" }, - "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", + "key_management_mode": { + "description": "Mode regarding management of wallet key", + "enum": ["managed", "unmanaged"], "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" + "settings": { + "description": "Settings for this wallet.", + "properties": {}, + "type": "object" }, - "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" - }, - "VerifiableCredential": { - "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" - }, - "credentialStatus": { - "example": { - "id": "https://example.com/credentials/status/3#94567", - "statusListCredential": "https://example.com/credentials/status/3", - "statusListIndex": "94567", - "statusPurpose": "revocation", - "type": "BitstringStatusListEntry" - } - }, - "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", - "proof", - "type" - ], - "type": "object" - }, - "VerifiablePresentation": { - "properties": { - "@context": { - "description": "The JSON-LD context of the presentation", - "example": ["https://www.w3.org/2018/credentials/v1"], - "items": {}, - "type": "array" - }, - "holder": { - "description": "The JSON-LD Verifiable Credential Holder. Either string of object with id field.", - "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH" - }, - "id": { - "example": "http://example.edu/presentations/1872", - "pattern": "\\w+:(\\/?\\/?)[^\\s]+", - "type": "string" - }, - "proof": { - "allOf": [{ "$ref": "#/definitions/LinkedDataProof" }], - "description": "The proof of the presentation", - "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 presentation", - "example": ["VerifiablePresentation"], - "items": { "type": "string" }, - "type": "array" - }, - "verifiableCredential": { - "items": { "type": "object" }, - "type": "array" - } - }, - "required": ["@context", "proof", "type"], - "type": "object" - }, - "VerifyCredentialRequest": { - "properties": { - "options": { "$ref": "#/definitions/LDProofVCOptions" }, - "verifiableCredential": { "$ref": "#/definitions/VerifiableCredential" } - }, - "type": "object" - }, - "VerifyCredentialResponse": { - "properties": { - "results": { "$ref": "#/definitions/PresentationVerificationResult" } - }, - "type": "object" - }, - "VerifyPresentationRequest": { - "properties": { - "options": { "$ref": "#/definitions/LDProofVCOptions" }, - "verifiablePresentation": { - "$ref": "#/definitions/VerifiablePresentation" - } - }, - "type": "object" - }, - "VerifyPresentationResponse": { - "properties": { - "results": { "$ref": "#/definitions/PresentationVerificationResult" } - }, - "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]*)?(/[^?&#]+)?$", + "state": { + "description": "Current record state", + "example": "active", "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", + "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": "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]*)?(/[^?&#]+)?$", + "wallet_id": { + "description": "Wallet record ID", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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", + "required": ["key_management_mode", "wallet_id"], + "type": "object" + }, + "WriteLedger": { + "properties": { + "ledger_id": { "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": "vc-api", - "description": "Endpoints for managing w3c credentials and presentations", - "externalDocs": { - "description": "Specification", - "url": "https://w3c-ccg.github.io/vc-api/" + "type": "object" + }, + "IndyPrimaryProof_eq_proof": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyEQProof" + } + ], + "description": "Indy equality proof", + "nullable": true, + "type": "object" + }, + "IndyProofProofProofsProof_non_revoc_proof": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyNonRevocProof" + } + ], + "description": "Indy non-revocation proof", + "nullable": true, + "type": "object" + }, + "IndyProofReqAttrSpec_non_revoked": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyProofReqAttrSpecNonRevoked" + } + ], + "nullable": true, + "type": "object" + }, + "IndyProofReqPredSpec_non_revoked": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyProofReqPredSpecNonRevoked" + } + ], + "nullable": true, + "type": "object" + }, + "IndyProofRequest_non_revoked": { + "allOf": [ + { + "$ref": "#/components/schemas/IndyProofRequestNonRevoked" + } + ], + "nullable": true, + "type": "object" } }, - { - "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" + "securitySchemes": { + "AuthorizationHeader": { + "description": "Bearer token. Be sure to prepend token with 'Bearer '", + "in": "header", + "name": "Authorization", + "type": "apiKey" } } - ] + }, + "x-original-swagger-version": "2.0" }