From ded43efccb725f1df2b605f2ade55d4cbc4f55ec Mon Sep 17 00:00:00 2001 From: Moriarty Date: Sun, 4 Sep 2022 14:18:38 +0200 Subject: [PATCH 1/5] chore: update to aca-py version 0.7.4 to create new release Signed-off-by: Moriarty --- README.md | 4 +- generator/README.md | 6 +- generator/data/openapi.yml | 257 +++++++++++++++++++++++--- generator/data/swagger.json | 2 +- generator/scripts/retrieve-openapi.sh | 2 +- setup.py | 2 +- 6 files changed, 242 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 09e077c66..2dbc0790f 100644 --- a/README.md +++ b/README.md @@ -43,14 +43,14 @@ Each Cloud Controller version maps to a specific ACA-Py version, which is outlin | Aries Cloud Controller Version | Aries Cloud Agent Python Version | | ------------------------------ | -------------------------------- | -| 0.5.1-0.5.2 | 0.7.3 | +| 0.5.3 | 0.7.4 | ## Features Aries Cloud Controller Python is a fully featured client for interacting with ACA-Py. - Fully Typed wrapper around Aries Cloud Agent Python -- Supports latest ACA-Py version (0.7.3) +- Supports latest ACA-Py version (0.7.4) - Client is auto generated based on OpenAPI definitions, allowing us to keep up to date with new releases. - Supports multi-tenant APIs and authentication - Async API diff --git a/generator/README.md b/generator/README.md index 5b488d860..37a2696df 100644 --- a/generator/README.md +++ b/generator/README.md @@ -21,15 +21,15 @@ cd generator ## Updating the OpenAPI -Updating the OpenAPI is only needed when a new version of ACA-Py is released. The process of updating the OpenAPI is mostly automated, you only need to run a few scripts. First determine the version you want for OpenAPI spec from the BCGov agent docker images (https://hub.docker.com/r/bcgovimages/aries-cloudagent/). Currently the default for the `retrieve-openapi.sh` script is "py36-1.16-1_0.7.0". +Updating the OpenAPI is only needed when a new version of ACA-Py is released. The process of updating the OpenAPI is mostly automated, you only need to run a few scripts. First determine the version you want for OpenAPI spec from the BCGov agent docker images (https://hub.docker.com/r/bcgovimages/aries-cloudagent/). Currently the default for the `retrieve-openapi.sh` script is "py36-1.16-1_0.7.4". After that you can run the following commands to update the `data/openapi.yml` file. This file should be committed. ```sh cd aries-cloudcontroller-python/generator -# Retrieve the open api file, change py36-1.16-1_0.7.0 if you want another version -./scripts/retrieve-openapi.sh py36-1.16-1_0.7.0 +# Retrieve the open api file, change py36-1.16-1_0.7.4 if you want another version +./scripts/retrieve-openapi.sh py36-1.16-1_0.7.4 # transform to OpenAPI V3 ./scripts/convert-to-openapi3-local.sh diff --git a/generator/data/openapi.yml b/generator/data/openapi.yml index 7fea5298e..12ed983aa 100644 --- a/generator/data/openapi.yml +++ b/generator/data/openapi.yml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Aries Cloud Agent - version: v0.7.3 + version: v0.7.4 servers: - url: / security: @@ -255,6 +255,12 @@ paths: schema: pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$ type: string + - name: invitation_msg_id + in: query + description: Identifier of the associated Invitation Mesage + schema: + type: string + format: uuid - name: my_did in: query description: My DID @@ -267,21 +273,27 @@ paths: schema: type: string enum: - - invitation - - init - - active - - error + - request - start + - error + - active - abandoned + - init + - invitation - response - completed - - request - name: their_did in: query description: Their DID schema: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string + - name: their_public_did + in: query + description: Their Public DID + schema: + pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ + type: string - name: their_role in: query description: Their role in the connection protocol @@ -1329,6 +1341,7 @@ paths: - credential-received - done - credential-revoked + - abandoned - name: thread_id in: query description: Thread identifier @@ -1681,6 +1694,7 @@ paths: - credential_received - credential_acked - credential_revoked + - abandoned - name: thread_id in: query description: Thread identifier @@ -2090,6 +2104,16 @@ paths: description: Alias schema: type: string + - name: conn_id + in: query + description: Connection identifier + schema: + type: string + - name: create_transaction_for_endorser + in: query + description: Create Transaction For Endorser's signature + schema: + type: boolean - name: role in: query description: Role @@ -2107,7 +2131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RegisterLedgerNymResponse' + $ref: '#/components/schemas/TxnOrRegisterLedgerNymResponse' operationId: register_nym /ledger/rotate-public-did-keypair: patch: @@ -2921,7 +2945,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminAPIMessageTracing' + $ref: '#/components/schemas/V20PresentationSendRequestToProposal' required: false responses: 200: @@ -3047,6 +3071,7 @@ paths: - presentation_received - verified - presentation_acked + - abandoned - name: thread_id in: query description: Thread identifier @@ -3221,7 +3246,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminAPIMessageTracing' + $ref: '#/components/schemas/V10PresentationSendRequestToProposal' required: false responses: 200: @@ -3572,6 +3597,32 @@ paths: schema: $ref: '#/components/schemas/RevRegResult' operationId: publish_rev_reg_entry + /revocation/registry/{rev_reg_id}/fix-revocation-entry-state: + put: + tags: + - 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 + 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 + schema: + type: boolean + responses: + 200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/RevRegWalletUpdatedResult' /revocation/registry/{rev_reg_id}/issued: get: tags: @@ -3593,6 +3644,46 @@ paths: schema: $ref: '#/components/schemas/RevRegIssuedResult' operationId: get_registry_issued_credentials_count + /revocation/registry/{rev_reg_id}/issued/details: + get: + tags: + - revocation + summary: Get details of credentials issued against revocation registry + parameters: + - name: rev_reg_id + in: path + description: Revocation Registry identifier + 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: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CredRevRecordDetailsResult' + /revocation/registry/{rev_reg_id}/issued/indy_recs: + get: + tags: + - revocation + summary: Get details of revoked credentials from ledger + parameters: + - name: rev_reg_id + in: path + description: Revocation Registry identifier + 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: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CredRevIndyRecordsResult' /revocation/registry/{rev_reg_id}/set-state: patch: tags: @@ -4055,6 +4146,11 @@ paths: required: true schema: type: string + - name: endorser_did + in: query + description: Endorser DID + schema: + type: string responses: 200: description: '' @@ -4221,6 +4317,16 @@ paths: schema: pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$ type: string + - name: conn_id + in: query + description: Connection identifier + schema: + type: string + - name: create_transaction_for_endorser + in: query + description: Create Transaction For Endorser's signature + schema: + type: boolean responses: 200: description: '' @@ -4255,6 +4361,17 @@ paths: tags: - wallet summary: Update endpoint in wallet and on ledger if posted to it + parameters: + - name: conn_id + in: query + description: Connection identifier + schema: + type: string + - name: create_transaction_for_endorser + in: query + description: Create Transaction For Endorser's signature + schema: + type: boolean requestBody: content: application/json: @@ -4296,12 +4413,6 @@ components: - $ref: '#/components/schemas/Menu' ActionMenuModulesResult: type: object - AdminAPIMessageTracing: - type: object - properties: - trace: - type: boolean - description: Record trace information, based on agent configuration AdminConfig: type: object properties: @@ -4902,6 +5013,14 @@ components: type: string description: Master key used for key derivation. example: MySecretKey123 + wallet_key_derivation: + type: string + description: Key derivation + example: RAW + enum: + - ARGON2I_MOD + - ARGON2I_INT + - RAW wallet_name: type: string description: Wallet name @@ -5070,6 +5189,20 @@ components: type: array items: $ref: '#/components/schemas/IndyCredInfo' + CredRevIndyRecordsResult: + type: object + properties: + rev_reg_delta: + type: object + properties: {} + description: Indy revocation registry delta + CredRevRecordDetailsResult: + type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/IssuerCredRevRecord' CredRevRecordResult: type: object properties: @@ -5546,6 +5679,8 @@ components: type: array items: $ref: '#/components/schemas/InputDescriptors' + options: + $ref: '#/components/schemas/DIFOptions' DIFProofRequest: required: - presentation_definition @@ -6613,7 +6748,7 @@ components: description: Accepts a list of schema or a dict containing filters like oneof_filter. example: - oneOf: + oneof_filter: - - uri: https://www.w3.org/Test1#Test1 - uri: https://www.w3.org/Test2#Test2 - oneof_filter: @@ -6729,6 +6864,10 @@ components: type: string description: Invitation message URL example: https://example.com/endpoint?c_i=eyJAdHlwZSI6ICIuLi4iLCAiLi4uIjogIi4uLiJ9XX0= + oob_id: + type: string + description: Out of band record identifier + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 state: type: string description: Out of band message exchange state @@ -7593,13 +7732,6 @@ components: type: string description: Service endpoint at which to reach this agent example: http://192.168.56.101:8020 - RegisterLedgerNymResponse: - type: object - properties: - success: - type: boolean - description: Success of nym registration operation - example: true RemoveWalletRequest: type: object properties: @@ -7663,6 +7795,21 @@ components: description: Public URI to the tails file format: url example: http://192.168.56.133:6543/revocation/registry/WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0/tails-file + RevRegWalletUpdatedResult: + 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: @@ -7700,6 +7847,13 @@ components: 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, @@ -8143,6 +8297,18 @@ components: description: Revocation registry revocations transaction to endorse allOf: - $ref: '#/components/schemas/TransactionRecord' + TxnOrRegisterLedgerNymResponse: + type: object + properties: + success: + type: boolean + description: Success of nym registration operation + example: true + txn: + type: object + description: DID transaction to endorse + allOf: + - $ref: '#/components/schemas/TransactionRecord' TxnOrRevRegResult: type: object additionalProperties: false @@ -8636,6 +8802,10 @@ components: - proof_request type: object properties: + auto_verify: + type: boolean + description: Verifier choice to auto-verify proof presentation + example: false comment: type: string nullable: true @@ -8652,6 +8822,9 @@ components: type: boolean description: Prover choice to auto-present proof as verifier requests example: false + auto_verify: + type: boolean + description: Verifier choice to auto-verify proof presentation connection_id: type: string description: Connection identifier @@ -8772,6 +8945,10 @@ components: - proof_request type: object properties: + auto_verify: + type: boolean + description: Verifier choice to auto-verify proof presentation + example: false comment: type: string nullable: true @@ -8786,6 +8963,17 @@ components: type: boolean description: Whether to trace event (default false) example: false + V10PresentationSendRequestToProposal: + type: object + properties: + auto_verify: + type: boolean + description: Verifier choice to auto-verify proof presentation + example: false + trace: + type: boolean + description: Whether to trace event (default false) + example: false V20CredAttrSpec: required: - name @@ -8944,6 +9132,7 @@ components: - credential-received - done - credential-revoked + - abandoned thread_id: type: string description: Thread identifier @@ -9514,6 +9703,10 @@ components: - presentation_request type: object properties: + auto_verify: + type: boolean + description: Verifier choice to auto-verify proof presentation + example: false comment: type: string nullable: true @@ -9530,6 +9723,9 @@ components: type: boolean description: Prover choice to auto-present proof as verifier requests example: false + auto_verify: + type: boolean + description: Verifier choice to auto-verify proof presentation by_format: type: object description: Attachment content by format for proposal, request, and presentation @@ -9767,6 +9963,10 @@ components: - presentation_request type: object properties: + auto_verify: + type: boolean + description: Verifier choice to auto-verify proof presentation + example: false comment: type: string nullable: true @@ -9800,6 +10000,17 @@ components: description: Record trace information, based on agent configuration V20PresentProofModuleResponse: type: object + V20PresentationSendRequestToProposal: + type: object + properties: + auto_verify: + type: boolean + description: Verifier choice to auto-verify proof presentation + example: false + trace: + type: boolean + description: Whether to trace event (default false) + example: false VCRecord: type: object properties: diff --git a/generator/data/swagger.json b/generator/data/swagger.json index f5ec7bce2..f8fe2e6a0 100644 --- a/generator/data/swagger.json +++ b/generator/data/swagger.json @@ -1 +1 @@ -{"paths": {"/action-menu/{conn_id}/close": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Close the active menu associated with a connection", "produces": ["application/json"]}}, "/action-menu/{conn_id}/fetch": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuFetchResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Fetch the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/perform": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PerformRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Perform an action associated with the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Request the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/send-menu": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SendMenu"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Send an action menu to a connection", "produces": ["application/json"]}}, "/connections": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionList"}, "description": ""}}, "parameters": [{"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "connection_protocol", "required": false, "type": "string", "enum": ["connections/1.0", "didexchange/1.0"], "description": "Connection protocol used", "example": "connections/1.0"}, {"in": "query", "name": "invitation_key", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "invitation key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, {"in": "query", "name": "my_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "My DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["invitation", "init", "active", "error", "start", "abandoned", "response", "completed", "request"], "description": "Connection state"}, {"in": "query", "name": "their_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Their DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "their_role", "required": false, "type": "string", "enum": ["invitee", "requester", "inviter", "responder"], "description": "Their role in the connection protocol", "example": "invitee"}], "tags": ["connection"], "summary": "Query agent-to-agent connections", "produces": ["application/json"]}}, "/connections/create-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/InvitationResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateInvitationRequest"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "multi_use", "required": false, "type": "boolean", "description": "Create invitation for multiple use (default false)"}, {"in": "query", "name": "public", "required": false, "type": "boolean", "description": "Create invitation from public DID (default false)"}], "tags": ["connection"], "summary": "Create a new connection invitation", "produces": ["application/json"]}}, "/connections/create-static": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionStaticResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ConnectionStaticRequest"}}], "tags": ["connection"], "summary": "Create a new static connection", "produces": ["application/json"]}}, "/connections/receive-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ReceiveInvitationRequest"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Receive a new connection invitation", "produces": ["application/json"]}}, "/connections/{conn_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Fetch a single connection record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Remove an existing connection record", "produces": ["application/json"]}}, "/connections/{conn_id}/accept-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "query", "name": "my_label", "required": false, "type": "string", "description": "Label for connection", "example": "Broker"}], "tags": ["connection"], "summary": "Accept a stored connection invitation", "produces": ["application/json"]}}, "/connections/{conn_id}/accept-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}], "tags": ["connection"], "summary": "Accept a stored connection request", "produces": ["application/json"]}}, "/connections/{conn_id}/endpoints": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/EndpointsResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Fetch connection remote endpoint", "produces": ["application/json"]}}, "/connections/{conn_id}/establish-inbound/{ref_id}": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "path", "name": "ref_id", "required": true, "type": "string", "description": "Inbound connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Assign another connection as the inbound connection", "produces": ["application/json"]}}, "/connections/{conn_id}/metadata": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionMetadata"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "key", "required": false, "type": "string", "description": "Key to retrieve."}], "tags": ["connection"], "summary": "Fetch connection metadata", "produces": ["application/json"]}, "post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionMetadata"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ConnectionMetadataSetRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Set connection metadata", "produces": ["application/json"]}}, "/connections/{conn_id}/send-message": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/BasicMessageModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SendMessage"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["basicmessage"], "summary": "Send a basic message to a connection", "produces": ["application/json"]}}, "/connections/{conn_id}/send-ping": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/PingRequestResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PingRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["trustping"], "summary": "Send a trust ping to a connection", "produces": ["application/json"]}}, "/connections/{conn_id}/start-introduction": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/IntroModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "target_connection_id", "required": true, "type": "string", "description": "Target connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "message", "required": false, "type": "string", "description": "Message", "example": "Allow me to introduce ..."}], "tags": ["introduction"], "summary": "Start an introduction between two connections", "produces": ["application/json"]}}, "/credential-definitions": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrCredentialDefinitionSendResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CredentialDefinitionSendRequest"}}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["credential-definition"], "summary": "Sends a credential definition to the ledger", "produces": ["application/json"]}}, "/credential-definitions/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionsCreatedResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_def_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition id", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, {"in": "query", "name": "issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "schema_id", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, {"in": "query", "name": "schema_issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "schema_name", "required": false, "type": "string", "description": "Schema name", "example": "membership"}, {"in": "query", "name": "schema_version", "required": false, "type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}], "tags": ["credential-definition"], "summary": "Search for matching credential definitions that agent originated", "produces": ["application/json"]}}, "/credential-definitions/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["credential-definition"], "summary": "Gets a credential definition from the ledger", "produces": ["application/json"]}}, "/credential-definitions/{cred_def_id}/write_record": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["credential-definition"], "summary": "Writes a credential definition non-secret record to the wallet", "produces": ["application/json"]}}, "/credential/mime-types/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AttributeMimeTypesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Get attribute MIME types from wallet", "produces": ["application/json"]}}, "/credential/revoked/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevokedResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "from", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Earliest epoch of revocation status interval of interest", "example": "0"}, {"in": "query", "name": "to", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Latest epoch of revocation status interval of interest", "example": "0"}], "tags": ["credentials"], "summary": "Query credential revocation status by id", "produces": ["application/json"]}}, "/credential/w3c/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/VCRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Fetch W3C credential from wallet by id", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/HolderModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Remove W3C credential from wallet by id", "produces": ["application/json"]}}, "/credential/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/IndyCredInfo"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Fetch credential from wallet by id", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/HolderModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Remove credential from wallet by id", "produces": ["application/json"]}}, "/credentials": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredInfoList"}, "description": ""}}, "parameters": [{"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}, {"in": "query", "name": "wql", "required": false, "type": "string", "pattern": "^{.*}$", "description": "(JSON) WQL query", "example": "{\"attr::name::value\": \"Alex\"}"}], "tags": ["credentials"], "summary": "Fetch credentials from wallet", "produces": ["application/json"]}}, "/credentials/w3c": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/VCRecordList"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/W3CCredentialsListRequest"}}, {"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}, {"in": "query", "name": "wql", "required": false, "type": "string", "pattern": "^{.*}$", "description": "(JSON) WQL query", "example": "{\"attr::name::value\": \"Alex\"}"}], "tags": ["credentials"], "summary": "Fetch W3C credentials from wallet", "produces": ["application/json"]}}, "/didexchange/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "query", "name": "their_public_did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "Qualified public DID to which to request connection", "example": "did:peer:WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias for connection", "example": "Barry"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "query", "name": "my_label", "required": false, "type": "string", "description": "Label for connection request", "example": "Broker"}, {"in": "query", "name": "use_public_did", "required": false, "type": "boolean", "description": "Use public DID for this connection"}], "tags": ["did-exchange"], "summary": "Create and send a request against public DID's implicit invitation", "produces": ["application/json"]}}, "/didexchange/receive-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDXRequest"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias for connection", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}], "tags": ["did-exchange"], "summary": "Receive request against public DID's implicit invitation", "produces": ["application/json"]}}, "/didexchange/{conn_id}/accept-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "query", "name": "my_label", "required": false, "type": "string", "description": "Label for connection request", "example": "Broker"}], "tags": ["did-exchange"], "summary": "Accept a stored connection invitation", "produces": ["application/json"]}}, "/didexchange/{conn_id}/accept-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}], "tags": ["did-exchange"], "summary": "Accept a stored connection request", "produces": ["application/json"]}}, "/discover-features-2.0/queries": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20DiscoveryExchangeResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier, if none specified, then the query will provide features for this agent.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "query_goal_code", "required": false, "type": "string", "description": "Goal-code feature-type query", "example": "*"}, {"in": "query", "name": "query_protocol", "required": false, "type": "string", "description": "Protocol feature-type query", "example": "*"}], "tags": ["discover-features v2.0"], "summary": "Query supported features", "produces": ["application/json"]}}, "/discover-features-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20DiscoveryExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["discover-features v2.0"], "summary": "Discover Features v2.0 records", "produces": ["application/json"]}}, "/discover-features/query": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10DiscoveryExchangeResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "comment", "required": false, "type": "string", "description": "Comment", "example": "test"}, {"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier, if none specified, then the query will provide features for this agent.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "query", "required": false, "type": "string", "description": "Protocol feature query", "example": "*"}], "tags": ["discover-features"], "summary": "Query supported features", "produces": ["application/json"]}}, "/discover-features/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10DiscoveryExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["discover-features"], "summary": "Discover Features records", "produces": ["application/json"]}}, "/issue-credential-2.0/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20IssueCredSchemaCore"}}], "tags": ["issue-credential v2.0"], "summary": "Create credential from attribute values", "produces": ["application/json"]}}, "/issue-credential-2.0/create-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredOfferConnFreeRequest"}}], "tags": ["issue-credential v2.0"], "summary": "Create a credential offer, independent of any proposal or connection", "produces": ["application/json"]}}, "/issue-credential-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["issuer", "holder"], "description": "Role assigned in credential exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal-sent", "proposal-received", "offer-sent", "offer-received", "request-sent", "request-received", "credential-issued", "credential-received", "done", "credential-revoked"], "description": "Credential exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Fetch all credential exchange records", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Fetch a single credential exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Remove an existing credential exchange record", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/issue": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredIssueRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredIssueProblemReportRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send a problem report for credential exchange", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredBoundOfferRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential offer in reference to a proposal with preview", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredRequestRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential request", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/store": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredStoreRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Store a received credential", "produces": ["application/json"]}}, "/issue-credential-2.0/send": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredExFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential, automating entire flow", "produces": ["application/json"]}}, "/issue-credential-2.0/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredOfferRequest"}}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential offer, independent of any proposal", "produces": ["application/json"]}}, "/issue-credential-2.0/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredExFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential proposal", "produces": ["application/json"]}}, "/issue-credential-2.0/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredRequestFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request", "produces": ["application/json"]}}, "/issue-credential/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialCreate"}}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential, automating entire flow", "produces": ["application/json"]}}, "/issue-credential/create-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialConnFreeOfferRequest"}}], "tags": ["issue-credential v1.0"], "summary": "Create a credential offer, independent of any proposal or connection", "produces": ["application/json"]}}, "/issue-credential/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["issuer", "holder"], "description": "Role assigned in credential exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal_sent", "proposal_received", "offer_sent", "offer_received", "request_sent", "request_received", "credential_issued", "credential_received", "credential_acked", "credential_revoked"], "description": "Credential exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Fetch all credential exchange records", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Fetch a single credential exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Remove an existing credential exchange record", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/issue": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialIssueRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProblemReportRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send a problem report for credential exchange", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialBoundOfferRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential offer in reference to a proposal with preview", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send issuer a credential request", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/store": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialStoreRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Store a received credential", "produces": ["application/json"]}}, "/issue-credential/send": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProposalRequestMand"}}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential, automating entire flow", "produces": ["application/json"]}}, "/issue-credential/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialFreeOfferRequest"}}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential offer, independent of any proposal", "produces": ["application/json"]}}, "/issue-credential/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProposalRequestOpt"}}], "tags": ["issue-credential v1.0"], "summary": "Send issuer a credential proposal", "produces": ["application/json"]}}, "/jsonld/sign": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SignResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SignRequest"}}], "tags": ["jsonld"], "summary": "Sign a JSON-LD structure and return it", "produces": ["application/json"]}}, "/jsonld/verify": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/VerifyResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/VerifyRequest"}}], "tags": ["jsonld"], "summary": "Verify a JSON-LD structure.", "produces": ["application/json"]}}, "/ledger/did-endpoint": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetDIDEndpointResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "endpoint_type", "required": false, "type": "string", "enum": ["Endpoint", "Profile", "LinkedDomains"], "description": "Endpoint type of interest (default 'Endpoint')", "example": "Endpoint"}], "tags": ["ledger"], "summary": "Get the endpoint for a DID from the ledger.", "produces": ["application/json"]}}, "/ledger/did-verkey": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetDIDVerkeyResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["ledger"], "summary": "Get the verkey for a DID from the ledger.", "produces": ["application/json"]}}, "/ledger/get-nym-role": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetNymRoleResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["ledger"], "summary": "Get the role from the NYM registration of a public DID.", "produces": ["application/json"]}}, "/ledger/multiple/config": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerConfigList"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the multiple ledger configuration currently in use", "produces": ["application/json"]}}, "/ledger/multiple/get-write-ledger": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WriteLedgerRequest"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the current write ledger", "produces": ["application/json"]}}, "/ledger/register-nym": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RegisterLedgerNymResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID to register", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "verkey", "required": true, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "reset"], "description": "Role"}], "tags": ["ledger"], "summary": "Send a NYM registration to the ledger.", "produces": ["application/json"]}}, "/ledger/rotate-public-did-keypair": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerModulesResult"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Rotate key pair for public DID.", "produces": ["application/json"]}}, "/ledger/taa": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TAAResult"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the current transaction author agreement, if any", "produces": ["application/json"]}}, "/ledger/taa/accept": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/TAAAccept"}}], "tags": ["ledger"], "summary": "Accept the transaction author agreement", "produces": ["application/json"]}}, "/mediation/default-mediator": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": null}}, "parameters": [], "tags": ["mediation"], "summary": "Get default mediator", "produces": ["application/json"]}, "delete": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": null}}, "parameters": [], "tags": ["mediation"], "summary": "Clear default mediator", "produces": ["application/json"]}}, "/mediation/keylists": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/Keylist"}, "description": null}}, "parameters": [{"in": "query", "name": "conn_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier (optional)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "default": "server", "enum": ["client", "server"], "description": "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent"}], "tags": ["mediation"], "summary": "Retrieve keylists by connection or role", "produces": ["application/json"]}}, "/mediation/keylists/{mediation_id}/send-keylist-query": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/KeylistQuery"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/KeylistQueryFilterRequest"}}, {"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "paginate_limit", "required": false, "type": "integer", "format": "int32", "default": -1, "description": "limit number of results"}, {"in": "query", "name": "paginate_offset", "required": false, "type": "integer", "format": "int32", "default": 0, "description": "offset to use in pagination"}], "tags": ["mediation"], "summary": "Send keylist query to mediator", "produces": ["application/json"]}}, "/mediation/keylists/{mediation_id}/send-keylist-update": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/KeylistUpdate"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/KeylistUpdateRequest"}}, {"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Send keylist update to mediator", "produces": ["application/json"]}}, "/mediation/request/{conn_id}": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/MediationCreateRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Request mediation from connection", "produces": ["application/json"]}}, "/mediation/requests": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationList"}, "description": null}}, "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": "mediator_terms", "required": false, "collectionFormat": "multi", "type": "array", "description": "List of mediator rules for recipient", "items": {"type": "string", "description": "Indicate terms to which the mediator requires the recipient to agree"}}, {"in": "query", "name": "recipient_terms", "required": false, "collectionFormat": "multi", "type": "array", "description": "List of recipient rules for mediation", "items": {"type": "string", "description": "Indicate terms to which the recipient requires the mediator to agree"}}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["request", "granted", "denied"], "description": "Mediation state (optional)", "example": "granted"}], "tags": ["mediation"], "summary": "Query mediation requests, returns list of all mediation records", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": null}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Retrieve mediation request record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": null}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Delete mediation request by ID", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}/deny": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationDeny"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/AdminMediationDeny"}}, {"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Deny a stored mediation request", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}/grant": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationGrant"}, "description": null}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Grant received mediation", "produces": ["application/json"]}}, "/mediation/{mediation_id}/default-mediator": {"put": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": null}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Set default mediator", "produces": ["application/json"]}}, "/multitenancy/wallet": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CreateWalletResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateWalletRequest"}}], "tags": ["multitenancy"], "summary": "Create a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "wallet_id", "required": true, "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["multitenancy"], "summary": "Get a single subwallet", "produces": ["application/json"]}, "put": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/UpdateWalletRequest"}}, {"in": "path", "name": "wallet_id", "required": true, "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["multitenancy"], "summary": "Update a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}/remove": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/MultitenantModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RemoveWalletRequest"}}, {"in": "path", "name": "wallet_id", "required": true, "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["multitenancy"], "summary": "Remove a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}/token": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CreateWalletTokenResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateWalletTokenRequest"}}, {"in": "path", "name": "wallet_id", "required": true, "type": "string"}], "tags": ["multitenancy"], "summary": "Get auth token for a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallets": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletList"}, "description": ""}}, "parameters": [{"in": "query", "name": "wallet_name", "required": false, "type": "string", "description": "Wallet name", "example": "MyNewWallet"}], "tags": ["multitenancy"], "summary": "Query subwallets", "produces": ["application/json"]}}, "/out-of-band/create-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/InvitationRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/InvitationCreateRequest"}}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "multi_use", "required": false, "type": "boolean", "description": "Create invitation for multiple use (default false)"}], "tags": ["out-of-band"], "summary": "Create a new connection invitation", "produces": ["application/json"]}}, "/out-of-band/receive-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/InvitationMessage"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias for connection", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "use_existing_connection", "required": false, "type": "boolean", "description": "Use an existing connection, if possible"}], "tags": ["out-of-band"], "summary": "Receive a new connection invitation", "produces": ["application/json"]}}, "/plugins": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminModules"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the list of loaded plugins", "produces": ["application/json"]}}, "/present-proof-2.0/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresCreateRequestRequest"}}], "tags": ["present-proof v2.0"], "summary": "Creates a presentation request not bound to any proposal or connection", "produces": ["application/json"]}}, "/present-proof-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecordList"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["prover", "verifier"], "description": "Role assigned in presentation exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal-sent", "proposal-received", "request-sent", "request-received", "presentation-sent", "presentation-received", "done", "abandoned"], "description": "Presentation exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Fetch all present-proof exchange records", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Fetch a single presentation exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Remove an existing presentation exchange record", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/credentials": {"get": {"responses": {"200": {"schema": {"type": "array", "items": {"$ref": "#/definitions/IndyCredPrecis"}}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "extra_query", "required": false, "type": "string", "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", "description": "(JSON) object mapping referents to extra WQL queries", "example": "{\"0_drink_uuid\": {\"attr::drink::value\": \"martini\"}}"}, {"in": "query", "name": "referent", "required": false, "type": "string", "description": "Proof request referents of interest, comma-separated", "example": "1_name_uuid,2_score_uuid"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}], "tags": ["present-proof v2.0"], "summary": "Fetch credentials from wallet for presentation request", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresProblemReportRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Send a problem report for presentation exchange", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/send-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresSpecByFormatRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Sends a proof presentation", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/AdminAPIMessageTracing"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Sends a presentation request in reference to a proposal", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/verify-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Verify a received presentation", "produces": ["application/json"]}}, "/present-proof-2.0/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresProposalRequest"}}], "tags": ["present-proof v2.0"], "summary": "Sends a presentation proposal", "produces": ["application/json"]}}, "/present-proof-2.0/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresSendRequestRequest"}}], "tags": ["present-proof v2.0"], "summary": "Sends a free presentation request not bound to any proposal", "produces": ["application/json"]}}, "/present-proof/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationCreateRequestRequest"}}], "tags": ["present-proof v1.0"], "summary": "Creates a presentation request not bound to any proposal or connection", "produces": ["application/json"]}}, "/present-proof/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchangeList"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["prover", "verifier"], "description": "Role assigned in presentation exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal_sent", "proposal_received", "request_sent", "request_received", "presentation_sent", "presentation_received", "verified", "presentation_acked"], "description": "Presentation exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Fetch all present-proof exchange records", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Fetch a single presentation exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Remove an existing presentation exchange record", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/credentials": {"get": {"responses": {"200": {"schema": {"type": "array", "items": {"$ref": "#/definitions/IndyCredPrecis"}}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "extra_query", "required": false, "type": "string", "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", "description": "(JSON) object mapping referents to extra WQL queries", "example": "{\"0_drink_uuid\": {\"attr::drink::value\": \"martini\"}}"}, {"in": "query", "name": "referent", "required": false, "type": "string", "description": "Proof request referents of interest, comma-separated", "example": "1_name_uuid,2_score_uuid"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}], "tags": ["present-proof v1.0"], "summary": "Fetch credentials for a presentation request from wallet", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationProblemReportRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Send a problem report for presentation exchange", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/send-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/IndyPresSpec"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Sends a proof presentation", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/AdminAPIMessageTracing"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Sends a presentation request in reference to a proposal", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/verify-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Verify a received presentation", "produces": ["application/json"]}}, "/present-proof/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationProposalRequest"}}], "tags": ["present-proof v1.0"], "summary": "Sends a presentation proposal", "produces": ["application/json"]}}, "/present-proof/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationSendRequestRequest"}}], "tags": ["present-proof v1.0"], "summary": "Sends a free presentation request not bound to any proposal", "produces": ["application/json"]}}, "/resolver/resolve/{did}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ResolutionResult"}, "description": null}}, "parameters": [{"in": "path", "name": "did", "required": true, "type": "string", "pattern": "^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$", "description": "DID", "example": "did:ted:WgWxqztrNooG92RXvxSTWv"}], "tags": ["resolver"], "summary": "Retrieve doc for requested did", "produces": ["application/json"]}}, "/revocation/active-registry/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["revocation"], "summary": "Get current active revocation registry by credential definition id", "produces": ["application/json"]}}, "/revocation/clear-pending-revocations": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/PublishRevocations"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ClearPendingRevocationsRequest"}}], "tags": ["revocation"], "summary": "Clear pending revocations", "produces": ["application/json"]}}, "/revocation/create-registry": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevRegCreateRequest"}}], "tags": ["revocation"], "summary": "Creates a new revocation registry", "produces": ["application/json"]}}, "/revocation/credential-record": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevRecordResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_ex_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "cred_rev_id", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Credential revocation identifier", "example": "12345"}, {"in": "query", "name": "rev_reg_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get credential revocation status", "produces": ["application/json"]}}, "/revocation/publish-revocations": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrPublishRevocationsResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PublishRevocations"}}], "tags": ["revocation"], "summary": "Publish pending revocations to ledger", "produces": ["application/json"]}}, "/revocation/registries/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegsCreated"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_def_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["init", "generated", "posted", "active", "full"], "description": "Revocation registry state"}], "tags": ["revocation"], "summary": "Search for matching revocation registries that current agent created", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get revocation registry by revocation registry id", "produces": ["application/json"]}, "patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevRegUpdateTailsFileUri"}}, {"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Update revocation registry with new public URI to its tails file", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/definition": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrRevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["revocation"], "summary": "Send revocation registry definition to ledger", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/entry": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["revocation"], "summary": "Send revocation registry entry to ledger", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/issued": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegIssuedResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get number of credentials issued against revocation registry", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/set-state": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, {"in": "query", "name": "state", "required": true, "type": "string", "enum": ["init", "generated", "posted", "active", "full"], "description": "Revocation registry state to set"}], "tags": ["revocation"], "summary": "Set revocation registry state manually", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/tails-file": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Upload local tails file to server", "produces": ["application/json"]}, "get": {"responses": {"200": {"schema": {"type": "string", "format": "binary"}, "description": "tails file"}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Download tails file", "produces": ["application/octet-stream"]}}, "/revocation/revoke": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevokeRequest"}}], "tags": ["revocation"], "summary": "Revoke an issued credential", "produces": ["application/json"]}}, "/schemas": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrSchemaSendResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SchemaSendRequest"}}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["schema"], "summary": "Sends a schema to the ledger", "produces": ["application/json"]}}, "/schemas/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemasCreatedResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "schema_id", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, {"in": "query", "name": "schema_issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "schema_name", "required": false, "type": "string", "description": "Schema name", "example": "membership"}, {"in": "query", "name": "schema_version", "required": false, "type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}], "tags": ["schema"], "summary": "Search for matching schema that agent originated", "produces": ["application/json"]}}, "/schemas/{schema_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemaGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "schema_id", "required": true, "type": "string", "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}], "tags": ["schema"], "summary": "Gets a schema from the ledger", "produces": ["application/json"]}}, "/schemas/{schema_id}/write_record": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemaGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "schema_id", "required": true, "type": "string", "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}], "tags": ["schema"], "summary": "Writes a schema non-secret record to the wallet", "produces": ["application/json"]}}, "/shutdown": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminShutdown"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Shut down server", "produces": ["application/json"]}}, "/status": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatus"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the server status", "produces": ["application/json"]}}, "/status/config": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminConfig"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the server configuration", "produces": ["application/json"]}}, "/status/live": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatusLiveliness"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Liveliness check", "produces": ["application/json"]}}, "/status/ready": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatusReadiness"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Readiness check", "produces": ["application/json"]}}, "/status/reset": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminReset"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Reset statistics", "produces": ["application/json"]}}, "/transaction/{tran_id}/resend": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": null}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Author to resend a particular transaction request", "produces": ["application/json"]}}, "/transactions": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionList"}, "description": null}}, "parameters": [], "tags": ["endorse-transaction"], "summary": "Query transactions", "produces": ["application/json"]}}, "/transactions/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/Date"}}, {"in": "query", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "endorser_write_txn", "required": false, "type": "boolean", "description": "Endorser will write the transaction after endorsing it"}], "tags": ["endorse-transaction"], "summary": "For author to send a transaction request", "produces": ["application/json"]}}, "/transactions/{conn_id}/set-endorser-info": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/EndorserInfo"}, "description": null}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "endorser_did", "required": true, "type": "string", "description": "Endorser DID"}, {"in": "query", "name": "endorser_name", "required": false, "type": "string", "description": "Endorser Name"}], "tags": ["endorse-transaction"], "summary": "Set Endorser Info", "produces": ["application/json"]}}, "/transactions/{conn_id}/set-endorser-role": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionJobs"}, "description": null}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "transaction_my_job", "required": false, "type": "string", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "description": "Transaction related jobs"}], "tags": ["endorse-transaction"], "summary": "Set transaction jobs", "produces": ["application/json"]}}, "/transactions/{tran_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": null}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "Fetch a single transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/cancel": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": null}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Author to cancel a particular transaction request", "produces": ["application/json"]}}, "/transactions/{tran_id}/endorse": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": null}}, "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 endorse a particular transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/refuse": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": null}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Endorser to refuse a particular transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/write": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": null}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Author / Endorser to write an endorsed transaction to the ledger", "produces": ["application/json"]}}, "/wallet/did": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDList"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": false, "type": "string", "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$|^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "key_type", "required": false, "type": "string", "enum": ["ed25519", "bls12381g2"], "example": "ed25519", "description": "Key type to query for."}, {"in": "query", "name": "method", "required": false, "type": "string", "enum": ["key", "sov"], "example": "key", "description": "DID method to query for. e.g. sov to only fetch indy/sov DIDs"}, {"in": "query", "name": "posture", "required": false, "type": "string", "enum": ["public", "posted", "wallet_only"], "description": "Whether DID is current public DID, posted to ledger but current public DID, or local to the wallet", "example": "wallet_only"}, {"in": "query", "name": "verkey", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Verification key of interest", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}], "tags": ["wallet"], "summary": "List wallet DIDs", "produces": ["application/json"]}}, "/wallet/did/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDCreate"}}], "tags": ["wallet"], "summary": "Create a local DID", "produces": ["application/json"]}}, "/wallet/did/local/rotate-keypair": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["wallet"], "summary": "Rotate keypair for a DID not posted to the ledger", "produces": ["application/json"]}}, "/wallet/did/public": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [], "tags": ["wallet"], "summary": "Fetch the current public DID", "produces": ["application/json"]}, "post": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["wallet"], "summary": "Assign the current public DID", "produces": ["application/json"]}}, "/wallet/get-did-endpoint": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDEndpoint"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["wallet"], "summary": "Query DID endpoint in wallet", "produces": ["application/json"]}}, "/wallet/set-did-endpoint": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDEndpointWithType"}}], "tags": ["wallet"], "summary": "Update endpoint in wallet and on ledger if posted to it", "produces": ["application/json"]}}}, "info": {"title": "Aries Cloud Agent", "version": "v0.7.3"}, "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"}, "AdminAPIMessageTracing": {"properties": {"trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "type": "object"}, "AdminConfig": {"properties": {"config": {"description": "Configuration settings", "type": "object"}}, "type": "object"}, "AdminMediationDeny": {"properties": {"mediator_terms": {"description": "List of mediator rules for recipient", "items": {"description": "Indicate terms to which the mediator requires the recipient to agree", "type": "string"}, "type": "array"}, "recipient_terms": {"description": "List of recipient rules for mediation", "items": {"description": "Indicate terms to which the recipient requires the mediator to agree", "type": "string"}, "type": "array"}}, "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\"}", "type": "object"}, "jws": {"allOf": [{"$ref": "#/definitions/AttachDecoratorDataJWS"}], "description": "Detached Java Web Signature"}, "links": {"description": "List of hypertext links to data", "items": {"example": "https://link.to/data", "type": "string"}, "type": "array"}, "sha256": {"description": "SHA256 hash (binhex encoded) of content", "example": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb", "pattern": "^[a-fA-F0-9+/]{64}$", "type": "string"}}, "type": "object"}, "AttachDecoratorData1JWS": {"properties": {"header": {"$ref": "#/definitions/AttachDecoratorDataJWSHeader"}, "protected": {"description": "protected JWS header", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signature": {"description": "signature", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}}, "required": ["header", "signature"], "type": "object"}, "AttachDecoratorDataJWS": {"properties": {"header": {"$ref": "#/definitions/AttachDecoratorDataJWSHeader"}, "protected": {"description": "protected JWS header", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signature": {"description": "signature", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signatures": {"description": "List of signatures", "items": {"$ref": "#/definitions/AttachDecoratorData1JWS"}, "type": "array"}}, "type": "object"}, "AttachDecoratorDataJWSHeader": {"properties": {"kid": {"description": "Key identifier, in W3C did:key or DID URL format", "example": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4", "pattern": "^did:(?:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+|sov:[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}(;.*)?(\\?.*)?#.+)$", "type": "string"}}, "required": ["kid"], "type": "object"}, "AttachmentDef": {"properties": {"id": {"description": "Attachment identifier", "example": "attachment-0", "type": "string"}, "type": {"description": "Attachment type", "enum": ["credential-offer", "present-proof"], "example": "present-proof", "type": "string"}}, "type": "object"}, "AttributeMimeTypesResult": {"properties": {"results": {"additionalProperties": {"description": "MIME type", "type": "string"}, "type": "object", "x-nullable": true}}, "type": "object"}, "BasicMessageModuleResponse": {"properties": {}, "type": "object"}, "ClaimFormat": {"properties": {"jwt": {"type": "object"}, "jwt_vc": {"type": "object"}, "jwt_vp": {"type": "object"}, "ldp": {"type": "object"}, "ldp_vc": {"type": "object"}, "ldp_vp": {"type": "object"}}, "type": "object"}, "ClearPendingRevocationsRequest": {"properties": {"purge": {"additionalProperties": {"items": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "type": "array"}, "description": "Credential revocation ids by revocation registry id: omit for all, specify null or empty list for all pending per revocation registry", "type": "object"}}, "type": "object"}, "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"}, "routing_state": {"description": "Routing state of connection", "enum": ["none", "request", "active", "error"], "example": "active", "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": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "imageUrl": {"description": "Optional image URL for connection invitation", "example": "http://192.168.56.101/img/logo.jpg", "format": "url", "type": "string", "x-nullable": true}, "label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipientKeys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routingKeys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "serviceEndpoint": {"description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020", "type": "string"}}, "type": "object"}, "ConnectionList": {"properties": {"results": {"description": "List of connection records", "items": {"$ref": "#/definitions/ConnRecord"}, "type": "array"}}, "type": "object"}, "ConnectionMetadata": {"properties": {"results": {"description": "Dictionary of metadata associated with connection.", "type": "object"}}, "type": "object"}, "ConnectionMetadataSetRequest": {"properties": {"metadata": {"description": "Dictionary of metadata to set for connection.", "type": "object"}}, "required": ["metadata"], "type": "object"}, "ConnectionModuleResponse": {"properties": {}, "type": "object"}, "ConnectionStaticRequest": {"properties": {"alias": {"description": "Alias to assign to this connection", "type": "string"}, "my_did": {"description": "Local DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "my_seed": {"description": "Seed to use for the local DID", "type": "string"}, "their_did": {"description": "Remote DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "their_endpoint": {"description": "URL endpoint for other party", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "their_label": {"description": "Other party's label for this connection", "type": "string"}, "their_seed": {"description": "Seed to use for the remote DID", "type": "string"}, "their_verkey": {"description": "Remote verification key", "type": "string"}}, "type": "object"}, "ConnectionStaticResult": {"properties": {"my_did": {"description": "Local DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "my_endpoint": {"description": "My URL endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "my_verkey": {"description": "My verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "record": {"$ref": "#/definitions/ConnRecord"}, "their_did": {"description": "Remote DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "their_verkey": {"description": "Remote verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}}, "required": ["my_did", "my_endpoint", "my_verkey", "record", "their_did", "their_verkey"], "type": "object"}, "Constraints": {"properties": {"fields": {"items": {"$ref": "#/definitions/DIFField"}, "type": "array"}, "is_holder": {"items": {"$ref": "#/definitions/DIFHolder"}, "type": "array"}, "limit_disclosure": {"description": "LimitDisclosure", "type": "string"}, "status_active": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "status_revoked": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "status_suspended": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "subject_is_issuer": {"description": "SubjectIsIssuer", "enum": ["required", "preferred"], "type": "string"}}, "type": "object"}, "CreateInvitationRequest": {"properties": {"mediation_id": {"description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "metadata": {"description": "Optional metadata to attach to the connection created with the invitation", "type": "object"}, "my_label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipient_keys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routing_keys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "service_endpoint": {"description": "Connection endpoint", "example": "http://192.168.56.102:8020", "type": "string"}}, "type": "object"}, "CreateWalletRequest": {"properties": {"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_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"}, "CredRevRecordResult": {"properties": {"result": {"$ref": "#/definitions/IssuerCredRevRecord"}}, "type": "object"}, "CredRevokedResult": {"properties": {"revoked": {"description": "Whether credential is revoked on the ledger", "type": "boolean"}}, "type": "object"}, "Credential": {"properties": {"@context": {"description": "The JSON-LD context of the credential", "example": ["https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"], "items": {}, "type": "array"}, "credentialSubject": {"example": {"alumniOf": {"id": "did:example:c276e12ec21ebfeb1f712ebc6f1"}, "id": "did:example:ebfeb1f712ebc6f1c276e12ec21"}}, "expirationDate": {"description": "The expiration date", "example": "2010-01-01T19:23:24Z", "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", "type": "string"}, "id": {"example": "http://example.edu/credentials/1872", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}, "issuanceDate": {"description": "The issuance date", "example": "2010-01-01T19:23:24Z", "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", "type": "string"}, "issuer": {"description": "The JSON-LD Verifiable Credential Issuer. Either string of object with id field.", "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"}, "proof": {"allOf": [{"$ref": "#/definitions/LinkedDataProof"}], "description": "The proof of the credential", "example": {"created": "2019-12-11T03:50:55", "jws": "eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ", "proofPurpose": "assertionMethod", "type": "Ed25519Signature2018", "verificationMethod": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"}}, "type": {"description": "The JSON-LD type of the credential", "example": ["VerifiableCredential", "AlumniCredential"], "items": {"type": "string"}, "type": "array"}}, "required": ["@context", "credentialSubject", "issuanceDate", "issuer", "type"], "type": "object"}, "CredentialDefinition": {"properties": {"id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "schemaId": {"description": "Schema identifier within credential definition identifier", "example": "20", "type": "string"}, "tag": {"description": "Tag within credential definition identifier", "example": "tag", "type": "string"}, "type": {"default": "CL", "description": "Signature type: CL for Camenisch-Lysyanskaya", "example": "CL"}, "value": {"allOf": [{"$ref": "#/definitions/CredDefValue"}], "description": "Credential definition primary and revocation values"}, "ver": {"description": "Node protocol version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "CredentialDefinitionGetResult": {"properties": {"credential_definition": {"$ref": "#/definitions/CredentialDefinition"}}, "type": "object"}, "CredentialDefinitionSendRequest": {"properties": {"revocation_registry_size": {"description": "Revocation registry size", "example": 1000, "format": "int32", "maximum": 32768, "minimum": 4, "type": "integer"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "support_revocation": {"description": "Revocation supported flag", "type": "boolean"}, "tag": {"description": "Credential definition identifier tag", "example": "default", "type": "string"}}, "type": "object"}, "CredentialDefinitionSendResult": {"properties": {"credential_definition_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}}, "type": "object"}, "CredentialDefinitionsCreatedResult": {"properties": {"credential_definition_ids": {"items": {"description": "Credential definition identifiers", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "type": "array"}}, "type": "object"}, "CredentialOffer": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"$ref": "#/definitions/CredentialPreview"}, "offers~attach": {"items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["offers~attach"], "type": "object"}, "CredentialPreview": {"properties": {"@type": {"description": "Message type identifier", "example": "issue-credential/1.0/credential-preview", "type": "string"}, "attributes": {"items": {"$ref": "#/definitions/CredAttrSpec"}, "type": "array"}}, "required": ["attributes"], "type": "object"}, "CredentialProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "cred_def_id": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "issuer_did": {"example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"type": "string"}, "schema_version": {"example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "CredentialStatusOptions": {"properties": {"type": {"description": "Credential status method type to use for the credential. Should match status method registered in the Verifiable Credential Extension Registry", "example": "CredentialStatusList2017", "type": "string"}}, "required": ["type"], "type": "object"}, "DID": {"properties": {"did": {"description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$|^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "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", "enum": ["sov", "key"], "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": {"enum": ["key", "sov"], "example": "sov", "type": "string"}, "options": {"allOf": [{"$ref": "#/definitions/DIDCreateOptions"}], "description": "To define a key type for a did:key"}}, "type": "object"}, "DIDCreateOptions": {"properties": {"key_type": {"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"}, "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": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "did_doc~attach": {"allOf": [{"$ref": "#/definitions/AttachDecorator"}], "description": "As signed attachment, DID Doc associated with DID"}, "label": {"description": "Label for DID exchange request", "example": "Request to connect with Bob", "type": "string"}}, "required": ["label"], "type": "object"}, "DIFField": {"properties": {"filter": {"$ref": "#/definitions/Filter"}, "id": {"description": "ID", "type": "string"}, "path": {"items": {"description": "Path", "type": "string"}, "type": "array"}, "predicate": {"description": "Preference", "enum": ["required", "preferred"], "type": "string"}, "purpose": {"description": "Purpose", "type": "string"}}, "type": "object"}, "DIFHolder": {"properties": {"directive": {"description": "Preference", "enum": ["required", "preferred"], "type": "string"}, "field_id": {"items": {"description": "FieldID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "type": "array"}}, "type": "object"}, "DIFOptions": {"properties": {"challenge": {"description": "Challenge protect against replay attack", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "domain": {"description": "Domain protect against replay attack", "example": "4jt78h47fh47", "type": "string"}}, "type": "object"}, "DIFPresSpec": {"properties": {"issuer_id": {"description": "Issuer identifier to sign the presentation, if different from current public DID", "type": "string"}, "presentation_definition": {"$ref": "#/definitions/PresentationDefinition"}, "record_ids": {"description": "Mapping of input_descriptor id to list of stored W3C credential record_id", "example": {"": ["", ""], "": [""]}, "type": "object"}, "reveal_doc": {"description": "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", "example": {"@context": ["https://www.w3.org/2018/credentials/v1", "https://w3id.org/security/bbs/v1"], "@explicit": true, "@requireAll": true, "credentialSubject": {"@explicit": true, "@requireAll": true, "Observation": [{"effectiveDateTime": {}, "@explicit": true, "@requireAll": true}]}, "issuanceDate": {}, "issuer": {}, "type": ["VerifiableCredential", "LabReport"]}, "type": "object"}}, "type": "object"}, "DIFProofProposal": {"properties": {"input_descriptors": {"items": {"$ref": "#/definitions/InputDescriptors"}, "type": "array"}}, "type": "object"}, "DIFProofRequest": {"properties": {"options": {"$ref": "#/definitions/DIFOptions"}, "presentation_definition": {"$ref": "#/definitions/PresentationDefinition"}}, "required": ["presentation_definition"], "type": "object"}, "Date": {"properties": {"expires_time": {"description": "Expiry Date", "example": "2021-03-29T05:22:19Z", "format": "date-time", "type": "string"}}, "required": ["expires_time"], "type": "object"}, "Disclose": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "protocols": {"description": "List of protocol descriptors", "items": {"$ref": "#/definitions/ProtocolDescriptor"}, "type": "array"}}, "required": ["protocols"], "type": "object"}, "Disclosures": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "disclosures": {"description": "List of protocol or goal_code descriptors", "items": {}, "type": "array"}}, "required": ["disclosures"], "type": "object"}, "Doc": {"properties": {"credential": {"description": "Credential to sign", "type": "object"}, "options": {"allOf": [{"$ref": "#/definitions/SignatureOptions"}], "description": "Signature options"}}, "required": ["credential", "options"], "type": "object"}, "EndorserInfo": {"properties": {"endorser_did": {"description": "Endorser DID", "type": "string"}, "endorser_name": {"description": "Endorser Name", "type": "string"}}, "required": ["endorser_did"], "type": "object"}, "EndpointsResult": {"properties": {"my_endpoint": {"description": "My endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "their_endpoint": {"description": "Their endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}}, "type": "object"}, "Filter": {"properties": {"const": {"description": "Const"}, "enum": {"items": {"description": "Enum"}, "type": "array"}, "exclusiveMaximum": {"description": "ExclusiveMaximum"}, "exclusiveMinimum": {"description": "ExclusiveMinimum"}, "format": {"description": "Format", "type": "string"}, "maxLength": {"description": "Max Length", "example": 1234, "format": "int32", "type": "integer"}, "maximum": {"description": "Maximum"}, "minLength": {"description": "Min Length", "example": 1234, "format": "int32", "type": "integer"}, "minimum": {"description": "Minimum"}, "not": {"description": "Not", "example": false, "type": "boolean"}, "pattern": {"description": "Pattern", "type": "string"}, "type": {"description": "Type", "type": "string"}}, "type": "object"}, "Generated": {"properties": {"master_secret": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "number": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "remainder": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "GetDIDEndpointResponse": {"properties": {"endpoint": {"description": "Full verification key", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string", "x-nullable": true}}, "type": "object"}, "GetDIDVerkeyResponse": {"properties": {"verkey": {"description": "Full verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string", "x-nullable": true}}, "type": "object"}, "GetNymRoleResponse": {"properties": {"role": {"description": "Ledger role", "enum": ["STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "USER", "ROLE_REMOVE"], "example": "ENDORSER", "type": "string"}}, "type": "object"}, "HolderModuleResponse": {"properties": {}, "type": "object"}, "IndyAttrValue": {"properties": {"encoded": {"description": "Attribute encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Attribute raw value", "type": "string"}}, "required": ["encoded", "raw"], "type": "object"}, "IndyCredAbstract": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "key_correctness_proof": {"allOf": [{"$ref": "#/definitions/IndyKeyCorrectnessProof"}], "description": "Key correctness proof"}, "nonce": {"description": "Nonce in credential abstract", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "required": ["cred_def_id", "key_correctness_proof", "nonce", "schema_id"], "type": "object"}, "IndyCredInfo": {"properties": {"attrs": {"additionalProperties": {"example": "alice", "type": "string"}, "description": "Attribute names and value", "type": "object"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string", "x-nullable": true}, "referent": {"description": "Wallet referent", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyCredPrecis": {"properties": {"cred_info": {"allOf": [{"$ref": "#/definitions/IndyCredInfo"}], "description": "Credential info"}, "interval": {"allOf": [{"$ref": "#/definitions/IndyNonRevocationInterval"}], "description": "Non-revocation interval from presentation request"}, "presentation_referents": {"items": {"description": "presentation referent", "example": "1_age_uuid", "type": "string"}, "type": "array"}}, "type": "object"}, "IndyCredRequest": {"properties": {"blinded_ms": {"description": "Blinded master secret", "type": "object"}, "blinded_ms_correctness_proof": {"description": "Blinded master secret correctness proof", "type": "object"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "nonce": {"description": "Nonce in credential request", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "prover_did": {"description": "Prover DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}}, "required": ["blinded_ms", "blinded_ms_correctness_proof", "cred_def_id", "nonce"], "type": "object"}, "IndyCredential": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "rev_reg": {"description": "Revocation registry state", "type": "object", "x-nullable": true}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "signature": {"description": "Credential signature", "type": "object"}, "signature_correctness_proof": {"description": "Credential signature correctness proof", "type": "object"}, "values": {"additionalProperties": {"allOf": [{"$ref": "#/definitions/IndyAttrValue"}], "description": "Attribute value"}, "description": "Credential attributes", "type": "object"}, "witness": {"description": "Witness for revocation proof", "type": "object", "x-nullable": true}}, "required": ["cred_def_id", "schema_id", "signature", "signature_correctness_proof", "values"], "type": "object"}, "IndyEQProof": {"properties": {"a_prime": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "e": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "m": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "m2": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "revealed_attrs": {"additionalProperties": {"example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "type": "object"}, "v": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "IndyGEProof": {"properties": {"alpha": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "mj": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "predicate": {"$ref": "#/definitions/IndyGEProofPred"}, "r": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "t": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "u": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}}, "type": "object"}, "IndyGEProofPred": {"properties": {"attr_name": {"description": "Attribute name, indy-canonicalized", "type": "string"}, "p_type": {"description": "Predicate type", "enum": ["LT", "LE", "GE", "GT"], "type": "string"}, "value": {"description": "Predicate threshold value", "format": "int32", "type": "integer"}}, "type": "object"}, "IndyKeyCorrectnessProof": {"properties": {"c": {"description": "c in key correctness proof", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "xr_cap": {"description": "xr_cap in key correctness proof", "items": {"description": "xr_cap components in key correctness proof", "items": {"description": "xr_cap component values in key correctness proof", "type": "string"}, "type": "array"}, "type": "array"}, "xz_cap": {"description": "xz_cap in key correctness proof", "example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "required": ["c", "xr_cap", "xz_cap"], "type": "object"}, "IndyNonRevocProof": {"properties": {"c_list": {"additionalProperties": {"type": "string"}, "type": "object"}, "x_list": {"additionalProperties": {"type": "string"}, "type": "object"}}, "type": "object"}, "IndyNonRevocationInterval": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyPresAttrSpec": {"properties": {"cred_def_id": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "mime-type": {"description": "MIME type (default null)", "example": "image/jpeg", "type": "string"}, "name": {"description": "Attribute name", "example": "favourite_drink", "type": "string"}, "referent": {"description": "Credential referent", "example": "0", "type": "string"}, "value": {"description": "Attribute value", "example": "martini", "type": "string"}}, "required": ["name"], "type": "object"}, "IndyPresPredSpec": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "name": {"description": "Attribute name", "example": "high_score", "type": "string"}, "predicate": {"description": "Predicate type ('<', '<=', '>=', or '>')", "enum": ["<", "<=", ">=", ">"], "example": ">=", "type": "string"}, "threshold": {"description": "Threshold value", "format": "int32", "type": "integer"}}, "required": ["name", "predicate", "threshold"], "type": "object"}, "IndyPresPreview": {"properties": {"@type": {"description": "Message type identifier", "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/present-proof/1.0/presentation-preview", "type": "string"}, "attributes": {"items": {"$ref": "#/definitions/IndyPresAttrSpec"}, "type": "array"}, "predicates": {"items": {"$ref": "#/definitions/IndyPresPredSpec"}, "type": "array"}}, "required": ["attributes", "predicates"], "type": "object"}, "IndyPresSpec": {"properties": {"requested_attributes": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedAttr"}, "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers", "type": "object"}, "requested_predicates": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedPred"}, "description": "Nested object mapping proof request predicate referents to requested-predicate specifiers", "type": "object"}, "self_attested_attributes": {"additionalProperties": {"description": "Self-attested attribute values to use in requested-credentials structure for proof construction", "example": "self_attested_value", "type": "string"}, "description": "Self-attested attributes to build into proof", "type": "object"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["requested_attributes", "requested_predicates", "self_attested_attributes"], "type": "object"}, "IndyPrimaryProof": {"properties": {"eq_proof": {"allOf": [{"$ref": "#/definitions/IndyEQProof"}], "description": "Indy equality proof", "x-nullable": true}, "ge_proofs": {"description": "Indy GE proofs", "items": {"$ref": "#/definitions/IndyGEProof"}, "type": "array", "x-nullable": true}}, "type": "object"}, "IndyProof": {"properties": {"identifiers": {"description": "Indy proof.identifiers content", "items": {"$ref": "#/definitions/IndyProofIdentifier"}, "type": "array"}, "proof": {"allOf": [{"$ref": "#/definitions/IndyProofProof"}], "description": "Indy proof.proof content"}, "requested_proof": {"allOf": [{"$ref": "#/definitions/IndyProofRequestedProof"}], "description": "Indy proof.requested_proof content"}}, "type": "object"}, "IndyProofIdentifier": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "timestamp": {"description": "Timestamp epoch", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer", "x-nullable": true}}, "type": "object"}, "IndyProofProof": {"properties": {"aggregated_proof": {"allOf": [{"$ref": "#/definitions/IndyProofProofAggregatedProof"}], "description": "Indy proof aggregated proof"}, "proofs": {"description": "Indy proof proofs", "items": {"$ref": "#/definitions/IndyProofProofProofsProof"}, "type": "array"}}, "type": "object"}, "IndyProofProofAggregatedProof": {"properties": {"c_hash": {"description": "c_hash value", "type": "string"}, "c_list": {"description": "c_list value", "items": {"items": {"format": "int32", "type": "integer"}, "type": "array"}, "type": "array"}}, "type": "object"}, "IndyProofProofProofsProof": {"properties": {"non_revoc_proof": {"allOf": [{"$ref": "#/definitions/IndyNonRevocProof"}], "description": "Indy non-revocation proof", "x-nullable": true}, "primary_proof": {"allOf": [{"$ref": "#/definitions/IndyPrimaryProof"}], "description": "Indy primary proof"}}, "type": "object"}, "IndyProofReqAttrSpec": {"properties": {"name": {"description": "Attribute name", "example": "favouriteDrink", "type": "string"}, "names": {"description": "Attribute name group", "items": {"example": "age", "type": "string"}, "type": "array"}, "non_revoked": {"allOf": [{"$ref": "#/definitions/IndyProofReqAttrSpecNonRevoked"}], "x-nullable": true}, "restrictions": {"description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "items": {"additionalProperties": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "type": "string"}, "type": "object"}, "type": "array"}}, "type": "object"}, "IndyProofReqAttrSpecNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofReqPredSpec": {"properties": {"name": {"description": "Attribute name", "example": "index", "type": "string"}, "non_revoked": {"allOf": [{"$ref": "#/definitions/IndyProofReqPredSpecNonRevoked"}], "x-nullable": true}, "p_type": {"description": "Predicate type ('<', '<=', '>=', or '>')", "enum": ["<", "<=", ">=", ">"], "example": ">=", "type": "string"}, "p_value": {"description": "Threshold value", "format": "int32", "type": "integer"}, "restrictions": {"description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "items": {"additionalProperties": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "type": "string"}, "type": "object"}, "type": "array"}}, "required": ["name", "p_type", "p_value"], "type": "object"}, "IndyProofReqPredSpecNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofRequest": {"properties": {"name": {"description": "Proof request name", "example": "Proof request", "type": "string"}, "non_revoked": {"allOf": [{"$ref": "#/definitions/IndyProofRequestNonRevoked"}], "x-nullable": true}, "nonce": {"description": "Nonce", "example": "1", "pattern": "^[1-9][0-9]*$", "type": "string"}, "requested_attributes": {"additionalProperties": {"$ref": "#/definitions/IndyProofReqAttrSpec"}, "description": "Requested attribute specifications of proof request", "type": "object"}, "requested_predicates": {"additionalProperties": {"$ref": "#/definitions/IndyProofReqPredSpec"}, "description": "Requested predicate specifications of proof request", "type": "object"}, "version": {"description": "Proof request version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "required": ["requested_attributes", "requested_predicates"], "type": "object"}, "IndyProofRequestNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofRequestedProof": {"properties": {"predicates": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofPredicate"}, "description": "Proof requested proof predicates.", "type": "object"}, "revealed_attr_groups": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofRevealedAttrGroup"}, "description": "Proof requested proof revealed attribute groups", "type": "object", "x-nullable": true}, "revealed_attrs": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofRevealedAttr"}, "description": "Proof requested proof revealed attributes", "type": "object", "x-nullable": true}, "self_attested_attrs": {"description": "Proof requested proof self-attested attributes", "type": "object"}, "unrevealed_attrs": {"description": "Unrevealed attributes", "type": "object"}}, "type": "object"}, "IndyProofRequestedProofPredicate": {"properties": {"sub_proof_index": {"description": "Sub-proof index", "format": "int32", "type": "integer"}}, "type": "object"}, "IndyProofRequestedProofRevealedAttr": {"properties": {"encoded": {"description": "Encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Raw value", "type": "string"}, "sub_proof_index": {"description": "Sub-proof index", "format": "int32", "type": "integer"}}, "type": "object"}, "IndyProofRequestedProofRevealedAttrGroup": {"properties": {"sub_proof_index": {"description": "Sub-proof index", "format": "int32", "type": "integer"}, "values": {"additionalProperties": {"$ref": "#/definitions/RawEncoded"}, "description": "Indy proof requested proof revealed attr groups group value", "type": "object"}}, "type": "object"}, "IndyRequestedCredsRequestedAttr": {"properties": {"cred_id": {"description": "Wallet credential identifier (typically but not necessarily a UUID)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "revealed": {"description": "Whether to reveal attribute in proof (default true)", "type": "boolean"}}, "required": ["cred_id"], "type": "object"}, "IndyRequestedCredsRequestedPred": {"properties": {"cred_id": {"description": "Wallet credential identifier (typically but not necessarily a UUID)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "timestamp": {"description": "Epoch timestamp of interest for non-revocation proof", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "required": ["cred_id"], "type": "object"}, "IndyRevRegDef": {"properties": {"credDefId": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "id": {"description": "Indy revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "revocDefType": {"description": "Revocation registry type (specify CL_ACCUM)", "enum": ["CL_ACCUM"], "example": "CL_ACCUM", "type": "string"}, "tag": {"description": "Revocation registry tag", "type": "string"}, "value": {"allOf": [{"$ref": "#/definitions/IndyRevRegDefValue"}], "description": "Revocation registry definition value"}, "ver": {"description": "Version of revocation registry definition", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyRevRegDefValue": {"properties": {"issuanceType": {"description": "Issuance type", "enum": ["ISSUANCE_ON_DEMAND", "ISSUANCE_BY_DEFAULT"], "type": "string"}, "maxCredNum": {"description": "Maximum number of credentials; registry size", "example": 10, "format": "int32", "minimum": 1, "type": "integer"}, "publicKeys": {"allOf": [{"$ref": "#/definitions/IndyRevRegDefValuePublicKeys"}], "description": "Public keys"}, "tailsHash": {"description": "Tails hash value", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "tailsLocation": {"description": "Tails file location", "type": "string"}}, "type": "object"}, "IndyRevRegDefValuePublicKeys": {"properties": {"accumKey": {"$ref": "#/definitions/IndyRevRegDefValuePublicKeysAccumKey"}}, "type": "object"}, "IndyRevRegDefValuePublicKeysAccumKey": {"properties": {"z": {"description": "Value for z", "example": "1 120F522F81E6B7 1 09F7A59005C4939854", "type": "string"}}, "type": "object"}, "IndyRevRegEntry": {"properties": {"value": {"allOf": [{"$ref": "#/definitions/IndyRevRegEntryValue"}], "description": "Revocation registry entry value"}, "ver": {"description": "Version of revocation registry entry", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyRevRegEntryValue": {"properties": {"accum": {"description": "Accumulator value", "example": "21 11792B036AED0AAA12A4 4 298B2571FFC63A737", "type": "string"}, "prevAccum": {"description": "Previous accumulator value", "example": "21 137AC810975E4 6 76F0384B6F23", "type": "string"}, "revoked": {"description": "Revoked credential revocation identifiers", "items": {"format": "int32", "type": "integer"}, "type": "array"}}, "type": "object"}, "InputDescriptors": {"properties": {"constraints": {"$ref": "#/definitions/Constraints"}, "group": {"items": {"description": "Group", "type": "string"}, "type": "array"}, "id": {"description": "ID", "type": "string"}, "metadata": {"description": "Metadata dictionary", "type": "object"}, "name": {"description": "Name", "type": "string"}, "purpose": {"description": "Purpose", "type": "string"}, "schema": {"allOf": [{"$ref": "#/definitions/SchemasInputDescriptorFilter"}], "description": "Accepts a list of schema or a dict containing filters like oneof_filter.", "example": {"oneOf": [[{"uri": "https://www.w3.org/Test1#Test1"}, {"uri": "https://www.w3.org/Test2#Test2"}], {"oneof_filter": [[{"uri": "https://www.w3.org/Test1#Test1"}], [{"uri": "https://www.w3.org/Test2#Test2"}]]}]}}}, "type": "object"}, "IntroModuleResponse": {"properties": {}, "type": "object"}, "InvitationCreateRequest": {"properties": {"alias": {"description": "Alias for connection", "example": "Barry", "type": "string"}, "attachments": {"description": "Optional invitation attachments", "items": {"$ref": "#/definitions/AttachmentDef"}, "type": "array"}, "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"}, "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", "readOnly": true, "type": "string"}, "handshake_protocols": {"items": {"description": "Handshake protocol", "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0", "type": "string"}, "type": "array"}, "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"}, "state": {"description": "Out of band message exchange state", "example": "await_response", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "InvitationResult": {"properties": {"connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation": {"$ref": "#/definitions/ConnectionInvitation"}, "invitation_url": {"description": "Invitation URL", "example": "http://192.168.56.101:8020/invite?c_i=eyJAdHlwZSI6Li4ufQ==", "type": "string"}}, "type": "object"}, "IssueCredentialModuleResponse": {"properties": {}, "type": "object"}, "IssuerCredRevRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "cred_ex_id": {"description": "Credential exchange record identifier at credential issue", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_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"}, "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": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[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": {"mediator_terms": {"description": "List of mediator rules for recipient", "items": {"description": "Indicate terms to which the mediator requires the recipient to agree", "type": "string"}, "type": "array"}, "recipient_terms": {"description": "List of recipient rules for mediation", "items": {"description": "Indicate terms to which the recipient requires the mediator to agree", "type": "string"}, "type": "array"}}, "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"}, "mediator_terms": {"items": {"description": "Terms for mediator to agree", "type": "string"}, "type": "array"}, "recipient_terms": {"items": {"description": "Terms for recipient to agree", "type": "string"}, "type": "array"}}, "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"}, "MediationList": {"properties": {"results": {"description": "List of mediation records", "items": {"$ref": "#/definitions/MediationRecord"}, "type": "array"}}, "type": "object"}, "MediationRecord": {"properties": {"connection_id": {"type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "endpoint": {"type": "string"}, "mediation_id": {"type": "string"}, "mediator_terms": {"items": {"type": "string"}, "type": "array"}, "recipient_terms": {"items": {"type": "string"}, "type": "array"}, "role": {"type": "string"}, "routing_keys": {"items": {"example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "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"}, "PerformRequest": {"properties": {"name": {"description": "Menu option name", "example": "Query", "type": "string"}, "params": {"additionalProperties": {"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "description": "Input parameter values", "type": "object"}}, "type": "object"}, "PingRequest": {"properties": {"comment": {"description": "Comment for the ping message", "type": "string", "x-nullable": true}}, "type": "object"}, "PingRequestResponse": {"properties": {"thread_id": {"description": "Thread ID of the ping message", "type": "string"}}, "type": "object"}, "PresentationDefinition": {"properties": {"format": {"$ref": "#/definitions/ClaimFormat"}, "id": {"description": "Unique Resource Identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "input_descriptors": {"items": {"$ref": "#/definitions/InputDescriptors"}, "type": "array"}, "name": {"description": "Human-friendly name that describes what the presentation definition pertains to", "type": "string"}, "purpose": {"description": "Describes the purpose for which the Presentation Definition's inputs are being requested", "type": "string"}, "submission_requirements": {"items": {"$ref": "#/definitions/SubmissionRequirements"}, "type": "array"}}, "type": "object"}, "PresentationProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "presentation_proposal": {"$ref": "#/definitions/IndyPresPreview"}}, "required": ["presentation_proposal"], "type": "object"}, "PresentationRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "request_presentations~attach": {"items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["request_presentations~attach"], "type": "object"}, "ProtocolDescriptor": {"properties": {"pid": {"type": "string"}, "roles": {"description": "List of roles", "items": {"description": "Role: requester or responder", "example": "requester", "type": "string"}, "type": "array", "x-nullable": true}}, "required": ["pid"], "type": "object"}, "PublishRevocations": {"properties": {"rrid2crid": {"additionalProperties": {"items": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "type": "array"}, "description": "Credential revocation ids by revocation registry id", "type": "object"}}, "type": "object"}, "Queries": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "queries": {"items": {"$ref": "#/definitions/QueryItem"}, "type": "array"}}, "type": "object"}, "Query": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"type": "string", "x-nullable": true}, "query": {"type": "string"}}, "required": ["query"], "type": "object"}, "QueryItem": {"properties": {"feature-type": {"description": "feature type", "enum": ["protocol", "goal-code"], "type": "string"}, "match": {"description": "match", "type": "string"}}, "required": ["feature-type", "match"], "type": "object"}, "RawEncoded": {"properties": {"encoded": {"description": "Encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Raw value", "type": "string"}}, "type": "object"}, "ReceiveInvitationRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "did": {"description": "DID for connection invitation", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "imageUrl": {"description": "Optional image URL for connection invitation", "example": "http://192.168.56.101/img/logo.jpg", "format": "url", "type": "string", "x-nullable": true}, "label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipientKeys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routingKeys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "serviceEndpoint": {"description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020", "type": "string"}}, "type": "object"}, "RegisterLedgerNymResponse": {"properties": {"success": {"description": "Success of nym registration operation", "example": true, "type": "boolean"}}, "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_doc": {"description": "DID Document", "type": "object"}, "metadata": {"description": "Resolution metadata", "type": "object"}}, "required": ["did_doc", "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"}, "RevRegsCreated": {"properties": {"rev_reg_ids": {"items": {"description": "Revocation registry identifiers", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "type": "array"}}, "type": "object"}, "RevocationModuleResponse": {"properties": {}, "type": "object"}, "RevokeRequest": {"properties": {"comment": {"description": "Optional comment to include in revocation notification", "type": "string"}, "connection_id": {"description": "Connection ID to which the revocation notification will be sent; required if notify is true", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "cred_ex_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "notify": {"description": "Send a notification to the credential recipient", "type": "boolean"}, "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"}, "Schema": {"properties": {"attrNames": {"description": "Schema attribute names", "items": {"description": "Attribute name", "example": "score", "type": "string"}, "type": "array"}, "id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "name": {"description": "Schema name", "example": "schema_name", "type": "string"}, "seqNo": {"description": "Schema sequence number", "example": 10, "format": "int32", "minimum": 1, "type": "integer"}, "ver": {"description": "Node protocol version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}, "version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "SchemaGetResult": {"properties": {"schema": {"$ref": "#/definitions/Schema"}}, "type": "object"}, "SchemaInputDescriptor": {"properties": {"required": {"description": "Required", "type": "boolean"}, "uri": {"description": "URI", "type": "string"}}, "type": "object"}, "SchemaSendRequest": {"properties": {"attributes": {"description": "List of schema attributes", "items": {"description": "attribute name", "example": "score", "type": "string"}, "type": "array"}, "schema_name": {"description": "Schema name", "example": "prefs", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "required": ["attributes", "schema_name", "schema_version"], "type": "object"}, "SchemaSendResult": {"properties": {"schema": {"allOf": [{"$ref": "#/definitions/Schema"}], "description": "Schema definition"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "required": ["schema_id"], "type": "object"}, "SchemasCreatedResult": {"properties": {"schema_ids": {"items": {"description": "Schema identifiers", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "type": "array"}}, "type": "object"}, "SchemasInputDescriptorFilter": {"properties": {"oneof_filter": {"description": "oneOf", "type": "boolean"}, "uri_groups": {"items": {"items": {"$ref": "#/definitions/SchemaInputDescriptor"}, "type": "array"}, "type": "array"}}, "type": "object"}, "SendMenu": {"properties": {"menu": {"allOf": [{"$ref": "#/definitions/MenuJson"}], "description": "Menu to send to connection"}}, "required": ["menu"], "type": "object"}, "SendMessage": {"properties": {"content": {"description": "Message content", "example": "Hello", "type": "string"}}, "type": "object"}, "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"}, "TransactionJobs": {"properties": {"transaction_my_job": {"description": "My transaction related job", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "type": "string"}, "transaction_their_job": {"description": "Their transaction related job", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "type": "string"}}, "type": "object"}, "TransactionList": {"properties": {"results": {"description": "List of transaction records", "items": {"$ref": "#/definitions/TransactionRecord"}, "type": "array"}}, "type": "object"}, "TransactionRecord": {"properties": {"_type": {"description": "Transaction type", "example": "101", "type": "string"}, "connection_id": {"description": "The connection identifier for thie particular transaction record", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "endorser_write_txn": {"description": "If True, Endorser will write the transaction after endorsing it", "example": true, "type": "boolean"}, "formats": {"items": {"additionalProperties": {"type": "string"}, "example": {"attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "dif/endorse-transaction/request@v1.0"}, "type": "object"}, "type": "array"}, "messages_attach": {"items": {"example": {"@id": "143c458d-1b1c-40c7-ab85-4d16808ddf0a", "data": {"json": "{\"endorser\": \"V4SGRU86Z58d6TV7PBUe6f\",\"identifier\": \"LjgpST2rjsoxYegQDRm7EL\",\"operation\": {\"data\": {\"attr_names\": [\"first_name\", \"last_name\"],\"name\": \"test_schema\",\"version\": \"2.1\",},\"type\": \"101\",},\"protocolVersion\": 2,\"reqId\": 1597766666168851000,\"signatures\": {\"LjgpST2rjsox\": \"4ATKMn6Y9sTgwqaGTm7py2c2M8x1EVDTWKZArwyuPgjU\"},\"taaAcceptance\": {\"mechanism\": \"manual\",\"taaDigest\": \"f50fe2c2ab977006761d36bd6f23e4c6a7e0fc2feb9f62\",\"time\": 1597708800,}}"}, "mime-type": "application/json"}, "type": "object"}, "type": "array"}, "meta_data": {"example": {"context": {"param1": "param1_value", "param2": "param2_value"}, "post_process": [{"topic": "topic_value", "other": "other_value"}]}, "type": "object"}, "signature_request": {"items": {"example": {"author_goal_code": "aries.transaction.ledger.write", "context": "did:sov", "method": "add-signature", "signature_type": "", "signer_goal_code": "aries.transaction.endorse"}, "type": "object"}, "type": "array"}, "signature_response": {"items": {"example": {"context": "did:sov", "message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "method": "add-signature", "signer_goal_code": "aries.transaction.refuse"}, "type": "object"}, "type": "array"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "thread_id": {"description": "Thread Identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "timing": {"example": {"expires_time": "2020-12-13T17:29:06+0000"}, "type": "object"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "transaction_id": {"description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "TxnOrCredentialDefinitionSendResult": {"properties": {"sent": {"$ref": "#/definitions/CredentialDefinitionSendResult"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Credential definition transaction to endorse"}}, "type": "object"}, "TxnOrPublishRevocationsResult": {"properties": {"sent": {"$ref": "#/definitions/PublishRevocations"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Revocation registry revocations transaction to endorse"}}, "type": "object"}, "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"}, "UpdateWalletRequest": {"properties": {"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"}, "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"}, "V10DiscoveryExchangeResult": {"properties": {"results": {"allOf": [{"$ref": "#/definitions/V10DiscoveryRecord"}], "description": "Discover Features v1.0 exchange record"}}, "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": {"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"}, "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"}}, "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"}, "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"}, "V10PresentationSendRequestRequest": {"properties": {"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"}, "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"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "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"], "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"}, "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"}, "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": {"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"}, "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": {"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"}, "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"], "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"}}, "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"}, "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": {"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": {"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"}, "VCRecord": {"properties": {"contexts": {"items": {"description": "Context", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "cred_tags": {"additionalProperties": {"description": "Retrieval tag value", "type": "string"}, "type": "object"}, "cred_value": {"description": "(JSON-serializable) credential value", "type": "object"}, "expanded_types": {"items": {"description": "JSON-LD expanded type extracted from type and context", "example": "https://w3id.org/citizenship#PermanentResidentCard", "type": "string"}, "type": "array"}, "given_id": {"description": "Credential identifier", "example": "http://example.edu/credentials/3732", "type": "string"}, "issuer_id": {"description": "Issuer identifier", "example": "https://example.edu/issuers/14", "type": "string"}, "proof_types": {"items": {"description": "Signature suite used for proof", "example": "Ed25519Signature2018", "type": "string"}, "type": "array"}, "record_id": {"description": "Record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "schema_ids": {"items": {"description": "Schema identifier", "example": "https://example.org/examples/degree.json", "type": "string"}, "type": "array"}, "subject_ids": {"items": {"description": "Subject identifier", "example": "did:example:ebfeb1f712ebc6f1c276e12ec21", "type": "string"}, "type": "array"}}, "type": "object"}, "VCRecordList": {"properties": {"results": {"items": {"$ref": "#/definitions/VCRecord"}, "type": "array"}}, "type": "object"}, "VerifyRequest": {"properties": {"doc": {"allOf": [{"$ref": "#/definitions/SignedDoc"}], "description": "Signed document"}, "verkey": {"description": "Verkey to use for doc verification", "type": "string"}}, "required": ["doc"], "type": "object"}, "VerifyResponse": {"properties": {"error": {"description": "Error text", "type": "string"}, "valid": {"type": "boolean"}}, "required": ["valid"], "type": "object"}, "W3CCredentialsListRequest": {"properties": {"contexts": {"items": {"description": "Credential context to match", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "given_id": {"description": "Given credential id to match", "type": "string"}, "issuer_id": {"description": "Credential issuer identifier to match", "type": "string"}, "max_results": {"description": "Maximum number of results to return", "format": "int32", "type": "integer"}, "proof_types": {"items": {"description": "Signature suite used for proof", "example": "Ed25519Signature2018", "type": "string"}, "type": "array"}, "schema_ids": {"description": "Schema identifiers, all of which to match", "items": {"description": "Credential schema identifier", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "subject_ids": {"description": "Subject identifiers, all of which to match", "items": {"description": "Subject identifier", "type": "string"}, "type": "array"}, "tag_query": {"additionalProperties": {"description": "Tag value", "type": "string"}, "description": "Tag filter", "type": "object"}, "types": {"items": {"description": "Credential type to match", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}}, "type": "object"}, "WalletList": {"properties": {"results": {"description": "List of wallet records", "items": {"$ref": "#/definitions/WalletRecord"}, "type": "array"}}, "type": "object"}, "WalletModuleResponse": {"properties": {}, "type": "object"}, "WalletRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "key_management_mode": {"description": "Mode regarding management of wallet key", "enum": ["managed", "unmanaged"], "type": "string"}, "settings": {"description": "Settings for this wallet.", "type": "object"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "wallet_id": {"description": "Wallet record ID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["key_management_mode", "wallet_id"], "type": "object"}, "WriteLedgerRequest": {"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": "trustping", "description": "Trust-ping over connection", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0048-trust-ping"}}, {"name": "wallet", "description": "DID and tag policy management", "externalDocs": {"description": "Design", "url": "https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage"}}]} \ No newline at end of file +{"paths": {"/action-menu/{conn_id}/close": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Close the active menu associated with a connection", "produces": ["application/json"]}}, "/action-menu/{conn_id}/fetch": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuFetchResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Fetch the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/perform": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PerformRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Perform an action associated with the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Request the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/send-menu": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SendMenu"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["action-menu"], "summary": "Send an action menu to a connection", "produces": ["application/json"]}}, "/connections": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionList"}, "description": ""}}, "parameters": [{"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "connection_protocol", "required": false, "type": "string", "enum": ["connections/1.0", "didexchange/1.0"], "description": "Connection protocol used", "example": "connections/1.0"}, {"in": "query", "name": "invitation_key", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "invitation key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, {"in": "query", "name": "invitation_msg_id", "required": false, "type": "string", "format": "uuid", "description": "Identifier of the associated Invitation Mesage", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "My DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["request", "start", "error", "active", "abandoned", "init", "invitation", "response", "completed"], "description": "Connection state"}, {"in": "query", "name": "their_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Their DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "their_public_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Their Public DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "their_role", "required": false, "type": "string", "enum": ["invitee", "requester", "inviter", "responder"], "description": "Their role in the connection protocol", "example": "invitee"}], "tags": ["connection"], "summary": "Query agent-to-agent connections", "produces": ["application/json"]}}, "/connections/create-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/InvitationResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateInvitationRequest"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "multi_use", "required": false, "type": "boolean", "description": "Create invitation for multiple use (default false)"}, {"in": "query", "name": "public", "required": false, "type": "boolean", "description": "Create invitation from public DID (default false)"}], "tags": ["connection"], "summary": "Create a new connection invitation", "produces": ["application/json"]}}, "/connections/create-static": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionStaticResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ConnectionStaticRequest"}}], "tags": ["connection"], "summary": "Create a new static connection", "produces": ["application/json"]}}, "/connections/receive-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ReceiveInvitationRequest"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Receive a new connection invitation", "produces": ["application/json"]}}, "/connections/{conn_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Fetch a single connection record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Remove an existing connection record", "produces": ["application/json"]}}, "/connections/{conn_id}/accept-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "query", "name": "my_label", "required": false, "type": "string", "description": "Label for connection", "example": "Broker"}], "tags": ["connection"], "summary": "Accept a stored connection invitation", "produces": ["application/json"]}}, "/connections/{conn_id}/accept-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}], "tags": ["connection"], "summary": "Accept a stored connection request", "produces": ["application/json"]}}, "/connections/{conn_id}/endpoints": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/EndpointsResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Fetch connection remote endpoint", "produces": ["application/json"]}}, "/connections/{conn_id}/establish-inbound/{ref_id}": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "path", "name": "ref_id", "required": true, "type": "string", "description": "Inbound connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Assign another connection as the inbound connection", "produces": ["application/json"]}}, "/connections/{conn_id}/metadata": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionMetadata"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "key", "required": false, "type": "string", "description": "Key to retrieve."}], "tags": ["connection"], "summary": "Fetch connection metadata", "produces": ["application/json"]}, "post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionMetadata"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ConnectionMetadataSetRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Set connection metadata", "produces": ["application/json"]}}, "/connections/{conn_id}/send-message": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/BasicMessageModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SendMessage"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["basicmessage"], "summary": "Send a basic message to a connection", "produces": ["application/json"]}}, "/connections/{conn_id}/send-ping": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/PingRequestResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PingRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["trustping"], "summary": "Send a trust ping to a connection", "produces": ["application/json"]}}, "/connections/{conn_id}/start-introduction": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/IntroModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "target_connection_id", "required": true, "type": "string", "description": "Target connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "message", "required": false, "type": "string", "description": "Message", "example": "Allow me to introduce ..."}], "tags": ["introduction"], "summary": "Start an introduction between two connections", "produces": ["application/json"]}}, "/credential-definitions": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrCredentialDefinitionSendResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CredentialDefinitionSendRequest"}}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["credential-definition"], "summary": "Sends a credential definition to the ledger", "produces": ["application/json"]}}, "/credential-definitions/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionsCreatedResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_def_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition id", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, {"in": "query", "name": "issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "schema_id", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, {"in": "query", "name": "schema_issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "schema_name", "required": false, "type": "string", "description": "Schema name", "example": "membership"}, {"in": "query", "name": "schema_version", "required": false, "type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}], "tags": ["credential-definition"], "summary": "Search for matching credential definitions that agent originated", "produces": ["application/json"]}}, "/credential-definitions/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["credential-definition"], "summary": "Gets a credential definition from the ledger", "produces": ["application/json"]}}, "/credential-definitions/{cred_def_id}/write_record": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["credential-definition"], "summary": "Writes a credential definition non-secret record to the wallet", "produces": ["application/json"]}}, "/credential/mime-types/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AttributeMimeTypesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Get attribute MIME types from wallet", "produces": ["application/json"]}}, "/credential/revoked/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevokedResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "from", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Earliest epoch of revocation status interval of interest", "example": "0"}, {"in": "query", "name": "to", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Latest epoch of revocation status interval of interest", "example": "0"}], "tags": ["credentials"], "summary": "Query credential revocation status by id", "produces": ["application/json"]}}, "/credential/w3c/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/VCRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Fetch W3C credential from wallet by id", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/HolderModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Remove W3C credential from wallet by id", "produces": ["application/json"]}}, "/credential/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/IndyCredInfo"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Fetch credential from wallet by id", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/HolderModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Remove credential from wallet by id", "produces": ["application/json"]}}, "/credentials": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredInfoList"}, "description": ""}}, "parameters": [{"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}, {"in": "query", "name": "wql", "required": false, "type": "string", "pattern": "^{.*}$", "description": "(JSON) WQL query", "example": "{\"attr::name::value\": \"Alex\"}"}], "tags": ["credentials"], "summary": "Fetch credentials from wallet", "produces": ["application/json"]}}, "/credentials/w3c": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/VCRecordList"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/W3CCredentialsListRequest"}}, {"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}, {"in": "query", "name": "wql", "required": false, "type": "string", "pattern": "^{.*}$", "description": "(JSON) WQL query", "example": "{\"attr::name::value\": \"Alex\"}"}], "tags": ["credentials"], "summary": "Fetch W3C credentials from wallet", "produces": ["application/json"]}}, "/didexchange/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "query", "name": "their_public_did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "Qualified public DID to which to request connection", "example": "did:peer:WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias for connection", "example": "Barry"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "query", "name": "my_label", "required": false, "type": "string", "description": "Label for connection request", "example": "Broker"}, {"in": "query", "name": "use_public_did", "required": false, "type": "boolean", "description": "Use public DID for this connection"}], "tags": ["did-exchange"], "summary": "Create and send a request against public DID's implicit invitation", "produces": ["application/json"]}}, "/didexchange/receive-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDXRequest"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias for connection", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}], "tags": ["did-exchange"], "summary": "Receive request against public DID's implicit invitation", "produces": ["application/json"]}}, "/didexchange/{conn_id}/accept-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "query", "name": "my_label", "required": false, "type": "string", "description": "Label for connection request", "example": "Broker"}], "tags": ["did-exchange"], "summary": "Accept a stored connection invitation", "produces": ["application/json"]}}, "/didexchange/{conn_id}/accept-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}], "tags": ["did-exchange"], "summary": "Accept a stored connection request", "produces": ["application/json"]}}, "/discover-features-2.0/queries": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20DiscoveryExchangeResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier, if none specified, then the query will provide features for this agent.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "query_goal_code", "required": false, "type": "string", "description": "Goal-code feature-type query", "example": "*"}, {"in": "query", "name": "query_protocol", "required": false, "type": "string", "description": "Protocol feature-type query", "example": "*"}], "tags": ["discover-features v2.0"], "summary": "Query supported features", "produces": ["application/json"]}}, "/discover-features-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20DiscoveryExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["discover-features v2.0"], "summary": "Discover Features v2.0 records", "produces": ["application/json"]}}, "/discover-features/query": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10DiscoveryExchangeResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "comment", "required": false, "type": "string", "description": "Comment", "example": "test"}, {"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier, if none specified, then the query will provide features for this agent.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "query", "required": false, "type": "string", "description": "Protocol feature query", "example": "*"}], "tags": ["discover-features"], "summary": "Query supported features", "produces": ["application/json"]}}, "/discover-features/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10DiscoveryExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["discover-features"], "summary": "Discover Features records", "produces": ["application/json"]}}, "/issue-credential-2.0/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20IssueCredSchemaCore"}}], "tags": ["issue-credential v2.0"], "summary": "Create credential from attribute values", "produces": ["application/json"]}}, "/issue-credential-2.0/create-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredOfferConnFreeRequest"}}], "tags": ["issue-credential v2.0"], "summary": "Create a credential offer, independent of any proposal or connection", "produces": ["application/json"]}}, "/issue-credential-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["issuer", "holder"], "description": "Role assigned in credential exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal-sent", "proposal-received", "offer-sent", "offer-received", "request-sent", "request-received", "credential-issued", "credential-received", "done", "credential-revoked", "abandoned"], "description": "Credential exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Fetch all credential exchange records", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Fetch a single credential exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Remove an existing credential exchange record", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/issue": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredIssueRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredIssueProblemReportRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send a problem report for credential exchange", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredBoundOfferRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential offer in reference to a proposal with preview", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredRequestRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential request", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/store": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredStoreRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v2.0"], "summary": "Store a received credential", "produces": ["application/json"]}}, "/issue-credential-2.0/send": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredExFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential, automating entire flow", "produces": ["application/json"]}}, "/issue-credential-2.0/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredOfferRequest"}}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential offer, independent of any proposal", "produces": ["application/json"]}}, "/issue-credential-2.0/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredExFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential proposal", "produces": ["application/json"]}}, "/issue-credential-2.0/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredRequestFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request", "produces": ["application/json"]}}, "/issue-credential/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialCreate"}}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential, automating entire flow", "produces": ["application/json"]}}, "/issue-credential/create-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialConnFreeOfferRequest"}}], "tags": ["issue-credential v1.0"], "summary": "Create a credential offer, independent of any proposal or connection", "produces": ["application/json"]}}, "/issue-credential/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["issuer", "holder"], "description": "Role assigned in credential exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal_sent", "proposal_received", "offer_sent", "offer_received", "request_sent", "request_received", "credential_issued", "credential_received", "credential_acked", "credential_revoked", "abandoned"], "description": "Credential exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Fetch all credential exchange records", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Fetch a single credential exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Remove an existing credential exchange record", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/issue": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialIssueRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProblemReportRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send a problem report for credential exchange", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialBoundOfferRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential offer in reference to a proposal with preview", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Send issuer a credential request", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/store": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialStoreRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential v1.0"], "summary": "Store a received credential", "produces": ["application/json"]}}, "/issue-credential/send": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProposalRequestMand"}}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential, automating entire flow", "produces": ["application/json"]}}, "/issue-credential/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialFreeOfferRequest"}}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential offer, independent of any proposal", "produces": ["application/json"]}}, "/issue-credential/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProposalRequestOpt"}}], "tags": ["issue-credential v1.0"], "summary": "Send issuer a credential proposal", "produces": ["application/json"]}}, "/jsonld/sign": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SignResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SignRequest"}}], "tags": ["jsonld"], "summary": "Sign a JSON-LD structure and return it", "produces": ["application/json"]}}, "/jsonld/verify": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/VerifyResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/VerifyRequest"}}], "tags": ["jsonld"], "summary": "Verify a JSON-LD structure.", "produces": ["application/json"]}}, "/ledger/did-endpoint": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetDIDEndpointResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "endpoint_type", "required": false, "type": "string", "enum": ["Endpoint", "Profile", "LinkedDomains"], "description": "Endpoint type of interest (default 'Endpoint')", "example": "Endpoint"}], "tags": ["ledger"], "summary": "Get the endpoint for a DID from the ledger.", "produces": ["application/json"]}}, "/ledger/did-verkey": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetDIDVerkeyResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["ledger"], "summary": "Get the verkey for a DID from the ledger.", "produces": ["application/json"]}}, "/ledger/get-nym-role": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetNymRoleResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["ledger"], "summary": "Get the role from the NYM registration of a public DID.", "produces": ["application/json"]}}, "/ledger/multiple/config": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerConfigList"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the multiple ledger configuration currently in use", "produces": ["application/json"]}}, "/ledger/multiple/get-write-ledger": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WriteLedgerRequest"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the current write ledger", "produces": ["application/json"]}}, "/ledger/register-nym": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrRegisterLedgerNymResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID to register", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "verkey", "required": true, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "reset"], "description": "Role"}], "tags": ["ledger"], "summary": "Send a NYM registration to the ledger.", "produces": ["application/json"]}}, "/ledger/rotate-public-did-keypair": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerModulesResult"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Rotate key pair for public DID.", "produces": ["application/json"]}}, "/ledger/taa": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TAAResult"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the current transaction author agreement, if any", "produces": ["application/json"]}}, "/ledger/taa/accept": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/TAAAccept"}}], "tags": ["ledger"], "summary": "Accept the transaction author agreement", "produces": ["application/json"]}}, "/mediation/default-mediator": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [], "tags": ["mediation"], "summary": "Get default mediator", "produces": ["application/json"]}, "delete": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [], "tags": ["mediation"], "summary": "Clear default mediator", "produces": ["application/json"]}}, "/mediation/keylists": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/Keylist"}, "description": ""}}, "parameters": [{"in": "query", "name": "conn_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier (optional)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "default": "server", "enum": ["client", "server"], "description": "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent"}], "tags": ["mediation"], "summary": "Retrieve keylists by connection or role", "produces": ["application/json"]}}, "/mediation/keylists/{mediation_id}/send-keylist-query": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/KeylistQuery"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/KeylistQueryFilterRequest"}}, {"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "paginate_limit", "required": false, "type": "integer", "format": "int32", "default": -1, "description": "limit number of results"}, {"in": "query", "name": "paginate_offset", "required": false, "type": "integer", "format": "int32", "default": 0, "description": "offset to use in pagination"}], "tags": ["mediation"], "summary": "Send keylist query to mediator", "produces": ["application/json"]}}, "/mediation/keylists/{mediation_id}/send-keylist-update": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/KeylistUpdate"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/KeylistUpdateRequest"}}, {"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Send keylist update to mediator", "produces": ["application/json"]}}, "/mediation/request/{conn_id}": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/MediationCreateRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Request mediation from connection", "produces": ["application/json"]}}, "/mediation/requests": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationList"}, "description": ""}}, "parameters": [{"in": "query", "name": "conn_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier (optional)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "mediator_terms", "required": false, "collectionFormat": "multi", "type": "array", "description": "List of mediator rules for recipient", "items": {"type": "string", "description": "Indicate terms to which the mediator requires the recipient to agree"}}, {"in": "query", "name": "recipient_terms", "required": false, "collectionFormat": "multi", "type": "array", "description": "List of recipient rules for mediation", "items": {"type": "string", "description": "Indicate terms to which the recipient requires the mediator to agree"}}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["request", "granted", "denied"], "description": "Mediation state (optional)", "example": "granted"}], "tags": ["mediation"], "summary": "Query mediation requests, returns list of all mediation records", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Retrieve mediation request record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Delete mediation request by ID", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}/deny": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationDeny"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/AdminMediationDeny"}}, {"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Deny a stored mediation request", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}/grant": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationGrant"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Grant received mediation", "produces": ["application/json"]}}, "/mediation/{mediation_id}/default-mediator": {"put": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "required": true, "type": "string", "format": "uuid", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["mediation"], "summary": "Set default mediator", "produces": ["application/json"]}}, "/multitenancy/wallet": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CreateWalletResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateWalletRequest"}}], "tags": ["multitenancy"], "summary": "Create a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "wallet_id", "required": true, "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["multitenancy"], "summary": "Get a single subwallet", "produces": ["application/json"]}, "put": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/UpdateWalletRequest"}}, {"in": "path", "name": "wallet_id", "required": true, "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["multitenancy"], "summary": "Update a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}/remove": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/MultitenantModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RemoveWalletRequest"}}, {"in": "path", "name": "wallet_id", "required": true, "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["multitenancy"], "summary": "Remove a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}/token": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CreateWalletTokenResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateWalletTokenRequest"}}, {"in": "path", "name": "wallet_id", "required": true, "type": "string"}], "tags": ["multitenancy"], "summary": "Get auth token for a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallets": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletList"}, "description": ""}}, "parameters": [{"in": "query", "name": "wallet_name", "required": false, "type": "string", "description": "Wallet name", "example": "MyNewWallet"}], "tags": ["multitenancy"], "summary": "Query subwallets", "produces": ["application/json"]}}, "/out-of-band/create-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/InvitationRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/InvitationCreateRequest"}}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "multi_use", "required": false, "type": "boolean", "description": "Create invitation for multiple use (default false)"}], "tags": ["out-of-band"], "summary": "Create a new connection invitation", "produces": ["application/json"]}}, "/out-of-band/receive-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/InvitationMessage"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias for connection", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}, {"in": "query", "name": "mediation_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "use_existing_connection", "required": false, "type": "boolean", "description": "Use an existing connection, if possible"}], "tags": ["out-of-band"], "summary": "Receive a new connection invitation", "produces": ["application/json"]}}, "/plugins": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminModules"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the list of loaded plugins", "produces": ["application/json"]}}, "/present-proof-2.0/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresCreateRequestRequest"}}], "tags": ["present-proof v2.0"], "summary": "Creates a presentation request not bound to any proposal or connection", "produces": ["application/json"]}}, "/present-proof-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecordList"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["prover", "verifier"], "description": "Role assigned in presentation exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal-sent", "proposal-received", "request-sent", "request-received", "presentation-sent", "presentation-received", "done", "abandoned"], "description": "Presentation exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Fetch all present-proof exchange records", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Fetch a single presentation exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Remove an existing presentation exchange record", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/credentials": {"get": {"responses": {"200": {"schema": {"type": "array", "items": {"$ref": "#/definitions/IndyCredPrecis"}}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "extra_query", "required": false, "type": "string", "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", "description": "(JSON) object mapping referents to extra WQL queries", "example": "{\"0_drink_uuid\": {\"attr::drink::value\": \"martini\"}}"}, {"in": "query", "name": "referent", "required": false, "type": "string", "description": "Proof request referents of interest, comma-separated", "example": "1_name_uuid,2_score_uuid"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}], "tags": ["present-proof v2.0"], "summary": "Fetch credentials from wallet for presentation request", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresProblemReportRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Send a problem report for presentation exchange", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/send-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresSpecByFormatRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Sends a proof presentation", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresentationSendRequestToProposal"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Sends a presentation request in reference to a proposal", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/verify-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v2.0"], "summary": "Verify a received presentation", "produces": ["application/json"]}}, "/present-proof-2.0/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresProposalRequest"}}], "tags": ["present-proof v2.0"], "summary": "Sends a presentation proposal", "produces": ["application/json"]}}, "/present-proof-2.0/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresSendRequestRequest"}}], "tags": ["present-proof v2.0"], "summary": "Sends a free presentation request not bound to any proposal", "produces": ["application/json"]}}, "/present-proof/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationCreateRequestRequest"}}], "tags": ["present-proof v1.0"], "summary": "Creates a presentation request not bound to any proposal or connection", "produces": ["application/json"]}}, "/present-proof/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchangeList"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "required": false, "type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["prover", "verifier"], "description": "Role assigned in presentation exchange"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["proposal_sent", "proposal_received", "request_sent", "request_received", "presentation_sent", "presentation_received", "verified", "presentation_acked", "abandoned"], "description": "Presentation exchange state"}, {"in": "query", "name": "thread_id", "required": false, "type": "string", "format": "uuid", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Fetch all present-proof exchange records", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Fetch a single presentation exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Remove an existing presentation exchange record", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/credentials": {"get": {"responses": {"200": {"schema": {"type": "array", "items": {"$ref": "#/definitions/IndyCredPrecis"}}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "count", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1"}, {"in": "query", "name": "extra_query", "required": false, "type": "string", "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", "description": "(JSON) object mapping referents to extra WQL queries", "example": "{\"0_drink_uuid\": {\"attr::drink::value\": \"martini\"}}"}, {"in": "query", "name": "referent", "required": false, "type": "string", "description": "Proof request referents of interest, comma-separated", "example": "1_name_uuid,2_score_uuid"}, {"in": "query", "name": "start", "required": false, "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0"}], "tags": ["present-proof v1.0"], "summary": "Fetch credentials for a presentation request from wallet", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationProblemReportRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Send a problem report for presentation exchange", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/send-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/IndyPresSpec"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Sends a proof presentation", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationSendRequestToProposal"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Sends a presentation request in reference to a proposal", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/verify-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof v1.0"], "summary": "Verify a received presentation", "produces": ["application/json"]}}, "/present-proof/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationProposalRequest"}}], "tags": ["present-proof v1.0"], "summary": "Sends a presentation proposal", "produces": ["application/json"]}}, "/present-proof/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationSendRequestRequest"}}], "tags": ["present-proof v1.0"], "summary": "Sends a free presentation request not bound to any proposal", "produces": ["application/json"]}}, "/resolver/resolve/{did}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ResolutionResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "did", "required": true, "type": "string", "pattern": "^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$", "description": "DID", "example": "did:ted:WgWxqztrNooG92RXvxSTWv"}], "tags": ["resolver"], "summary": "Retrieve doc for requested did", "produces": ["application/json"]}}, "/revocation/active-registry/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["revocation"], "summary": "Get current active revocation registry by credential definition id", "produces": ["application/json"]}}, "/revocation/clear-pending-revocations": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/PublishRevocations"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ClearPendingRevocationsRequest"}}], "tags": ["revocation"], "summary": "Clear pending revocations", "produces": ["application/json"]}}, "/revocation/create-registry": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevRegCreateRequest"}}], "tags": ["revocation"], "summary": "Creates a new revocation registry", "produces": ["application/json"]}}, "/revocation/credential-record": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevRecordResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_ex_id", "required": false, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "cred_rev_id", "required": false, "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Credential revocation identifier", "example": "12345"}, {"in": "query", "name": "rev_reg_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get credential revocation status", "produces": ["application/json"]}}, "/revocation/publish-revocations": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrPublishRevocationsResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PublishRevocations"}}], "tags": ["revocation"], "summary": "Publish pending revocations to ledger", "produces": ["application/json"]}}, "/revocation/registries/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegsCreated"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_def_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["init", "generated", "posted", "active", "full"], "description": "Revocation registry state"}], "tags": ["revocation"], "summary": "Search for matching revocation registries that current agent created", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get revocation registry by revocation registry id", "produces": ["application/json"]}, "patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevRegUpdateTailsFileUri"}}, {"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Update revocation registry with new public URI to its tails file", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/definition": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrRevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["revocation"], "summary": "Send revocation registry definition to ledger", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/entry": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["revocation"], "summary": "Send revocation registry entry to ledger", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/fix-revocation-entry-state": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegWalletUpdatedResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, {"in": "query", "name": "apply_ledger_update", "required": true, "type": "boolean", "description": "Apply updated accumulator transaction to ledger"}], "tags": ["revocation"], "summary": "Fix revocation state in wallet and return number of updated entries", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/issued": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegIssuedResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get number of credentials issued against revocation registry", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/issued/details": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevRecordDetailsResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get details of credentials issued against revocation registry", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/issued/indy_recs": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevIndyRecordsResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get details of revoked credentials from ledger", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/set-state": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, {"in": "query", "name": "state", "required": true, "type": "string", "enum": ["init", "generated", "posted", "active", "full"], "description": "Revocation registry state to set"}], "tags": ["revocation"], "summary": "Set revocation registry state manually", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/tails-file": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Upload local tails file to server", "produces": ["application/json"]}, "get": {"responses": {"200": {"schema": {"type": "string", "format": "binary"}, "description": "tails file"}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Download tails file", "produces": ["application/octet-stream"]}}, "/revocation/revoke": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevokeRequest"}}], "tags": ["revocation"], "summary": "Revoke an issued credential", "produces": ["application/json"]}}, "/schemas": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrSchemaSendResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SchemaSendRequest"}}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["schema"], "summary": "Sends a schema to the ledger", "produces": ["application/json"]}}, "/schemas/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemasCreatedResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "schema_id", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, {"in": "query", "name": "schema_issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "schema_name", "required": false, "type": "string", "description": "Schema name", "example": "membership"}, {"in": "query", "name": "schema_version", "required": false, "type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}], "tags": ["schema"], "summary": "Search for matching schema that agent originated", "produces": ["application/json"]}}, "/schemas/{schema_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemaGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "schema_id", "required": true, "type": "string", "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}], "tags": ["schema"], "summary": "Gets a schema from the ledger", "produces": ["application/json"]}}, "/schemas/{schema_id}/write_record": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemaGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "schema_id", "required": true, "type": "string", "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}], "tags": ["schema"], "summary": "Writes a schema non-secret record to the wallet", "produces": ["application/json"]}}, "/shutdown": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminShutdown"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Shut down server", "produces": ["application/json"]}}, "/status": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatus"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the server status", "produces": ["application/json"]}}, "/status/config": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminConfig"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the server configuration", "produces": ["application/json"]}}, "/status/live": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatusLiveliness"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Liveliness check", "produces": ["application/json"]}}, "/status/ready": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatusReadiness"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Readiness check", "produces": ["application/json"]}}, "/status/reset": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminReset"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Reset statistics", "produces": ["application/json"]}}, "/transaction/{tran_id}/resend": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Author to resend a particular transaction request", "produces": ["application/json"]}}, "/transactions": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionList"}, "description": ""}}, "parameters": [], "tags": ["endorse-transaction"], "summary": "Query transactions", "produces": ["application/json"]}}, "/transactions/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/Date"}}, {"in": "query", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "endorser_write_txn", "required": false, "type": "boolean", "description": "Endorser will write the transaction after endorsing it"}], "tags": ["endorse-transaction"], "summary": "For author to send a transaction request", "produces": ["application/json"]}}, "/transactions/{conn_id}/set-endorser-info": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/EndorserInfo"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "endorser_did", "required": true, "type": "string", "description": "Endorser DID"}, {"in": "query", "name": "endorser_name", "required": false, "type": "string", "description": "Endorser Name"}], "tags": ["endorse-transaction"], "summary": "Set Endorser Info", "produces": ["application/json"]}}, "/transactions/{conn_id}/set-endorser-role": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionJobs"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "transaction_my_job", "required": false, "type": "string", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "description": "Transaction related jobs"}], "tags": ["endorse-transaction"], "summary": "Set transaction jobs", "produces": ["application/json"]}}, "/transactions/{tran_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "Fetch a single transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/cancel": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Author to cancel a particular transaction request", "produces": ["application/json"]}}, "/transactions/{tran_id}/endorse": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "endorser_did", "required": false, "type": "string", "description": "Endorser DID"}], "tags": ["endorse-transaction"], "summary": "For Endorser to endorse a particular transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/refuse": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Endorser to refuse a particular transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/write": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "required": true, "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["endorse-transaction"], "summary": "For Author / Endorser to write an endorsed transaction to the ledger", "produces": ["application/json"]}}, "/wallet/did": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDList"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": false, "type": "string", "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$|^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "key_type", "required": false, "type": "string", "enum": ["ed25519", "bls12381g2"], "example": "ed25519", "description": "Key type to query for."}, {"in": "query", "name": "method", "required": false, "type": "string", "enum": ["key", "sov"], "example": "key", "description": "DID method to query for. e.g. sov to only fetch indy/sov DIDs"}, {"in": "query", "name": "posture", "required": false, "type": "string", "enum": ["public", "posted", "wallet_only"], "description": "Whether DID is current public DID, posted to ledger but current public DID, or local to the wallet", "example": "wallet_only"}, {"in": "query", "name": "verkey", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Verification key of interest", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}], "tags": ["wallet"], "summary": "List wallet DIDs", "produces": ["application/json"]}}, "/wallet/did/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDCreate"}}], "tags": ["wallet"], "summary": "Create a local DID", "produces": ["application/json"]}}, "/wallet/did/local/rotate-keypair": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["wallet"], "summary": "Rotate keypair for a DID not posted to the ledger", "produces": ["application/json"]}}, "/wallet/did/public": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [], "tags": ["wallet"], "summary": "Fetch the current public DID", "produces": ["application/json"]}, "post": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["wallet"], "summary": "Assign the current public DID", "produces": ["application/json"]}}, "/wallet/get-did-endpoint": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDEndpoint"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["wallet"], "summary": "Query DID endpoint in wallet", "produces": ["application/json"]}}, "/wallet/set-did-endpoint": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDEndpointWithType"}}, {"in": "query", "name": "conn_id", "required": false, "type": "string", "description": "Connection identifier"}, {"in": "query", "name": "create_transaction_for_endorser", "required": false, "type": "boolean", "description": "Create Transaction For Endorser's signature"}], "tags": ["wallet"], "summary": "Update endpoint in wallet and on ledger if posted to it", "produces": ["application/json"]}}}, "info": {"title": "Aries Cloud Agent", "version": "v0.7.4"}, "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": {"mediator_terms": {"description": "List of mediator rules for recipient", "items": {"description": "Indicate terms to which the mediator requires the recipient to agree", "type": "string"}, "type": "array"}, "recipient_terms": {"description": "List of recipient rules for mediation", "items": {"description": "Indicate terms to which the recipient requires the mediator to agree", "type": "string"}, "type": "array"}}, "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\"}", "type": "object"}, "jws": {"allOf": [{"$ref": "#/definitions/AttachDecoratorDataJWS"}], "description": "Detached Java Web Signature"}, "links": {"description": "List of hypertext links to data", "items": {"example": "https://link.to/data", "type": "string"}, "type": "array"}, "sha256": {"description": "SHA256 hash (binhex encoded) of content", "example": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb", "pattern": "^[a-fA-F0-9+/]{64}$", "type": "string"}}, "type": "object"}, "AttachDecoratorData1JWS": {"properties": {"header": {"$ref": "#/definitions/AttachDecoratorDataJWSHeader"}, "protected": {"description": "protected JWS header", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signature": {"description": "signature", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}}, "required": ["header", "signature"], "type": "object"}, "AttachDecoratorDataJWS": {"properties": {"header": {"$ref": "#/definitions/AttachDecoratorDataJWSHeader"}, "protected": {"description": "protected JWS header", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signature": {"description": "signature", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signatures": {"description": "List of signatures", "items": {"$ref": "#/definitions/AttachDecoratorData1JWS"}, "type": "array"}}, "type": "object"}, "AttachDecoratorDataJWSHeader": {"properties": {"kid": {"description": "Key identifier, in W3C did:key or DID URL format", "example": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4", "pattern": "^did:(?:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+|sov:[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}(;.*)?(\\?.*)?#.+)$", "type": "string"}}, "required": ["kid"], "type": "object"}, "AttachmentDef": {"properties": {"id": {"description": "Attachment identifier", "example": "attachment-0", "type": "string"}, "type": {"description": "Attachment type", "enum": ["credential-offer", "present-proof"], "example": "present-proof", "type": "string"}}, "type": "object"}, "AttributeMimeTypesResult": {"properties": {"results": {"additionalProperties": {"description": "MIME type", "type": "string"}, "type": "object", "x-nullable": true}}, "type": "object"}, "BasicMessageModuleResponse": {"properties": {}, "type": "object"}, "ClaimFormat": {"properties": {"jwt": {"type": "object"}, "jwt_vc": {"type": "object"}, "jwt_vp": {"type": "object"}, "ldp": {"type": "object"}, "ldp_vc": {"type": "object"}, "ldp_vp": {"type": "object"}}, "type": "object"}, "ClearPendingRevocationsRequest": {"properties": {"purge": {"additionalProperties": {"items": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "type": "array"}, "description": "Credential revocation ids by revocation registry id: omit for all, specify null or empty list for all pending per revocation registry", "type": "object"}}, "type": "object"}, "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"}, "routing_state": {"description": "Routing state of connection", "enum": ["none", "request", "active", "error"], "example": "active", "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": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "imageUrl": {"description": "Optional image URL for connection invitation", "example": "http://192.168.56.101/img/logo.jpg", "format": "url", "type": "string", "x-nullable": true}, "label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipientKeys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routingKeys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "serviceEndpoint": {"description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020", "type": "string"}}, "type": "object"}, "ConnectionList": {"properties": {"results": {"description": "List of connection records", "items": {"$ref": "#/definitions/ConnRecord"}, "type": "array"}}, "type": "object"}, "ConnectionMetadata": {"properties": {"results": {"description": "Dictionary of metadata associated with connection.", "type": "object"}}, "type": "object"}, "ConnectionMetadataSetRequest": {"properties": {"metadata": {"description": "Dictionary of metadata to set for connection.", "type": "object"}}, "required": ["metadata"], "type": "object"}, "ConnectionModuleResponse": {"properties": {}, "type": "object"}, "ConnectionStaticRequest": {"properties": {"alias": {"description": "Alias to assign to this connection", "type": "string"}, "my_did": {"description": "Local DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "my_seed": {"description": "Seed to use for the local DID", "type": "string"}, "their_did": {"description": "Remote DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "their_endpoint": {"description": "URL endpoint for other party", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "their_label": {"description": "Other party's label for this connection", "type": "string"}, "their_seed": {"description": "Seed to use for the remote DID", "type": "string"}, "their_verkey": {"description": "Remote verification key", "type": "string"}}, "type": "object"}, "ConnectionStaticResult": {"properties": {"my_did": {"description": "Local DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "my_endpoint": {"description": "My URL endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "my_verkey": {"description": "My verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "record": {"$ref": "#/definitions/ConnRecord"}, "their_did": {"description": "Remote DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "their_verkey": {"description": "Remote verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}}, "required": ["my_did", "my_endpoint", "my_verkey", "record", "their_did", "their_verkey"], "type": "object"}, "Constraints": {"properties": {"fields": {"items": {"$ref": "#/definitions/DIFField"}, "type": "array"}, "is_holder": {"items": {"$ref": "#/definitions/DIFHolder"}, "type": "array"}, "limit_disclosure": {"description": "LimitDisclosure", "type": "string"}, "status_active": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "status_revoked": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "status_suspended": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "subject_is_issuer": {"description": "SubjectIsIssuer", "enum": ["required", "preferred"], "type": "string"}}, "type": "object"}, "CreateInvitationRequest": {"properties": {"mediation_id": {"description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "metadata": {"description": "Optional metadata to attach to the connection created with the invitation", "type": "object"}, "my_label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipient_keys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routing_keys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "service_endpoint": {"description": "Connection endpoint", "example": "http://192.168.56.102:8020", "type": "string"}}, "type": "object"}, "CreateWalletRequest": {"properties": {"image_url": {"description": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", "example": "https://aries.ca/images/sample.png", "type": "string"}, "key_management_mode": {"description": "Key management method to use for this wallet.", "enum": ["managed"], "example": "managed", "type": "string"}, "label": {"description": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", "example": "Alice", "type": "string"}, "wallet_dispatch_type": {"description": "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", "enum": ["default", "both", "base"], "example": "default", "type": "string"}, "wallet_key": {"description": "Master key used for key derivation.", "example": "MySecretKey123", "type": "string"}, "wallet_key_derivation": {"description": "Key derivation", "enum": ["ARGON2I_MOD", "ARGON2I_INT", "RAW"], "example": "RAW", "type": "string"}, "wallet_name": {"description": "Wallet name", "example": "MyNewWallet", "type": "string"}, "wallet_type": {"description": "Type of the wallet to create", "enum": ["askar", "in_memory", "indy"], "example": "indy", "type": "string"}, "wallet_webhook_urls": {"description": "List of Webhook URLs associated with this subwallet", "items": {"description": "Optional webhook URL to receive webhook messages", "example": "http://localhost:8022/webhooks", "type": "string"}, "type": "array"}}, "type": "object"}, "CreateWalletResponse": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "key_management_mode": {"description": "Mode regarding management of wallet key", "enum": ["managed", "unmanaged"], "type": "string"}, "settings": {"description": "Settings for this wallet.", "type": "object"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "token": {"description": "Authorization token to authenticate wallet requests", "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "wallet_id": {"description": "Wallet record ID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["key_management_mode", "wallet_id"], "type": "object"}, "CreateWalletTokenRequest": {"properties": {"wallet_key": {"description": "Master key used for key derivation. Only required for unamanged wallets.", "example": "MySecretKey123", "type": "string"}}, "type": "object"}, "CreateWalletTokenResponse": {"properties": {"token": {"description": "Authorization token to authenticate wallet requests", "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", "type": "string"}}, "type": "object"}, "CredAttrSpec": {"properties": {"mime-type": {"description": "MIME type: omit for (null) default", "example": "image/jpeg", "type": "string", "x-nullable": true}, "name": {"description": "Attribute name", "example": "favourite_drink", "type": "string"}, "value": {"description": "Attribute value: base64-encode if MIME type is present", "example": "martini", "type": "string"}}, "required": ["name", "value"], "type": "object"}, "CredDefValue": {"properties": {"primary": {"allOf": [{"$ref": "#/definitions/CredDefValuePrimary"}], "description": "Primary value for credential definition"}, "revocation": {"allOf": [{"$ref": "#/definitions/CredDefValueRevocation"}], "description": "Revocation value for credential definition"}}, "type": "object"}, "CredDefValuePrimary": {"properties": {"n": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "r": {"$ref": "#/definitions/Generated"}, "rctxt": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "s": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "z": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "CredDefValueRevocation": {"properties": {"g": {"example": "1 1F14F&ECB578F 2 095E45DDF417D", "type": "string"}, "g_dash": {"example": "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D", "type": "string"}, "h": {"example": "1 16675DAE54BFAE8 2 095E45DD417D", "type": "string"}, "h0": {"example": "1 21E5EF9476EAF18 2 095E45DDF417D", "type": "string"}, "h1": {"example": "1 236D1D99236090 2 095E45DDF417D", "type": "string"}, "h2": {"example": "1 1C3AE8D1F1E277 2 095E45DDF417D", "type": "string"}, "h_cap": {"example": "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000", "type": "string"}, "htilde": {"example": "1 1D8549E8C0F8 2 095E45DDF417D", "type": "string"}, "pk": {"example": "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D", "type": "string"}, "u": {"example": "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000", "type": "string"}, "y": {"example": "1 153558BD903312 2 095E45DDF417D 1 0000000000000000", "type": "string"}}, "type": "object"}, "CredInfoList": {"properties": {"results": {"items": {"$ref": "#/definitions/IndyCredInfo"}, "type": "array"}}, "type": "object"}, "CredRevIndyRecordsResult": {"properties": {"rev_reg_delta": {"description": "Indy revocation registry delta", "type": "object"}}, "type": "object"}, "CredRevRecordDetailsResult": {"properties": {"results": {"items": {"$ref": "#/definitions/IssuerCredRevRecord"}, "type": "array"}}, "type": "object"}, "CredRevRecordResult": {"properties": {"result": {"$ref": "#/definitions/IssuerCredRevRecord"}}, "type": "object"}, "CredRevokedResult": {"properties": {"revoked": {"description": "Whether credential is revoked on the ledger", "type": "boolean"}}, "type": "object"}, "Credential": {"properties": {"@context": {"description": "The JSON-LD context of the credential", "example": ["https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"], "items": {}, "type": "array"}, "credentialSubject": {"example": {"alumniOf": {"id": "did:example:c276e12ec21ebfeb1f712ebc6f1"}, "id": "did:example:ebfeb1f712ebc6f1c276e12ec21"}}, "expirationDate": {"description": "The expiration date", "example": "2010-01-01T19:23:24Z", "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", "type": "string"}, "id": {"example": "http://example.edu/credentials/1872", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}, "issuanceDate": {"description": "The issuance date", "example": "2010-01-01T19:23:24Z", "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", "type": "string"}, "issuer": {"description": "The JSON-LD Verifiable Credential Issuer. Either string of object with id field.", "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"}, "proof": {"allOf": [{"$ref": "#/definitions/LinkedDataProof"}], "description": "The proof of the credential", "example": {"created": "2019-12-11T03:50:55", "jws": "eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ", "proofPurpose": "assertionMethod", "type": "Ed25519Signature2018", "verificationMethod": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"}}, "type": {"description": "The JSON-LD type of the credential", "example": ["VerifiableCredential", "AlumniCredential"], "items": {"type": "string"}, "type": "array"}}, "required": ["@context", "credentialSubject", "issuanceDate", "issuer", "type"], "type": "object"}, "CredentialDefinition": {"properties": {"id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "schemaId": {"description": "Schema identifier within credential definition identifier", "example": "20", "type": "string"}, "tag": {"description": "Tag within credential definition identifier", "example": "tag", "type": "string"}, "type": {"default": "CL", "description": "Signature type: CL for Camenisch-Lysyanskaya", "example": "CL"}, "value": {"allOf": [{"$ref": "#/definitions/CredDefValue"}], "description": "Credential definition primary and revocation values"}, "ver": {"description": "Node protocol version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "CredentialDefinitionGetResult": {"properties": {"credential_definition": {"$ref": "#/definitions/CredentialDefinition"}}, "type": "object"}, "CredentialDefinitionSendRequest": {"properties": {"revocation_registry_size": {"description": "Revocation registry size", "example": 1000, "format": "int32", "maximum": 32768, "minimum": 4, "type": "integer"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "support_revocation": {"description": "Revocation supported flag", "type": "boolean"}, "tag": {"description": "Credential definition identifier tag", "example": "default", "type": "string"}}, "type": "object"}, "CredentialDefinitionSendResult": {"properties": {"credential_definition_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}}, "type": "object"}, "CredentialDefinitionsCreatedResult": {"properties": {"credential_definition_ids": {"items": {"description": "Credential definition identifiers", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "type": "array"}}, "type": "object"}, "CredentialOffer": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"$ref": "#/definitions/CredentialPreview"}, "offers~attach": {"items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["offers~attach"], "type": "object"}, "CredentialPreview": {"properties": {"@type": {"description": "Message type identifier", "example": "issue-credential/1.0/credential-preview", "type": "string"}, "attributes": {"items": {"$ref": "#/definitions/CredAttrSpec"}, "type": "array"}}, "required": ["attributes"], "type": "object"}, "CredentialProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "cred_def_id": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "issuer_did": {"example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"type": "string"}, "schema_version": {"example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "CredentialStatusOptions": {"properties": {"type": {"description": "Credential status method type to use for the credential. Should match status method registered in the Verifiable Credential Extension Registry", "example": "CredentialStatusList2017", "type": "string"}}, "required": ["type"], "type": "object"}, "DID": {"properties": {"did": {"description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$|^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "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", "enum": ["sov", "key"], "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": {"enum": ["key", "sov"], "example": "sov", "type": "string"}, "options": {"allOf": [{"$ref": "#/definitions/DIDCreateOptions"}], "description": "To define a key type for a did:key"}}, "type": "object"}, "DIDCreateOptions": {"properties": {"key_type": {"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"}, "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": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "did_doc~attach": {"allOf": [{"$ref": "#/definitions/AttachDecorator"}], "description": "As signed attachment, DID Doc associated with DID"}, "label": {"description": "Label for DID exchange request", "example": "Request to connect with Bob", "type": "string"}}, "required": ["label"], "type": "object"}, "DIFField": {"properties": {"filter": {"$ref": "#/definitions/Filter"}, "id": {"description": "ID", "type": "string"}, "path": {"items": {"description": "Path", "type": "string"}, "type": "array"}, "predicate": {"description": "Preference", "enum": ["required", "preferred"], "type": "string"}, "purpose": {"description": "Purpose", "type": "string"}}, "type": "object"}, "DIFHolder": {"properties": {"directive": {"description": "Preference", "enum": ["required", "preferred"], "type": "string"}, "field_id": {"items": {"description": "FieldID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "type": "array"}}, "type": "object"}, "DIFOptions": {"properties": {"challenge": {"description": "Challenge protect against replay attack", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "domain": {"description": "Domain protect against replay attack", "example": "4jt78h47fh47", "type": "string"}}, "type": "object"}, "DIFPresSpec": {"properties": {"issuer_id": {"description": "Issuer identifier to sign the presentation, if different from current public DID", "type": "string"}, "presentation_definition": {"$ref": "#/definitions/PresentationDefinition"}, "record_ids": {"description": "Mapping of input_descriptor id to list of stored W3C credential record_id", "example": {"": ["", ""], "": [""]}, "type": "object"}, "reveal_doc": {"description": "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", "example": {"@context": ["https://www.w3.org/2018/credentials/v1", "https://w3id.org/security/bbs/v1"], "@explicit": true, "@requireAll": true, "credentialSubject": {"@explicit": true, "@requireAll": true, "Observation": [{"effectiveDateTime": {}, "@explicit": true, "@requireAll": true}]}, "issuanceDate": {}, "issuer": {}, "type": ["VerifiableCredential", "LabReport"]}, "type": "object"}}, "type": "object"}, "DIFProofProposal": {"properties": {"input_descriptors": {"items": {"$ref": "#/definitions/InputDescriptors"}, "type": "array"}, "options": {"$ref": "#/definitions/DIFOptions"}}, "type": "object"}, "DIFProofRequest": {"properties": {"options": {"$ref": "#/definitions/DIFOptions"}, "presentation_definition": {"$ref": "#/definitions/PresentationDefinition"}}, "required": ["presentation_definition"], "type": "object"}, "Date": {"properties": {"expires_time": {"description": "Expiry Date", "example": "2021-03-29T05:22:19Z", "format": "date-time", "type": "string"}}, "required": ["expires_time"], "type": "object"}, "Disclose": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "protocols": {"description": "List of protocol descriptors", "items": {"$ref": "#/definitions/ProtocolDescriptor"}, "type": "array"}}, "required": ["protocols"], "type": "object"}, "Disclosures": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "disclosures": {"description": "List of protocol or goal_code descriptors", "items": {}, "type": "array"}}, "required": ["disclosures"], "type": "object"}, "Doc": {"properties": {"credential": {"description": "Credential to sign", "type": "object"}, "options": {"allOf": [{"$ref": "#/definitions/SignatureOptions"}], "description": "Signature options"}}, "required": ["credential", "options"], "type": "object"}, "EndorserInfo": {"properties": {"endorser_did": {"description": "Endorser DID", "type": "string"}, "endorser_name": {"description": "Endorser Name", "type": "string"}}, "required": ["endorser_did"], "type": "object"}, "EndpointsResult": {"properties": {"my_endpoint": {"description": "My endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "their_endpoint": {"description": "Their endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}}, "type": "object"}, "Filter": {"properties": {"const": {"description": "Const"}, "enum": {"items": {"description": "Enum"}, "type": "array"}, "exclusiveMaximum": {"description": "ExclusiveMaximum"}, "exclusiveMinimum": {"description": "ExclusiveMinimum"}, "format": {"description": "Format", "type": "string"}, "maxLength": {"description": "Max Length", "example": 1234, "format": "int32", "type": "integer"}, "maximum": {"description": "Maximum"}, "minLength": {"description": "Min Length", "example": 1234, "format": "int32", "type": "integer"}, "minimum": {"description": "Minimum"}, "not": {"description": "Not", "example": false, "type": "boolean"}, "pattern": {"description": "Pattern", "type": "string"}, "type": {"description": "Type", "type": "string"}}, "type": "object"}, "Generated": {"properties": {"master_secret": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "number": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "remainder": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "GetDIDEndpointResponse": {"properties": {"endpoint": {"description": "Full verification key", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string", "x-nullable": true}}, "type": "object"}, "GetDIDVerkeyResponse": {"properties": {"verkey": {"description": "Full verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string", "x-nullable": true}}, "type": "object"}, "GetNymRoleResponse": {"properties": {"role": {"description": "Ledger role", "enum": ["STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "USER", "ROLE_REMOVE"], "example": "ENDORSER", "type": "string"}}, "type": "object"}, "HolderModuleResponse": {"properties": {}, "type": "object"}, "IndyAttrValue": {"properties": {"encoded": {"description": "Attribute encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Attribute raw value", "type": "string"}}, "required": ["encoded", "raw"], "type": "object"}, "IndyCredAbstract": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "key_correctness_proof": {"allOf": [{"$ref": "#/definitions/IndyKeyCorrectnessProof"}], "description": "Key correctness proof"}, "nonce": {"description": "Nonce in credential abstract", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "required": ["cred_def_id", "key_correctness_proof", "nonce", "schema_id"], "type": "object"}, "IndyCredInfo": {"properties": {"attrs": {"additionalProperties": {"example": "alice", "type": "string"}, "description": "Attribute names and value", "type": "object"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string", "x-nullable": true}, "referent": {"description": "Wallet referent", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyCredPrecis": {"properties": {"cred_info": {"allOf": [{"$ref": "#/definitions/IndyCredInfo"}], "description": "Credential info"}, "interval": {"allOf": [{"$ref": "#/definitions/IndyNonRevocationInterval"}], "description": "Non-revocation interval from presentation request"}, "presentation_referents": {"items": {"description": "presentation referent", "example": "1_age_uuid", "type": "string"}, "type": "array"}}, "type": "object"}, "IndyCredRequest": {"properties": {"blinded_ms": {"description": "Blinded master secret", "type": "object"}, "blinded_ms_correctness_proof": {"description": "Blinded master secret correctness proof", "type": "object"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "nonce": {"description": "Nonce in credential request", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "prover_did": {"description": "Prover DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}}, "required": ["blinded_ms", "blinded_ms_correctness_proof", "cred_def_id", "nonce"], "type": "object"}, "IndyCredential": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "rev_reg": {"description": "Revocation registry state", "type": "object", "x-nullable": true}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "signature": {"description": "Credential signature", "type": "object"}, "signature_correctness_proof": {"description": "Credential signature correctness proof", "type": "object"}, "values": {"additionalProperties": {"allOf": [{"$ref": "#/definitions/IndyAttrValue"}], "description": "Attribute value"}, "description": "Credential attributes", "type": "object"}, "witness": {"description": "Witness for revocation proof", "type": "object", "x-nullable": true}}, "required": ["cred_def_id", "schema_id", "signature", "signature_correctness_proof", "values"], "type": "object"}, "IndyEQProof": {"properties": {"a_prime": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "e": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "m": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "m2": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "revealed_attrs": {"additionalProperties": {"example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "type": "object"}, "v": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "IndyGEProof": {"properties": {"alpha": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "mj": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "predicate": {"$ref": "#/definitions/IndyGEProofPred"}, "r": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "t": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "u": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}}, "type": "object"}, "IndyGEProofPred": {"properties": {"attr_name": {"description": "Attribute name, indy-canonicalized", "type": "string"}, "p_type": {"description": "Predicate type", "enum": ["LT", "LE", "GE", "GT"], "type": "string"}, "value": {"description": "Predicate threshold value", "format": "int32", "type": "integer"}}, "type": "object"}, "IndyKeyCorrectnessProof": {"properties": {"c": {"description": "c in key correctness proof", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "xr_cap": {"description": "xr_cap in key correctness proof", "items": {"description": "xr_cap components in key correctness proof", "items": {"description": "xr_cap component values in key correctness proof", "type": "string"}, "type": "array"}, "type": "array"}, "xz_cap": {"description": "xz_cap in key correctness proof", "example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "required": ["c", "xr_cap", "xz_cap"], "type": "object"}, "IndyNonRevocProof": {"properties": {"c_list": {"additionalProperties": {"type": "string"}, "type": "object"}, "x_list": {"additionalProperties": {"type": "string"}, "type": "object"}}, "type": "object"}, "IndyNonRevocationInterval": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyPresAttrSpec": {"properties": {"cred_def_id": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "mime-type": {"description": "MIME type (default null)", "example": "image/jpeg", "type": "string"}, "name": {"description": "Attribute name", "example": "favourite_drink", "type": "string"}, "referent": {"description": "Credential referent", "example": "0", "type": "string"}, "value": {"description": "Attribute value", "example": "martini", "type": "string"}}, "required": ["name"], "type": "object"}, "IndyPresPredSpec": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "name": {"description": "Attribute name", "example": "high_score", "type": "string"}, "predicate": {"description": "Predicate type ('<', '<=', '>=', or '>')", "enum": ["<", "<=", ">=", ">"], "example": ">=", "type": "string"}, "threshold": {"description": "Threshold value", "format": "int32", "type": "integer"}}, "required": ["name", "predicate", "threshold"], "type": "object"}, "IndyPresPreview": {"properties": {"@type": {"description": "Message type identifier", "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/present-proof/1.0/presentation-preview", "type": "string"}, "attributes": {"items": {"$ref": "#/definitions/IndyPresAttrSpec"}, "type": "array"}, "predicates": {"items": {"$ref": "#/definitions/IndyPresPredSpec"}, "type": "array"}}, "required": ["attributes", "predicates"], "type": "object"}, "IndyPresSpec": {"properties": {"requested_attributes": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedAttr"}, "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers", "type": "object"}, "requested_predicates": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedPred"}, "description": "Nested object mapping proof request predicate referents to requested-predicate specifiers", "type": "object"}, "self_attested_attributes": {"additionalProperties": {"description": "Self-attested attribute values to use in requested-credentials structure for proof construction", "example": "self_attested_value", "type": "string"}, "description": "Self-attested attributes to build into proof", "type": "object"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["requested_attributes", "requested_predicates", "self_attested_attributes"], "type": "object"}, "IndyPrimaryProof": {"properties": {"eq_proof": {"allOf": [{"$ref": "#/definitions/IndyEQProof"}], "description": "Indy equality proof", "x-nullable": true}, "ge_proofs": {"description": "Indy GE proofs", "items": {"$ref": "#/definitions/IndyGEProof"}, "type": "array", "x-nullable": true}}, "type": "object"}, "IndyProof": {"properties": {"identifiers": {"description": "Indy proof.identifiers content", "items": {"$ref": "#/definitions/IndyProofIdentifier"}, "type": "array"}, "proof": {"allOf": [{"$ref": "#/definitions/IndyProofProof"}], "description": "Indy proof.proof content"}, "requested_proof": {"allOf": [{"$ref": "#/definitions/IndyProofRequestedProof"}], "description": "Indy proof.requested_proof content"}}, "type": "object"}, "IndyProofIdentifier": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "timestamp": {"description": "Timestamp epoch", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer", "x-nullable": true}}, "type": "object"}, "IndyProofProof": {"properties": {"aggregated_proof": {"allOf": [{"$ref": "#/definitions/IndyProofProofAggregatedProof"}], "description": "Indy proof aggregated proof"}, "proofs": {"description": "Indy proof proofs", "items": {"$ref": "#/definitions/IndyProofProofProofsProof"}, "type": "array"}}, "type": "object"}, "IndyProofProofAggregatedProof": {"properties": {"c_hash": {"description": "c_hash value", "type": "string"}, "c_list": {"description": "c_list value", "items": {"items": {"format": "int32", "type": "integer"}, "type": "array"}, "type": "array"}}, "type": "object"}, "IndyProofProofProofsProof": {"properties": {"non_revoc_proof": {"allOf": [{"$ref": "#/definitions/IndyNonRevocProof"}], "description": "Indy non-revocation proof", "x-nullable": true}, "primary_proof": {"allOf": [{"$ref": "#/definitions/IndyPrimaryProof"}], "description": "Indy primary proof"}}, "type": "object"}, "IndyProofReqAttrSpec": {"properties": {"name": {"description": "Attribute name", "example": "favouriteDrink", "type": "string"}, "names": {"description": "Attribute name group", "items": {"example": "age", "type": "string"}, "type": "array"}, "non_revoked": {"allOf": [{"$ref": "#/definitions/IndyProofReqAttrSpecNonRevoked"}], "x-nullable": true}, "restrictions": {"description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "items": {"additionalProperties": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "type": "string"}, "type": "object"}, "type": "array"}}, "type": "object"}, "IndyProofReqAttrSpecNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofReqPredSpec": {"properties": {"name": {"description": "Attribute name", "example": "index", "type": "string"}, "non_revoked": {"allOf": [{"$ref": "#/definitions/IndyProofReqPredSpecNonRevoked"}], "x-nullable": true}, "p_type": {"description": "Predicate type ('<', '<=', '>=', or '>')", "enum": ["<", "<=", ">=", ">"], "example": ">=", "type": "string"}, "p_value": {"description": "Threshold value", "format": "int32", "type": "integer"}, "restrictions": {"description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "items": {"additionalProperties": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "type": "string"}, "type": "object"}, "type": "array"}}, "required": ["name", "p_type", "p_value"], "type": "object"}, "IndyProofReqPredSpecNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofRequest": {"properties": {"name": {"description": "Proof request name", "example": "Proof request", "type": "string"}, "non_revoked": {"allOf": [{"$ref": "#/definitions/IndyProofRequestNonRevoked"}], "x-nullable": true}, "nonce": {"description": "Nonce", "example": "1", "pattern": "^[1-9][0-9]*$", "type": "string"}, "requested_attributes": {"additionalProperties": {"$ref": "#/definitions/IndyProofReqAttrSpec"}, "description": "Requested attribute specifications of proof request", "type": "object"}, "requested_predicates": {"additionalProperties": {"$ref": "#/definitions/IndyProofReqPredSpec"}, "description": "Requested predicate specifications of proof request", "type": "object"}, "version": {"description": "Proof request version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "required": ["requested_attributes", "requested_predicates"], "type": "object"}, "IndyProofRequestNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofRequestedProof": {"properties": {"predicates": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofPredicate"}, "description": "Proof requested proof predicates.", "type": "object"}, "revealed_attr_groups": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofRevealedAttrGroup"}, "description": "Proof requested proof revealed attribute groups", "type": "object", "x-nullable": true}, "revealed_attrs": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofRevealedAttr"}, "description": "Proof requested proof revealed attributes", "type": "object", "x-nullable": true}, "self_attested_attrs": {"description": "Proof requested proof self-attested attributes", "type": "object"}, "unrevealed_attrs": {"description": "Unrevealed attributes", "type": "object"}}, "type": "object"}, "IndyProofRequestedProofPredicate": {"properties": {"sub_proof_index": {"description": "Sub-proof index", "format": "int32", "type": "integer"}}, "type": "object"}, "IndyProofRequestedProofRevealedAttr": {"properties": {"encoded": {"description": "Encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Raw value", "type": "string"}, "sub_proof_index": {"description": "Sub-proof index", "format": "int32", "type": "integer"}}, "type": "object"}, "IndyProofRequestedProofRevealedAttrGroup": {"properties": {"sub_proof_index": {"description": "Sub-proof index", "format": "int32", "type": "integer"}, "values": {"additionalProperties": {"$ref": "#/definitions/RawEncoded"}, "description": "Indy proof requested proof revealed attr groups group value", "type": "object"}}, "type": "object"}, "IndyRequestedCredsRequestedAttr": {"properties": {"cred_id": {"description": "Wallet credential identifier (typically but not necessarily a UUID)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "revealed": {"description": "Whether to reveal attribute in proof (default true)", "type": "boolean"}}, "required": ["cred_id"], "type": "object"}, "IndyRequestedCredsRequestedPred": {"properties": {"cred_id": {"description": "Wallet credential identifier (typically but not necessarily a UUID)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "timestamp": {"description": "Epoch timestamp of interest for non-revocation proof", "example": 1640995199, "format": "int32", "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "required": ["cred_id"], "type": "object"}, "IndyRevRegDef": {"properties": {"credDefId": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "id": {"description": "Indy revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "revocDefType": {"description": "Revocation registry type (specify CL_ACCUM)", "enum": ["CL_ACCUM"], "example": "CL_ACCUM", "type": "string"}, "tag": {"description": "Revocation registry tag", "type": "string"}, "value": {"allOf": [{"$ref": "#/definitions/IndyRevRegDefValue"}], "description": "Revocation registry definition value"}, "ver": {"description": "Version of revocation registry definition", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyRevRegDefValue": {"properties": {"issuanceType": {"description": "Issuance type", "enum": ["ISSUANCE_ON_DEMAND", "ISSUANCE_BY_DEFAULT"], "type": "string"}, "maxCredNum": {"description": "Maximum number of credentials; registry size", "example": 10, "format": "int32", "minimum": 1, "type": "integer"}, "publicKeys": {"allOf": [{"$ref": "#/definitions/IndyRevRegDefValuePublicKeys"}], "description": "Public keys"}, "tailsHash": {"description": "Tails hash value", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "tailsLocation": {"description": "Tails file location", "type": "string"}}, "type": "object"}, "IndyRevRegDefValuePublicKeys": {"properties": {"accumKey": {"$ref": "#/definitions/IndyRevRegDefValuePublicKeysAccumKey"}}, "type": "object"}, "IndyRevRegDefValuePublicKeysAccumKey": {"properties": {"z": {"description": "Value for z", "example": "1 120F522F81E6B7 1 09F7A59005C4939854", "type": "string"}}, "type": "object"}, "IndyRevRegEntry": {"properties": {"value": {"allOf": [{"$ref": "#/definitions/IndyRevRegEntryValue"}], "description": "Revocation registry entry value"}, "ver": {"description": "Version of revocation registry entry", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyRevRegEntryValue": {"properties": {"accum": {"description": "Accumulator value", "example": "21 11792B036AED0AAA12A4 4 298B2571FFC63A737", "type": "string"}, "prevAccum": {"description": "Previous accumulator value", "example": "21 137AC810975E4 6 76F0384B6F23", "type": "string"}, "revoked": {"description": "Revoked credential revocation identifiers", "items": {"format": "int32", "type": "integer"}, "type": "array"}}, "type": "object"}, "InputDescriptors": {"properties": {"constraints": {"$ref": "#/definitions/Constraints"}, "group": {"items": {"description": "Group", "type": "string"}, "type": "array"}, "id": {"description": "ID", "type": "string"}, "metadata": {"description": "Metadata dictionary", "type": "object"}, "name": {"description": "Name", "type": "string"}, "purpose": {"description": "Purpose", "type": "string"}, "schema": {"allOf": [{"$ref": "#/definitions/SchemasInputDescriptorFilter"}], "description": "Accepts a list of schema or a dict containing filters like oneof_filter.", "example": {"oneof_filter": [[{"uri": "https://www.w3.org/Test1#Test1"}, {"uri": "https://www.w3.org/Test2#Test2"}], {"oneof_filter": [[{"uri": "https://www.w3.org/Test1#Test1"}], [{"uri": "https://www.w3.org/Test2#Test2"}]]}]}}}, "type": "object"}, "IntroModuleResponse": {"properties": {}, "type": "object"}, "InvitationCreateRequest": {"properties": {"alias": {"description": "Alias for connection", "example": "Barry", "type": "string"}, "attachments": {"description": "Optional invitation attachments", "items": {"$ref": "#/definitions/AttachmentDef"}, "type": "array"}, "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"}, "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", "readOnly": true, "type": "string"}, "handshake_protocols": {"items": {"description": "Handshake protocol", "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0", "type": "string"}, "type": "array"}, "label": {"description": "Optional label", "example": "Bob", "type": "string"}, "requests~attach": {"description": "Optional request attachment", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}, "services": {"example": [{"did": "WgWxqztrNooG92RXvxSTWv", "id": "string", "recipientKeys": ["did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"], "routingKeys": ["did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"], "serviceEndpoint": "http://192.168.56.101:8020", "type": "string"}, "did:sov:WgWxqztrNooG92RXvxSTWv"], "items": {"description": "Either a DIDComm service object (as per RFC0067) or a DID string."}, "type": "array"}}, "type": "object"}, "InvitationRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "invi_msg_id": {"description": "Invitation message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation": {"allOf": [{"$ref": "#/definitions/InvitationMessage"}], "description": "Out of band invitation message"}, "invitation_id": {"description": "Invitation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation_url": {"description": "Invitation message URL", "example": "https://example.com/endpoint?c_i=eyJAdHlwZSI6ICIuLi4iLCAiLi4uIjogIi4uLiJ9XX0=", "type": "string"}, "oob_id": {"description": "Out of band record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "state": {"description": "Out of band message exchange state", "example": "await_response", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "InvitationResult": {"properties": {"connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation": {"$ref": "#/definitions/ConnectionInvitation"}, "invitation_url": {"description": "Invitation URL", "example": "http://192.168.56.101:8020/invite?c_i=eyJAdHlwZSI6Li4ufQ==", "type": "string"}}, "type": "object"}, "IssueCredentialModuleResponse": {"properties": {}, "type": "object"}, "IssuerCredRevRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "cred_ex_id": {"description": "Credential exchange record identifier at credential issue", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_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"}, "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": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[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": {"mediator_terms": {"description": "List of mediator rules for recipient", "items": {"description": "Indicate terms to which the mediator requires the recipient to agree", "type": "string"}, "type": "array"}, "recipient_terms": {"description": "List of recipient rules for mediation", "items": {"description": "Indicate terms to which the recipient requires the mediator to agree", "type": "string"}, "type": "array"}}, "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"}, "mediator_terms": {"items": {"description": "Terms for mediator to agree", "type": "string"}, "type": "array"}, "recipient_terms": {"items": {"description": "Terms for recipient to agree", "type": "string"}, "type": "array"}}, "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"}, "MediationList": {"properties": {"results": {"description": "List of mediation records", "items": {"$ref": "#/definitions/MediationRecord"}, "type": "array"}}, "type": "object"}, "MediationRecord": {"properties": {"connection_id": {"type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "endpoint": {"type": "string"}, "mediation_id": {"type": "string"}, "mediator_terms": {"items": {"type": "string"}, "type": "array"}, "recipient_terms": {"items": {"type": "string"}, "type": "array"}, "role": {"type": "string"}, "routing_keys": {"items": {"example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "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"}, "PerformRequest": {"properties": {"name": {"description": "Menu option name", "example": "Query", "type": "string"}, "params": {"additionalProperties": {"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "description": "Input parameter values", "type": "object"}}, "type": "object"}, "PingRequest": {"properties": {"comment": {"description": "Comment for the ping message", "type": "string", "x-nullable": true}}, "type": "object"}, "PingRequestResponse": {"properties": {"thread_id": {"description": "Thread ID of the ping message", "type": "string"}}, "type": "object"}, "PresentationDefinition": {"properties": {"format": {"$ref": "#/definitions/ClaimFormat"}, "id": {"description": "Unique Resource Identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "input_descriptors": {"items": {"$ref": "#/definitions/InputDescriptors"}, "type": "array"}, "name": {"description": "Human-friendly name that describes what the presentation definition pertains to", "type": "string"}, "purpose": {"description": "Describes the purpose for which the Presentation Definition's inputs are being requested", "type": "string"}, "submission_requirements": {"items": {"$ref": "#/definitions/SubmissionRequirements"}, "type": "array"}}, "type": "object"}, "PresentationProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "presentation_proposal": {"$ref": "#/definitions/IndyPresPreview"}}, "required": ["presentation_proposal"], "type": "object"}, "PresentationRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "request_presentations~attach": {"items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["request_presentations~attach"], "type": "object"}, "ProtocolDescriptor": {"properties": {"pid": {"type": "string"}, "roles": {"description": "List of roles", "items": {"description": "Role: requester or responder", "example": "requester", "type": "string"}, "type": "array", "x-nullable": true}}, "required": ["pid"], "type": "object"}, "PublishRevocations": {"properties": {"rrid2crid": {"additionalProperties": {"items": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "type": "array"}, "description": "Credential revocation ids by revocation registry id", "type": "object"}}, "type": "object"}, "Queries": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "queries": {"items": {"$ref": "#/definitions/QueryItem"}, "type": "array"}}, "type": "object"}, "Query": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "comment": {"type": "string", "x-nullable": true}, "query": {"type": "string"}}, "required": ["query"], "type": "object"}, "QueryItem": {"properties": {"feature-type": {"description": "feature type", "enum": ["protocol", "goal-code"], "type": "string"}, "match": {"description": "match", "type": "string"}}, "required": ["feature-type", "match"], "type": "object"}, "RawEncoded": {"properties": {"encoded": {"description": "Encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Raw value", "type": "string"}}, "type": "object"}, "ReceiveInvitationRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "readOnly": true, "type": "string"}, "did": {"description": "DID for connection invitation", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "imageUrl": {"description": "Optional image URL for connection invitation", "example": "http://192.168.56.101/img/logo.jpg", "format": "url", "type": "string", "x-nullable": true}, "label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipientKeys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routingKeys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "serviceEndpoint": {"description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020", "type": "string"}}, "type": "object"}, "RemoveWalletRequest": {"properties": {"wallet_key": {"description": "Master key used for key derivation. Only required for unmanaged wallets.", "example": "MySecretKey123", "type": "string"}}, "type": "object"}, "ResolutionResult": {"properties": {"did_doc": {"description": "DID Document", "type": "object"}, "metadata": {"description": "Resolution metadata", "type": "object"}}, "required": ["did_doc", "metadata"], "type": "object"}, "RevRegCreateRequest": {"properties": {"credential_definition_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "max_cred_num": {"description": "Revocation registry size", "example": 1000, "format": "int32", "maximum": 32768, "minimum": 4, "type": "integer"}}, "type": "object"}, "RevRegIssuedResult": {"properties": {"result": {"description": "Number of credentials issued against revocation registry", "example": 0, "format": "int32", "minimum": 0, "type": "integer"}}, "type": "object"}, "RevRegResult": {"properties": {"result": {"$ref": "#/definitions/IssuerRevRegRecord"}}, "type": "object"}, "RevRegUpdateTailsFileUri": {"properties": {"tails_public_uri": {"description": "Public URI to the tails file", "example": "http://192.168.56.133:6543/revocation/registry/WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0/tails-file", "format": "url", "type": "string"}}, "required": ["tails_public_uri"], "type": "object"}, "RevRegWalletUpdatedResult": {"properties": {"accum_calculated": {"description": "Calculated accumulator for phantom revocations", "type": "object"}, "accum_fixed": {"description": "Applied ledger transaction to fix revocations", "type": "object"}, "rev_reg_delta": {"description": "Indy revocation registry delta", "type": "object"}}, "type": "object"}, "RevRegsCreated": {"properties": {"rev_reg_ids": {"items": {"description": "Revocation registry identifiers", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "type": "array"}}, "type": "object"}, "RevocationModuleResponse": {"properties": {}, "type": "object"}, "RevokeRequest": {"properties": {"comment": {"description": "Optional comment to include in revocation notification", "type": "string"}, "connection_id": {"description": "Connection ID to which the revocation notification will be sent; required if notify is true", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "cred_ex_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "notify": {"description": "Send a notification to the credential recipient", "type": "boolean"}, "notify_version": {"description": "Specify which version of the revocation notification should be sent", "enum": ["v1_0", "v2_0"], "type": "string"}, "publish": {"description": "(True) publish revocation to ledger immediately, or (default, False) mark it pending", "type": "boolean"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "thread_id": {"description": "Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true", "type": "string"}}, "type": "object"}, "RouteRecord": {"properties": {"connection_id": {"type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "recipient_key": {"type": "string"}, "record_id": {"type": "string"}, "role": {"type": "string"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "wallet_id": {"type": "string"}}, "required": ["recipient_key"], "type": "object"}, "Schema": {"properties": {"attrNames": {"description": "Schema attribute names", "items": {"description": "Attribute name", "example": "score", "type": "string"}, "type": "array"}, "id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "name": {"description": "Schema name", "example": "schema_name", "type": "string"}, "seqNo": {"description": "Schema sequence number", "example": 10, "format": "int32", "minimum": 1, "type": "integer"}, "ver": {"description": "Node protocol version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}, "version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "SchemaGetResult": {"properties": {"schema": {"$ref": "#/definitions/Schema"}}, "type": "object"}, "SchemaInputDescriptor": {"properties": {"required": {"description": "Required", "type": "boolean"}, "uri": {"description": "URI", "type": "string"}}, "type": "object"}, "SchemaSendRequest": {"properties": {"attributes": {"description": "List of schema attributes", "items": {"description": "attribute name", "example": "score", "type": "string"}, "type": "array"}, "schema_name": {"description": "Schema name", "example": "prefs", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "required": ["attributes", "schema_name", "schema_version"], "type": "object"}, "SchemaSendResult": {"properties": {"schema": {"allOf": [{"$ref": "#/definitions/Schema"}], "description": "Schema definition"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "required": ["schema_id"], "type": "object"}, "SchemasCreatedResult": {"properties": {"schema_ids": {"items": {"description": "Schema identifiers", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "type": "array"}}, "type": "object"}, "SchemasInputDescriptorFilter": {"properties": {"oneof_filter": {"description": "oneOf", "type": "boolean"}, "uri_groups": {"items": {"items": {"$ref": "#/definitions/SchemaInputDescriptor"}, "type": "array"}, "type": "array"}}, "type": "object"}, "SendMenu": {"properties": {"menu": {"allOf": [{"$ref": "#/definitions/MenuJson"}], "description": "Menu to send to connection"}}, "required": ["menu"], "type": "object"}, "SendMessage": {"properties": {"content": {"description": "Message content", "example": "Hello", "type": "string"}}, "type": "object"}, "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"}, "TransactionJobs": {"properties": {"transaction_my_job": {"description": "My transaction related job", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "type": "string"}, "transaction_their_job": {"description": "Their transaction related job", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "type": "string"}}, "type": "object"}, "TransactionList": {"properties": {"results": {"description": "List of transaction records", "items": {"$ref": "#/definitions/TransactionRecord"}, "type": "array"}}, "type": "object"}, "TransactionRecord": {"properties": {"_type": {"description": "Transaction type", "example": "101", "type": "string"}, "connection_id": {"description": "The connection identifier for thie particular transaction record", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "endorser_write_txn": {"description": "If True, Endorser will write the transaction after endorsing it", "example": true, "type": "boolean"}, "formats": {"items": {"additionalProperties": {"type": "string"}, "example": {"attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "dif/endorse-transaction/request@v1.0"}, "type": "object"}, "type": "array"}, "messages_attach": {"items": {"example": {"@id": "143c458d-1b1c-40c7-ab85-4d16808ddf0a", "data": {"json": "{\"endorser\": \"V4SGRU86Z58d6TV7PBUe6f\",\"identifier\": \"LjgpST2rjsoxYegQDRm7EL\",\"operation\": {\"data\": {\"attr_names\": [\"first_name\", \"last_name\"],\"name\": \"test_schema\",\"version\": \"2.1\",},\"type\": \"101\",},\"protocolVersion\": 2,\"reqId\": 1597766666168851000,\"signatures\": {\"LjgpST2rjsox\": \"4ATKMn6Y9sTgwqaGTm7py2c2M8x1EVDTWKZArwyuPgjU\"},\"taaAcceptance\": {\"mechanism\": \"manual\",\"taaDigest\": \"f50fe2c2ab977006761d36bd6f23e4c6a7e0fc2feb9f62\",\"time\": 1597708800,}}"}, "mime-type": "application/json"}, "type": "object"}, "type": "array"}, "meta_data": {"example": {"context": {"param1": "param1_value", "param2": "param2_value"}, "post_process": [{"topic": "topic_value", "other": "other_value"}]}, "type": "object"}, "signature_request": {"items": {"example": {"author_goal_code": "aries.transaction.ledger.write", "context": "did:sov", "method": "add-signature", "signature_type": "", "signer_goal_code": "aries.transaction.endorse"}, "type": "object"}, "type": "array"}, "signature_response": {"items": {"example": {"context": "did:sov", "message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "method": "add-signature", "signer_goal_code": "aries.transaction.refuse"}, "type": "object"}, "type": "array"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "thread_id": {"description": "Thread Identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "timing": {"example": {"expires_time": "2020-12-13T17:29:06+0000"}, "type": "object"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "transaction_id": {"description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "TxnOrCredentialDefinitionSendResult": {"properties": {"sent": {"$ref": "#/definitions/CredentialDefinitionSendResult"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Credential definition transaction to endorse"}}, "type": "object"}, "TxnOrPublishRevocationsResult": {"properties": {"sent": {"$ref": "#/definitions/PublishRevocations"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Revocation registry revocations transaction to endorse"}}, "type": "object"}, "TxnOrRegisterLedgerNymResponse": {"properties": {"success": {"description": "Success of nym registration operation", "example": true, "type": "boolean"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "DID transaction to endorse"}}, "type": "object"}, "TxnOrRevRegResult": {"properties": {"sent": {"$ref": "#/definitions/RevRegResult"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Revocation registry definition transaction to endorse"}}, "type": "object"}, "TxnOrSchemaSendResult": {"properties": {"sent": {"allOf": [{"$ref": "#/definitions/SchemaSendResult"}], "description": "Content sent"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Schema transaction to endorse"}}, "type": "object"}, "UpdateWalletRequest": {"properties": {"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"}, "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"}, "V10DiscoveryExchangeResult": {"properties": {"results": {"allOf": [{"$ref": "#/definitions/V10DiscoveryRecord"}], "description": "Discover Features v1.0 exchange record"}}, "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_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_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"}}, "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"}, "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"}, "V10PresentationSendRequestRequest": {"properties": {"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_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"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "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"], "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"}, "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"}, "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": {"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"}, "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_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_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"], "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"}}, "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"}, "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_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": {"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_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "type": "object"}, "VCRecord": {"properties": {"contexts": {"items": {"description": "Context", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "cred_tags": {"additionalProperties": {"description": "Retrieval tag value", "type": "string"}, "type": "object"}, "cred_value": {"description": "(JSON-serializable) credential value", "type": "object"}, "expanded_types": {"items": {"description": "JSON-LD expanded type extracted from type and context", "example": "https://w3id.org/citizenship#PermanentResidentCard", "type": "string"}, "type": "array"}, "given_id": {"description": "Credential identifier", "example": "http://example.edu/credentials/3732", "type": "string"}, "issuer_id": {"description": "Issuer identifier", "example": "https://example.edu/issuers/14", "type": "string"}, "proof_types": {"items": {"description": "Signature suite used for proof", "example": "Ed25519Signature2018", "type": "string"}, "type": "array"}, "record_id": {"description": "Record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "schema_ids": {"items": {"description": "Schema identifier", "example": "https://example.org/examples/degree.json", "type": "string"}, "type": "array"}, "subject_ids": {"items": {"description": "Subject identifier", "example": "did:example:ebfeb1f712ebc6f1c276e12ec21", "type": "string"}, "type": "array"}}, "type": "object"}, "VCRecordList": {"properties": {"results": {"items": {"$ref": "#/definitions/VCRecord"}, "type": "array"}}, "type": "object"}, "VerifyRequest": {"properties": {"doc": {"allOf": [{"$ref": "#/definitions/SignedDoc"}], "description": "Signed document"}, "verkey": {"description": "Verkey to use for doc verification", "type": "string"}}, "required": ["doc"], "type": "object"}, "VerifyResponse": {"properties": {"error": {"description": "Error text", "type": "string"}, "valid": {"type": "boolean"}}, "required": ["valid"], "type": "object"}, "W3CCredentialsListRequest": {"properties": {"contexts": {"items": {"description": "Credential context to match", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "given_id": {"description": "Given credential id to match", "type": "string"}, "issuer_id": {"description": "Credential issuer identifier to match", "type": "string"}, "max_results": {"description": "Maximum number of results to return", "format": "int32", "type": "integer"}, "proof_types": {"items": {"description": "Signature suite used for proof", "example": "Ed25519Signature2018", "type": "string"}, "type": "array"}, "schema_ids": {"description": "Schema identifiers, all of which to match", "items": {"description": "Credential schema identifier", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "subject_ids": {"description": "Subject identifiers, all of which to match", "items": {"description": "Subject identifier", "type": "string"}, "type": "array"}, "tag_query": {"additionalProperties": {"description": "Tag value", "type": "string"}, "description": "Tag filter", "type": "object"}, "types": {"items": {"description": "Credential type to match", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}}, "type": "object"}, "WalletList": {"properties": {"results": {"description": "List of wallet records", "items": {"$ref": "#/definitions/WalletRecord"}, "type": "array"}}, "type": "object"}, "WalletModuleResponse": {"properties": {}, "type": "object"}, "WalletRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "key_management_mode": {"description": "Mode regarding management of wallet key", "enum": ["managed", "unmanaged"], "type": "string"}, "settings": {"description": "Settings for this wallet.", "type": "object"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "wallet_id": {"description": "Wallet record ID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["key_management_mode", "wallet_id"], "type": "object"}, "WriteLedgerRequest": {"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": "trustping", "description": "Trust-ping over connection", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0048-trust-ping"}}, {"name": "wallet", "description": "DID and tag policy management", "externalDocs": {"description": "Design", "url": "https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage"}}]} \ No newline at end of file diff --git a/generator/scripts/retrieve-openapi.sh b/generator/scripts/retrieve-openapi.sh index 26c547181..475207f7a 100755 --- a/generator/scripts/retrieve-openapi.sh +++ b/generator/scripts/retrieve-openapi.sh @@ -11,7 +11,7 @@ cd "$(dirname "$0")/../" || exit ########################################################################################## # Global Defaults and Constants ########################################################################################## -ACA_PY_DOCKER_IMAGE_VERSION=${1:-"py36-1.16-1_0.7.0"} +ACA_PY_DOCKER_IMAGE_VERSION=${1:-"py36-1.16-1_0.7.4"} ACA_PY_DOCKER_IMAGE_DEFAULT="bcgovimages/aries-cloudagent:${ACA_PY_DOCKER_IMAGE_VERSION}" ACA_PY_ADMIN_PORT="8305" diff --git a/setup.py b/setup.py index 7c1328249..2fedfd995 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ def parse_requirements(filename: str): if __name__ == "__main__": setup( name=PACKAGE_NAME, - version="0.5.2", + version="0.5.3", description="A simple python package for controlling an aries agent through the admin-api interface", long_description=long_description, long_description_content_type="text/markdown", From 4dc7582de71df43aadb1b644d897f93b6f6f9f86 Mon Sep 17 00:00:00 2001 From: Moriarty Date: Tue, 20 Sep 2022 10:22:09 +0200 Subject: [PATCH 2/5] chore: code review feedback Signed-off-by: Moriarty --- README.md | 2 +- aries_cloudcontroller/__init__.py | 19 ++++--- aries_cloudcontroller/api/connection.py | 6 ++ .../api/endorse_transaction.py | 9 ++- aries_cloudcontroller/api/ledger.py | 23 ++++++-- .../api/present_proof_v1_0.py | 14 ++++- .../api/present_proof_v2_0.py | 14 ++++- aries_cloudcontroller/api/revocation.py | 57 +++++++++++++++++++ aries_cloudcontroller/api/wallet.py | 34 +++++++++-- aries_cloudcontroller/model/__init__.py | 30 ++++++++-- .../model/create_wallet_request.py | 6 ++ .../model/cred_rev_indy_records_result.py | 39 +++++++++++++ .../model/cred_rev_record_details_result.py | 40 +++++++++++++ .../model/dif_proof_proposal.py | 5 ++ .../model/invitation_record.py | 4 ++ .../model/rev_reg_wallet_updated_result.py | 47 +++++++++++++++ aries_cloudcontroller/model/revoke_request.py | 4 ++ .../txn_or_register_ledger_nym_response.py | 44 ++++++++++++++ ...v10_presentation_create_request_request.py | 4 ++ .../model/v10_presentation_exchange.py | 4 ++ .../v10_presentation_send_request_request.py | 4 ++ ...0_presentation_send_request_to_proposal.py | 43 ++++++++++++++ .../model/v20_cred_ex_record.py | 2 + .../model/v20_pres_create_request_request.py | 4 ++ .../model/v20_pres_ex_record.py | 4 ++ .../model/v20_pres_send_request_request.py | 4 ++ ...0_presentation_send_request_to_proposal.py | 43 ++++++++++++++ generator/data/openapi.patch | 42 +++++++------- setup.py | 2 +- 29 files changed, 499 insertions(+), 54 deletions(-) create mode 100644 aries_cloudcontroller/model/cred_rev_indy_records_result.py create mode 100644 aries_cloudcontroller/model/cred_rev_record_details_result.py create mode 100644 aries_cloudcontroller/model/rev_reg_wallet_updated_result.py create mode 100644 aries_cloudcontroller/model/txn_or_register_ledger_nym_response.py create mode 100644 aries_cloudcontroller/model/v10_presentation_send_request_to_proposal.py create mode 100644 aries_cloudcontroller/model/v20_presentation_send_request_to_proposal.py diff --git a/README.md b/README.md index 2dbc0790f..607bc9015 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Each Cloud Controller version maps to a specific ACA-Py version, which is outlin | Aries Cloud Controller Version | Aries Cloud Agent Python Version | | ------------------------------ | -------------------------------- | -| 0.5.3 | 0.7.4 | +| 0.5.1-0.5.2 | 0.7.3 | ## Features diff --git a/aries_cloudcontroller/__init__.py b/aries_cloudcontroller/__init__.py index fd233e397..dc8bd9c2f 100644 --- a/aries_cloudcontroller/__init__.py +++ b/aries_cloudcontroller/__init__.py @@ -1,5 +1,3 @@ -from aries_cloudcontroller.acapy_client import AcaPyClient - from aries_cloudcontroller.api import ( ActionMenuApi, BasicmessageApi, @@ -32,7 +30,6 @@ from aries_cloudcontroller.model import ( AMLRecord, ActionMenuFetchResult, - AdminAPIMessageTracing, AdminConfig, AdminMediationDeny, AdminModules, @@ -66,6 +63,8 @@ CredDefValuePrimary, CredDefValueRevocation, CredInfoList, + CredRevIndyRecordsResult, + CredRevRecordDetailsResult, CredRevRecordResult, CredRevokedResult, Credential, @@ -186,13 +185,13 @@ QueryItem, RawEncoded, ReceiveInvitationRequest, - RegisterLedgerNymResponse, RemoveWalletRequest, ResolutionResult, RevRegCreateRequest, RevRegIssuedResult, RevRegResult, RevRegUpdateTailsFileUri, + RevRegWalletUpdatedResult, RevRegsCreated, RevokeRequest, RouteRecord, @@ -219,6 +218,7 @@ TransactionRecord, TxnOrCredentialDefinitionSendResult, TxnOrPublishRevocationsResult, + TxnOrRegisterLedgerNymResponse, TxnOrRevRegResult, TxnOrSchemaSendResult, UpdateWalletRequest, @@ -242,6 +242,7 @@ V10PresentationProblemReportRequest, V10PresentationProposalRequest, V10PresentationSendRequestRequest, + V10PresentationSendRequestToProposal, V20CredAttrSpec, V20CredBoundOfferRequest, V20CredExFree, @@ -285,6 +286,7 @@ V20PresRequestByFormat, V20PresSendRequestRequest, V20PresSpecByFormatRequest, + V20PresentationSendRequestToProposal, VCRecord, VCRecordList, VerifyRequest, @@ -296,10 +298,8 @@ ) __all__ = [ - "AcaPyClient", "AMLRecord", "ActionMenuFetchResult", - "AdminAPIMessageTracing", "AdminConfig", "AdminMediationDeny", "AdminModules", @@ -333,6 +333,8 @@ "CredDefValuePrimary", "CredDefValueRevocation", "CredInfoList", + "CredRevIndyRecordsResult", + "CredRevRecordDetailsResult", "CredRevRecordResult", "CredRevokedResult", "Credential", @@ -453,13 +455,13 @@ "QueryItem", "RawEncoded", "ReceiveInvitationRequest", - "RegisterLedgerNymResponse", "RemoveWalletRequest", "ResolutionResult", "RevRegCreateRequest", "RevRegIssuedResult", "RevRegResult", "RevRegUpdateTailsFileUri", + "RevRegWalletUpdatedResult", "RevRegsCreated", "RevokeRequest", "RouteRecord", @@ -486,6 +488,7 @@ "TransactionRecord", "TxnOrCredentialDefinitionSendResult", "TxnOrPublishRevocationsResult", + "TxnOrRegisterLedgerNymResponse", "TxnOrRevRegResult", "TxnOrSchemaSendResult", "UpdateWalletRequest", @@ -509,6 +512,7 @@ "V10PresentationProblemReportRequest", "V10PresentationProposalRequest", "V10PresentationSendRequestRequest", + "V10PresentationSendRequestToProposal", "V20CredAttrSpec", "V20CredBoundOfferRequest", "V20CredExFree", @@ -552,6 +556,7 @@ "V20PresRequestByFormat", "V20PresSendRequestRequest", "V20PresSpecByFormatRequest", + "V20PresentationSendRequestToProposal", "VCRecord", "VCRecordList", "VerifyRequest", diff --git a/aries_cloudcontroller/api/connection.py b/aries_cloudcontroller/api/connection.py index 73f15245e..b697d6771 100644 --- a/aries_cloudcontroller/api/connection.py +++ b/aries_cloudcontroller/api/connection.py @@ -120,9 +120,11 @@ async def get_connections( alias: Optional[str] = None, connection_protocol: Optional[str] = None, invitation_key: Optional[str] = None, + invitation_msg_id: Optional[str] = None, my_did: Optional[str] = None, state: Optional[str] = None, their_did: Optional[str] = None, + their_public_did: Optional[str] = None, their_role: Optional[str] = None ) -> ConnectionList: """Query agent-to-agent connections""" @@ -130,9 +132,11 @@ async def get_connections( alias=alias, connection_protocol=connection_protocol, invitation_key=invitation_key, + invitation_msg_id=invitation_msg_id, my_did=my_did, state=state, their_did=their_did, + their_public_did=their_public_did, their_role=their_role, ) @@ -239,9 +243,11 @@ def __get_connections( alias: Query = None, connection_protocol: Query = None, invitation_key: Query = None, + invitation_msg_id: Query = None, my_did: Query = None, state: Query = None, their_did: Query = None, + their_public_did: Query = None, their_role: Query = None ) -> ConnectionList: """Internal uplink method for get_connections""" diff --git a/aries_cloudcontroller/api/endorse_transaction.py b/aries_cloudcontroller/api/endorse_transaction.py index 387a2f2e4..07c6f8506 100644 --- a/aries_cloudcontroller/api/endorse_transaction.py +++ b/aries_cloudcontroller/api/endorse_transaction.py @@ -45,10 +45,13 @@ async def create_request( body=body, ) - async def endorse_transaction(self, *, tran_id: str) -> TransactionRecord: + async def endorse_transaction( + self, *, tran_id: str, endorser_did: Optional[str] = None + ) -> TransactionRecord: """For Endorser to endorse a particular transaction record""" return await self.__endorse_transaction( tran_id=tran_id, + endorser_did=endorser_did, ) async def get_records(self) -> TransactionList: @@ -117,7 +120,9 @@ def __create_request( @returns.json @post("/transactions/{tran_id}/endorse") - def __endorse_transaction(self, *, tran_id: str) -> TransactionRecord: + def __endorse_transaction( + self, *, tran_id: str, endorser_did: Query = None + ) -> TransactionRecord: """Internal uplink method for endorse_transaction""" @returns.json diff --git a/aries_cloudcontroller/api/ledger.py b/aries_cloudcontroller/api/ledger.py index 442c3e74e..8f43b52ce 100644 --- a/aries_cloudcontroller/api/ledger.py +++ b/aries_cloudcontroller/api/ledger.py @@ -21,11 +21,11 @@ from aries_cloudcontroller.model.get_did_verkey_response import GetDIDVerkeyResponse from aries_cloudcontroller.model.get_nym_role_response import GetNymRoleResponse from aries_cloudcontroller.model.ledger_config_list import LedgerConfigList -from aries_cloudcontroller.model.register_ledger_nym_response import ( - RegisterLedgerNymResponse, -) from aries_cloudcontroller.model.taa_accept import TAAAccept from aries_cloudcontroller.model.taa_result import TAAResult +from aries_cloudcontroller.model.txn_or_register_ledger_nym_response import ( + TxnOrRegisterLedgerNymResponse, +) from aries_cloudcontroller.model.write_ledger_request import WriteLedgerRequest @@ -75,13 +75,17 @@ async def register_nym( did: str, verkey: str, alias: Optional[str] = None, + conn_id: Optional[str] = None, + create_transaction_for_endorser: Optional[bool] = None, role: Optional[str] = None - ) -> RegisterLedgerNymResponse: + ) -> TxnOrRegisterLedgerNymResponse: """Send a NYM registration to the ledger.""" return await self.__register_nym( did=did, verkey=verkey, alias=alias, + conn_id=conn_id, + create_transaction_for_endorser=bool_query(create_transaction_for_endorser), role=role, ) @@ -130,8 +134,15 @@ def __ledger_multiple_get_write_ledger_get(self) -> WriteLedgerRequest: @returns.json @post("/ledger/register-nym") def __register_nym( - self, *, did: Query, verkey: Query, alias: Query = None, role: Query = None - ) -> RegisterLedgerNymResponse: + self, + *, + did: Query, + verkey: Query, + alias: Query = None, + conn_id: Query = None, + create_transaction_for_endorser: Query = None, + role: Query = None + ) -> TxnOrRegisterLedgerNymResponse: """Internal uplink method for register_nym""" @returns.json diff --git a/aries_cloudcontroller/api/present_proof_v1_0.py b/aries_cloudcontroller/api/present_proof_v1_0.py index 4413d7e96..ee7d08322 100644 --- a/aries_cloudcontroller/api/present_proof_v1_0.py +++ b/aries_cloudcontroller/api/present_proof_v1_0.py @@ -17,7 +17,6 @@ from aries_cloudcontroller.uplink_util import bool_query -from aries_cloudcontroller.model.admin_api_message_tracing import AdminAPIMessageTracing from aries_cloudcontroller.model.indy_cred_precis import IndyCredPrecis from aries_cloudcontroller.model.indy_pres_spec import IndyPresSpec from aries_cloudcontroller.model.v10_presentation_create_request_request import ( @@ -38,6 +37,9 @@ from aries_cloudcontroller.model.v10_presentation_send_request_request import ( V10PresentationSendRequestRequest, ) +from aries_cloudcontroller.model.v10_presentation_send_request_to_proposal import ( + V10PresentationSendRequestToProposal, +) class PresentProofV10Api(Consumer): @@ -125,7 +127,10 @@ async def send_proposal( ) async def send_request( - self, *, pres_ex_id: str, body: Optional[AdminAPIMessageTracing] = None + self, + *, + pres_ex_id: str, + body: Optional[V10PresentationSendRequestToProposal] = None ) -> V10PresentationExchange: """Sends a presentation request in reference to a proposal""" return await self.__send_request( @@ -221,7 +226,10 @@ def __send_proposal( @json @post("/present-proof/records/{pres_ex_id}/send-request") def __send_request( - self, *, pres_ex_id: str, body: Body(type=AdminAPIMessageTracing) = {} + self, + *, + pres_ex_id: str, + body: Body(type=V10PresentationSendRequestToProposal) = {} ) -> V10PresentationExchange: """Internal uplink method for send_request""" diff --git a/aries_cloudcontroller/api/present_proof_v2_0.py b/aries_cloudcontroller/api/present_proof_v2_0.py index 3147ab73e..708ee459e 100644 --- a/aries_cloudcontroller/api/present_proof_v2_0.py +++ b/aries_cloudcontroller/api/present_proof_v2_0.py @@ -17,7 +17,6 @@ from aries_cloudcontroller.uplink_util import bool_query -from aries_cloudcontroller.model.admin_api_message_tracing import AdminAPIMessageTracing from aries_cloudcontroller.model.indy_cred_precis import IndyCredPrecis from aries_cloudcontroller.model.v20_pres_create_request_request import ( V20PresCreateRequestRequest, @@ -34,6 +33,9 @@ from aries_cloudcontroller.model.v20_pres_spec_by_format_request import ( V20PresSpecByFormatRequest, ) +from aries_cloudcontroller.model.v20_presentation_send_request_to_proposal import ( + V20PresentationSendRequestToProposal, +) class PresentProofV20Api(Consumer): @@ -118,7 +120,10 @@ async def send_proposal( ) async def send_request( - self, *, pres_ex_id: str, body: Optional[AdminAPIMessageTracing] = None + self, + *, + pres_ex_id: str, + body: Optional[V20PresentationSendRequestToProposal] = None ) -> V20PresExRecord: """Sends a presentation request in reference to a proposal""" return await self.__send_request( @@ -211,7 +216,10 @@ def __send_proposal( @json @post("/present-proof-2.0/records/{pres_ex_id}/send-request") def __send_request( - self, *, pres_ex_id: str, body: Body(type=AdminAPIMessageTracing) = {} + self, + *, + pres_ex_id: str, + body: Body(type=V20PresentationSendRequestToProposal) = {} ) -> V20PresExRecord: """Internal uplink method for send_request""" diff --git a/aries_cloudcontroller/api/revocation.py b/aries_cloudcontroller/api/revocation.py index 52c467385..ef4c3f9dc 100644 --- a/aries_cloudcontroller/api/revocation.py +++ b/aries_cloudcontroller/api/revocation.py @@ -20,6 +20,12 @@ from aries_cloudcontroller.model.clear_pending_revocations_request import ( ClearPendingRevocationsRequest, ) +from aries_cloudcontroller.model.cred_rev_indy_records_result import ( + CredRevIndyRecordsResult, +) +from aries_cloudcontroller.model.cred_rev_record_details_result import ( + CredRevRecordDetailsResult, +) from aries_cloudcontroller.model.cred_rev_record_result import CredRevRecordResult from aries_cloudcontroller.model.publish_revocations import PublishRevocations from aries_cloudcontroller.model.rev_reg_create_request import RevRegCreateRequest @@ -28,6 +34,9 @@ from aries_cloudcontroller.model.rev_reg_update_tails_file_uri import ( RevRegUpdateTailsFileUri, ) +from aries_cloudcontroller.model.rev_reg_wallet_updated_result import ( + RevRegWalletUpdatedResult, +) from aries_cloudcontroller.model.rev_regs_created import RevRegsCreated from aries_cloudcontroller.model.revoke_request import RevokeRequest from aries_cloudcontroller.model.txn_or_publish_revocations_result import ( @@ -140,6 +149,33 @@ async def publish_revocations( body=body, ) + async def revocation_registry_rev_reg_id_fix_revocation_entry_state_put( + self, *, rev_reg_id: str, apply_ledger_update: bool + ) -> RevRegWalletUpdatedResult: + """Fix revocation state in wallet and return number of updated entries""" + return ( + await self.__revocation_registry_rev_reg_id_fix_revocation_entry_state_put( + rev_reg_id=rev_reg_id, + apply_ledger_update=bool_query(apply_ledger_update), + ) + ) + + async def revocation_registry_rev_reg_id_issued_details_get( + self, *, rev_reg_id: str + ) -> CredRevRecordDetailsResult: + """Get details of credentials issued against revocation registry""" + return await self.__revocation_registry_rev_reg_id_issued_details_get( + rev_reg_id=rev_reg_id, + ) + + async def revocation_registry_rev_reg_id_issued_indy_recs_get( + self, *, rev_reg_id: str + ) -> CredRevIndyRecordsResult: + """Get details of revoked credentials from ledger""" + return await self.__revocation_registry_rev_reg_id_issued_indy_recs_get( + rev_reg_id=rev_reg_id, + ) + async def revoke_credential(self, *, body: Optional[RevokeRequest] = None) -> Dict: """Revoke an issued credential""" return await self.__revoke_credential( @@ -253,6 +289,27 @@ def __publish_revocations( ) -> Union[PublishRevocations, TxnOrPublishRevocationsResult]: """Internal uplink method for publish_revocations""" + @returns.json + @put("/revocation/registry/{rev_reg_id}/fix-revocation-entry-state") + def __revocation_registry_rev_reg_id_fix_revocation_entry_state_put( + self, *, rev_reg_id: str, apply_ledger_update: Query + ) -> RevRegWalletUpdatedResult: + """Internal uplink method for revocation_registry_rev_reg_id_fix_revocation_entry_state_put""" + + @returns.json + @get("/revocation/registry/{rev_reg_id}/issued/details") + def __revocation_registry_rev_reg_id_issued_details_get( + self, *, rev_reg_id: str + ) -> CredRevRecordDetailsResult: + """Internal uplink method for revocation_registry_rev_reg_id_issued_details_get""" + + @returns.json + @get("/revocation/registry/{rev_reg_id}/issued/indy_recs") + def __revocation_registry_rev_reg_id_issued_indy_recs_get( + self, *, rev_reg_id: str + ) -> CredRevIndyRecordsResult: + """Internal uplink method for revocation_registry_rev_reg_id_issued_indy_recs_get""" + @returns.json @json @post("/revocation/revoke") diff --git a/aries_cloudcontroller/api/wallet.py b/aries_cloudcontroller/api/wallet.py index 16f78940d..f6205a498 100644 --- a/aries_cloudcontroller/api/wallet.py +++ b/aries_cloudcontroller/api/wallet.py @@ -66,17 +66,31 @@ async def rotate_keypair(self, *, did: str) -> Dict: ) async def set_did_endpoint( - self, *, body: Optional[DIDEndpointWithType] = None + self, + *, + conn_id: Optional[str] = None, + create_transaction_for_endorser: Optional[bool] = None, + body: Optional[DIDEndpointWithType] = None ) -> Dict: """Update endpoint in wallet and on ledger if posted to it""" return await self.__set_did_endpoint( + conn_id=conn_id, + create_transaction_for_endorser=bool_query(create_transaction_for_endorser), body=body, ) - async def set_public_did(self, *, did: str) -> DIDResult: + async def set_public_did( + self, + *, + did: str, + conn_id: Optional[str] = None, + create_transaction_for_endorser: Optional[bool] = None + ) -> DIDResult: """Assign the current public DID""" return await self.__set_public_did( did=did, + conn_id=conn_id, + create_transaction_for_endorser=bool_query(create_transaction_for_endorser), ) @returns.json @@ -116,10 +130,22 @@ def __rotate_keypair(self, *, did: Query) -> Dict: @returns.json @json @post("/wallet/set-did-endpoint") - def __set_did_endpoint(self, *, body: Body(type=DIDEndpointWithType) = {}) -> Dict: + def __set_did_endpoint( + self, + *, + conn_id: Query = None, + create_transaction_for_endorser: Query = None, + body: Body(type=DIDEndpointWithType) = {} + ) -> Dict: """Internal uplink method for set_did_endpoint""" @returns.json @post("/wallet/did/public") - def __set_public_did(self, *, did: Query) -> DIDResult: + def __set_public_did( + self, + *, + did: Query, + conn_id: Query = None, + create_transaction_for_endorser: Query = None + ) -> DIDResult: """Internal uplink method for set_public_did""" diff --git a/aries_cloudcontroller/model/__init__.py b/aries_cloudcontroller/model/__init__.py index 783facaff..84ea56204 100644 --- a/aries_cloudcontroller/model/__init__.py +++ b/aries_cloudcontroller/model/__init__.py @@ -2,7 +2,6 @@ from aries_cloudcontroller.model.aml_record import AMLRecord from aries_cloudcontroller.model.action_menu_fetch_result import ActionMenuFetchResult -from aries_cloudcontroller.model.admin_api_message_tracing import AdminAPIMessageTracing from aries_cloudcontroller.model.admin_config import AdminConfig from aries_cloudcontroller.model.admin_mediation_deny import AdminMediationDeny from aries_cloudcontroller.model.admin_modules import AdminModules @@ -54,6 +53,12 @@ from aries_cloudcontroller.model.cred_def_value_primary import CredDefValuePrimary from aries_cloudcontroller.model.cred_def_value_revocation import CredDefValueRevocation from aries_cloudcontroller.model.cred_info_list import CredInfoList +from aries_cloudcontroller.model.cred_rev_indy_records_result import ( + CredRevIndyRecordsResult, +) +from aries_cloudcontroller.model.cred_rev_record_details_result import ( + CredRevRecordDetailsResult, +) from aries_cloudcontroller.model.cred_rev_record_result import CredRevRecordResult from aries_cloudcontroller.model.cred_revoked_result import CredRevokedResult from aries_cloudcontroller.model.credential import Credential @@ -222,9 +227,6 @@ from aries_cloudcontroller.model.receive_invitation_request import ( ReceiveInvitationRequest, ) -from aries_cloudcontroller.model.register_ledger_nym_response import ( - RegisterLedgerNymResponse, -) from aries_cloudcontroller.model.remove_wallet_request import RemoveWalletRequest from aries_cloudcontroller.model.resolution_result import ResolutionResult from aries_cloudcontroller.model.rev_reg_create_request import RevRegCreateRequest @@ -233,6 +235,9 @@ from aries_cloudcontroller.model.rev_reg_update_tails_file_uri import ( RevRegUpdateTailsFileUri, ) +from aries_cloudcontroller.model.rev_reg_wallet_updated_result import ( + RevRegWalletUpdatedResult, +) from aries_cloudcontroller.model.rev_regs_created import RevRegsCreated from aries_cloudcontroller.model.revoke_request import RevokeRequest from aries_cloudcontroller.model.route_record import RouteRecord @@ -265,6 +270,9 @@ from aries_cloudcontroller.model.txn_or_publish_revocations_result import ( TxnOrPublishRevocationsResult, ) +from aries_cloudcontroller.model.txn_or_register_ledger_nym_response import ( + TxnOrRegisterLedgerNymResponse, +) from aries_cloudcontroller.model.txn_or_rev_reg_result import TxnOrRevRegResult from aries_cloudcontroller.model.txn_or_schema_send_result import TxnOrSchemaSendResult from aries_cloudcontroller.model.update_wallet_request import UpdateWalletRequest @@ -322,6 +330,9 @@ from aries_cloudcontroller.model.v10_presentation_send_request_request import ( V10PresentationSendRequestRequest, ) +from aries_cloudcontroller.model.v10_presentation_send_request_to_proposal import ( + V10PresentationSendRequestToProposal, +) from aries_cloudcontroller.model.v20_cred_attr_spec import V20CredAttrSpec from aries_cloudcontroller.model.v20_cred_bound_offer_request import ( V20CredBoundOfferRequest, @@ -397,6 +408,9 @@ from aries_cloudcontroller.model.v20_pres_spec_by_format_request import ( V20PresSpecByFormatRequest, ) +from aries_cloudcontroller.model.v20_presentation_send_request_to_proposal import ( + V20PresentationSendRequestToProposal, +) from aries_cloudcontroller.model.vc_record import VCRecord from aries_cloudcontroller.model.vc_record_list import VCRecordList from aries_cloudcontroller.model.verify_request import VerifyRequest @@ -411,7 +425,6 @@ __all__ = [ "AMLRecord", "ActionMenuFetchResult", - "AdminAPIMessageTracing", "AdminConfig", "AdminMediationDeny", "AdminModules", @@ -445,6 +458,8 @@ "CredDefValuePrimary", "CredDefValueRevocation", "CredInfoList", + "CredRevIndyRecordsResult", + "CredRevRecordDetailsResult", "CredRevRecordResult", "CredRevokedResult", "Credential", @@ -565,13 +580,13 @@ "QueryItem", "RawEncoded", "ReceiveInvitationRequest", - "RegisterLedgerNymResponse", "RemoveWalletRequest", "ResolutionResult", "RevRegCreateRequest", "RevRegIssuedResult", "RevRegResult", "RevRegUpdateTailsFileUri", + "RevRegWalletUpdatedResult", "RevRegsCreated", "RevokeRequest", "RouteRecord", @@ -598,6 +613,7 @@ "TransactionRecord", "TxnOrCredentialDefinitionSendResult", "TxnOrPublishRevocationsResult", + "TxnOrRegisterLedgerNymResponse", "TxnOrRevRegResult", "TxnOrSchemaSendResult", "UpdateWalletRequest", @@ -621,6 +637,7 @@ "V10PresentationProblemReportRequest", "V10PresentationProposalRequest", "V10PresentationSendRequestRequest", + "V10PresentationSendRequestToProposal", "V20CredAttrSpec", "V20CredBoundOfferRequest", "V20CredExFree", @@ -664,6 +681,7 @@ "V20PresRequestByFormat", "V20PresSendRequestRequest", "V20PresSpecByFormatRequest", + "V20PresentationSendRequestToProposal", "VCRecord", "VCRecordList", "VerifyRequest", diff --git a/aries_cloudcontroller/model/create_wallet_request.py b/aries_cloudcontroller/model/create_wallet_request.py index 5f821b75f..743b4921a 100644 --- a/aries_cloudcontroller/model/create_wallet_request.py +++ b/aries_cloudcontroller/model/create_wallet_request.py @@ -21,6 +21,7 @@ class CreateWalletRequest(BaseModel): label: Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection. [Optional]. wallet_dispatch_type: 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. [Optional]. wallet_key: Master key used for key derivation. [Optional]. + wallet_key_derivation: Key derivation [Optional]. wallet_name: Wallet name [Optional]. wallet_type: Type of the wallet to create [Optional]. wallet_webhook_urls: List of Webhook URLs associated with this subwallet [Optional]. @@ -31,6 +32,7 @@ class CreateWalletRequest(BaseModel): label: Optional[str] = None wallet_dispatch_type: Optional[Literal["default", "both", "base"]] = None wallet_key: Optional[str] = None + wallet_key_derivation: Optional[Literal["ARGON2I_MOD", "ARGON2I_INT", "RAW"]] = None wallet_name: Optional[str] = None wallet_type: Optional[Literal["askar", "in_memory", "indy"]] = None wallet_webhook_urls: Optional[List[str]] = None @@ -43,6 +45,9 @@ def __init__( label: Optional[str] = None, wallet_dispatch_type: Optional[Literal["default", "both", "base"]] = None, wallet_key: Optional[str] = None, + wallet_key_derivation: Optional[ + Literal["ARGON2I_MOD", "ARGON2I_INT", "RAW"] + ] = None, wallet_name: Optional[str] = None, wallet_type: Optional[Literal["askar", "in_memory", "indy"]] = None, wallet_webhook_urls: Optional[List[str]] = None, @@ -54,6 +59,7 @@ def __init__( label=label, wallet_dispatch_type=wallet_dispatch_type, wallet_key=wallet_key, + wallet_key_derivation=wallet_key_derivation, wallet_name=wallet_name, wallet_type=wallet_type, wallet_webhook_urls=wallet_webhook_urls, diff --git a/aries_cloudcontroller/model/cred_rev_indy_records_result.py b/aries_cloudcontroller/model/cred_rev_indy_records_result.py new file mode 100644 index 000000000..5ef877ecc --- /dev/null +++ b/aries_cloudcontroller/model/cred_rev_indy_records_result.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +from __future__ import annotations + +from datetime import date, datetime # noqa: F401 + +import re # noqa: F401 +from typing import Any, Dict, List, Optional, Union, Literal # noqa: F401 + +from pydantic import AnyUrl, BaseModel, EmailStr, validator, Field, Extra # noqa: F401 + + +class CredRevIndyRecordsResult(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + + Do not edit the class manually. + + CredRevIndyRecordsResult - a model defined in OpenAPI + rev_reg_delta: Indy revocation registry delta [Optional]. + """ + + rev_reg_delta: Optional[Dict[str, Any]] = None + + def __init__( + self, + *, + rev_reg_delta: Optional[Dict[str, Any]] = None, + **kwargs, + ): + super().__init__( + rev_reg_delta=rev_reg_delta, + **kwargs, + ) + + class Config: + allow_population_by_field_name = True + + +CredRevIndyRecordsResult.update_forward_refs() diff --git a/aries_cloudcontroller/model/cred_rev_record_details_result.py b/aries_cloudcontroller/model/cred_rev_record_details_result.py new file mode 100644 index 000000000..f18b92844 --- /dev/null +++ b/aries_cloudcontroller/model/cred_rev_record_details_result.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +from __future__ import annotations + +from datetime import date, datetime # noqa: F401 + +import re # noqa: F401 +from typing import Any, Dict, List, Optional, Union, Literal # noqa: F401 + +from pydantic import AnyUrl, BaseModel, EmailStr, validator, Field, Extra # noqa: F401 +from aries_cloudcontroller.model.issuer_cred_rev_record import IssuerCredRevRecord + + +class CredRevRecordDetailsResult(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + + Do not edit the class manually. + + CredRevRecordDetailsResult - a model defined in OpenAPI + results: The results of this CredRevRecordDetailsResult [Optional]. + """ + + results: Optional[List[IssuerCredRevRecord]] = None + + def __init__( + self, + *, + results: Optional[List[IssuerCredRevRecord]] = None, + **kwargs, + ): + super().__init__( + results=results, + **kwargs, + ) + + class Config: + allow_population_by_field_name = True + + +CredRevRecordDetailsResult.update_forward_refs() diff --git a/aries_cloudcontroller/model/dif_proof_proposal.py b/aries_cloudcontroller/model/dif_proof_proposal.py index 23d516f4a..f5bfe05ed 100644 --- a/aries_cloudcontroller/model/dif_proof_proposal.py +++ b/aries_cloudcontroller/model/dif_proof_proposal.py @@ -8,6 +8,7 @@ from typing import Any, Dict, List, Optional, Union, Literal # noqa: F401 from pydantic import AnyUrl, BaseModel, EmailStr, validator, Field, Extra # noqa: F401 +from aries_cloudcontroller.model.dif_options import DIFOptions from aries_cloudcontroller.model.input_descriptors import InputDescriptors @@ -18,18 +19,22 @@ class DIFProofProposal(BaseModel): DIFProofProposal - a model defined in OpenAPI input_descriptors: The input_descriptors of this DIFProofProposal [Optional]. + options: The options of this DIFProofProposal [Optional]. """ input_descriptors: Optional[List[InputDescriptors]] = None + options: Optional[DIFOptions] = None def __init__( self, *, input_descriptors: Optional[List[InputDescriptors]] = None, + options: Optional[DIFOptions] = None, **kwargs, ): super().__init__( input_descriptors=input_descriptors, + options=options, **kwargs, ) diff --git a/aries_cloudcontroller/model/invitation_record.py b/aries_cloudcontroller/model/invitation_record.py index 2cea61fa4..f006669cb 100644 --- a/aries_cloudcontroller/model/invitation_record.py +++ b/aries_cloudcontroller/model/invitation_record.py @@ -22,6 +22,7 @@ class InvitationRecord(BaseModel): invitation: Out of band invitation message [Optional]. invitation_id: Invitation record identifier [Optional]. invitation_url: Invitation message URL [Optional]. + oob_id: Out of band record identifier [Optional]. state: Out of band message exchange state [Optional]. trace: Record trace information, based on agent configuration [Optional]. updated_at: Time of last record update [Optional]. @@ -32,6 +33,7 @@ class InvitationRecord(BaseModel): invitation: Optional[InvitationMessage] = None invitation_id: Optional[str] = None invitation_url: Optional[str] = None + oob_id: Optional[str] = None state: Optional[str] = None trace: Optional[bool] = None updated_at: Optional[str] = None @@ -44,6 +46,7 @@ def __init__( invitation: Optional[InvitationMessage] = None, invitation_id: Optional[str] = None, invitation_url: Optional[str] = None, + oob_id: Optional[str] = None, state: Optional[str] = None, trace: Optional[bool] = None, updated_at: Optional[str] = None, @@ -55,6 +58,7 @@ def __init__( invitation=invitation, invitation_id=invitation_id, invitation_url=invitation_url, + oob_id=oob_id, state=state, trace=trace, updated_at=updated_at, diff --git a/aries_cloudcontroller/model/rev_reg_wallet_updated_result.py b/aries_cloudcontroller/model/rev_reg_wallet_updated_result.py new file mode 100644 index 000000000..cbeac353b --- /dev/null +++ b/aries_cloudcontroller/model/rev_reg_wallet_updated_result.py @@ -0,0 +1,47 @@ +# coding: utf-8 + +from __future__ import annotations + +from datetime import date, datetime # noqa: F401 + +import re # noqa: F401 +from typing import Any, Dict, List, Optional, Union, Literal # noqa: F401 + +from pydantic import AnyUrl, BaseModel, EmailStr, validator, Field, Extra # noqa: F401 + + +class RevRegWalletUpdatedResult(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + + Do not edit the class manually. + + RevRegWalletUpdatedResult - a model defined in OpenAPI + accum_calculated: Calculated accumulator for phantom revocations [Optional]. + accum_fixed: Applied ledger transaction to fix revocations [Optional]. + rev_reg_delta: Indy revocation registry delta [Optional]. + """ + + accum_calculated: Optional[Dict[str, Any]] = None + accum_fixed: Optional[Dict[str, Any]] = None + rev_reg_delta: Optional[Dict[str, Any]] = None + + def __init__( + self, + *, + accum_calculated: Optional[Dict[str, Any]] = None, + accum_fixed: Optional[Dict[str, Any]] = None, + rev_reg_delta: Optional[Dict[str, Any]] = None, + **kwargs, + ): + super().__init__( + accum_calculated=accum_calculated, + accum_fixed=accum_fixed, + rev_reg_delta=rev_reg_delta, + **kwargs, + ) + + class Config: + allow_population_by_field_name = True + + +RevRegWalletUpdatedResult.update_forward_refs() diff --git a/aries_cloudcontroller/model/revoke_request.py b/aries_cloudcontroller/model/revoke_request.py index 9cc9035df..9d53d1180 100644 --- a/aries_cloudcontroller/model/revoke_request.py +++ b/aries_cloudcontroller/model/revoke_request.py @@ -21,6 +21,7 @@ class RevokeRequest(BaseModel): cred_ex_id: Credential exchange identifier [Optional]. cred_rev_id: Credential revocation identifier [Optional]. notify: Send a notification to the credential recipient [Optional]. + notify_version: Specify which version of the revocation notification should be sent [Optional]. publish: (True) publish revocation to ledger immediately, or (default, False) mark it pending [Optional]. rev_reg_id: Revocation registry identifier [Optional]. thread_id: Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true [Optional]. @@ -31,6 +32,7 @@ class RevokeRequest(BaseModel): cred_ex_id: Optional[str] = None cred_rev_id: Optional[str] = None notify: Optional[bool] = None + notify_version: Optional[Literal["v1_0", "v2_0"]] = None publish: Optional[bool] = None rev_reg_id: Optional[str] = None thread_id: Optional[str] = None @@ -43,6 +45,7 @@ def __init__( cred_ex_id: Optional[str] = None, cred_rev_id: Optional[str] = None, notify: Optional[bool] = None, + notify_version: Optional[Literal["v1_0", "v2_0"]] = None, publish: Optional[bool] = None, rev_reg_id: Optional[str] = None, thread_id: Optional[str] = None, @@ -54,6 +57,7 @@ def __init__( cred_ex_id=cred_ex_id, cred_rev_id=cred_rev_id, notify=notify, + notify_version=notify_version, publish=publish, rev_reg_id=rev_reg_id, thread_id=thread_id, diff --git a/aries_cloudcontroller/model/txn_or_register_ledger_nym_response.py b/aries_cloudcontroller/model/txn_or_register_ledger_nym_response.py new file mode 100644 index 000000000..d78769790 --- /dev/null +++ b/aries_cloudcontroller/model/txn_or_register_ledger_nym_response.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +from __future__ import annotations + +from datetime import date, datetime # noqa: F401 + +import re # noqa: F401 +from typing import Any, Dict, List, Optional, Union, Literal # noqa: F401 + +from pydantic import AnyUrl, BaseModel, EmailStr, validator, Field, Extra # noqa: F401 +from aries_cloudcontroller.model.transaction_record import TransactionRecord + + +class TxnOrRegisterLedgerNymResponse(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + + Do not edit the class manually. + + TxnOrRegisterLedgerNymResponse - a model defined in OpenAPI + success: Success of nym registration operation [Optional]. + txn: DID transaction to endorse [Optional]. + """ + + success: Optional[bool] = None + txn: Optional[TransactionRecord] = None + + def __init__( + self, + *, + success: Optional[bool] = None, + txn: Optional[TransactionRecord] = None, + **kwargs, + ): + super().__init__( + success=success, + txn=txn, + **kwargs, + ) + + class Config: + allow_population_by_field_name = True + + +TxnOrRegisterLedgerNymResponse.update_forward_refs() diff --git a/aries_cloudcontroller/model/v10_presentation_create_request_request.py b/aries_cloudcontroller/model/v10_presentation_create_request_request.py index 15f09a549..a8812b03d 100644 --- a/aries_cloudcontroller/model/v10_presentation_create_request_request.py +++ b/aries_cloudcontroller/model/v10_presentation_create_request_request.py @@ -18,11 +18,13 @@ class V10PresentationCreateRequestRequest(BaseModel): V10PresentationCreateRequestRequest - a model defined in OpenAPI proof_request: The proof_request of this V10PresentationCreateRequestRequest. + auto_verify: Verifier choice to auto-verify proof presentation [Optional]. comment: The comment of this V10PresentationCreateRequestRequest [Optional]. trace: Whether to trace event (default false) [Optional]. """ proof_request: IndyProofRequest + auto_verify: Optional[bool] = None comment: Optional[str] = None trace: Optional[bool] = None @@ -30,11 +32,13 @@ def __init__( self, *, proof_request: IndyProofRequest = None, + auto_verify: Optional[bool] = None, comment: Optional[str] = None, trace: Optional[bool] = None, **kwargs, ): super().__init__( + auto_verify=auto_verify, comment=comment, proof_request=proof_request, trace=trace, diff --git a/aries_cloudcontroller/model/v10_presentation_exchange.py b/aries_cloudcontroller/model/v10_presentation_exchange.py index 19dc132be..cfa483c78 100644 --- a/aries_cloudcontroller/model/v10_presentation_exchange.py +++ b/aries_cloudcontroller/model/v10_presentation_exchange.py @@ -21,6 +21,7 @@ class V10PresentationExchange(BaseModel): V10PresentationExchange - a model defined in OpenAPI auto_present: Prover choice to auto-present proof as verifier requests [Optional]. + auto_verify: Verifier choice to auto-verify proof presentation [Optional]. connection_id: Connection identifier [Optional]. created_at: Time of record creation [Optional]. error_msg: Error message [Optional]. @@ -39,6 +40,7 @@ class V10PresentationExchange(BaseModel): """ auto_present: Optional[bool] = None + auto_verify: Optional[bool] = None connection_id: Optional[str] = None created_at: Optional[str] = None error_msg: Optional[str] = None @@ -59,6 +61,7 @@ def __init__( self, *, auto_present: Optional[bool] = None, + auto_verify: Optional[bool] = None, connection_id: Optional[str] = None, created_at: Optional[str] = None, error_msg: Optional[str] = None, @@ -78,6 +81,7 @@ def __init__( ): super().__init__( auto_present=auto_present, + auto_verify=auto_verify, connection_id=connection_id, created_at=created_at, error_msg=error_msg, diff --git a/aries_cloudcontroller/model/v10_presentation_send_request_request.py b/aries_cloudcontroller/model/v10_presentation_send_request_request.py index ea5f03824..ce04838f5 100644 --- a/aries_cloudcontroller/model/v10_presentation_send_request_request.py +++ b/aries_cloudcontroller/model/v10_presentation_send_request_request.py @@ -19,12 +19,14 @@ class V10PresentationSendRequestRequest(BaseModel): V10PresentationSendRequestRequest - a model defined in OpenAPI connection_id: Connection identifier. proof_request: The proof_request of this V10PresentationSendRequestRequest. + auto_verify: Verifier choice to auto-verify proof presentation [Optional]. comment: The comment of this V10PresentationSendRequestRequest [Optional]. trace: Whether to trace event (default false) [Optional]. """ connection_id: str proof_request: IndyProofRequest + auto_verify: Optional[bool] = None comment: Optional[str] = None trace: Optional[bool] = None @@ -33,11 +35,13 @@ def __init__( *, connection_id: str = None, proof_request: IndyProofRequest = None, + auto_verify: Optional[bool] = None, comment: Optional[str] = None, trace: Optional[bool] = None, **kwargs, ): super().__init__( + auto_verify=auto_verify, comment=comment, connection_id=connection_id, proof_request=proof_request, diff --git a/aries_cloudcontroller/model/v10_presentation_send_request_to_proposal.py b/aries_cloudcontroller/model/v10_presentation_send_request_to_proposal.py new file mode 100644 index 000000000..eef6fe2db --- /dev/null +++ b/aries_cloudcontroller/model/v10_presentation_send_request_to_proposal.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +from __future__ import annotations + +from datetime import date, datetime # noqa: F401 + +import re # noqa: F401 +from typing import Any, Dict, List, Optional, Union, Literal # noqa: F401 + +from pydantic import AnyUrl, BaseModel, EmailStr, validator, Field, Extra # noqa: F401 + + +class V10PresentationSendRequestToProposal(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + + Do not edit the class manually. + + V10PresentationSendRequestToProposal - a model defined in OpenAPI + auto_verify: Verifier choice to auto-verify proof presentation [Optional]. + trace: Whether to trace event (default false) [Optional]. + """ + + auto_verify: Optional[bool] = None + trace: Optional[bool] = None + + def __init__( + self, + *, + auto_verify: Optional[bool] = None, + trace: Optional[bool] = None, + **kwargs, + ): + super().__init__( + auto_verify=auto_verify, + trace=trace, + **kwargs, + ) + + class Config: + allow_population_by_field_name = True + + +V10PresentationSendRequestToProposal.update_forward_refs() diff --git a/aries_cloudcontroller/model/v20_cred_ex_record.py b/aries_cloudcontroller/model/v20_cred_ex_record.py index 60915f0d4..9dec7ee4f 100644 --- a/aries_cloudcontroller/model/v20_cred_ex_record.py +++ b/aries_cloudcontroller/model/v20_cred_ex_record.py @@ -74,6 +74,7 @@ class V20CredExRecord(BaseModel): "credential-received", "done", "credential-revoked", + "abandoned", ] ] = None thread_id: Optional[str] = None @@ -111,6 +112,7 @@ def __init__( "credential-received", "done", "credential-revoked", + "abandoned", ] ] = None, thread_id: Optional[str] = None, diff --git a/aries_cloudcontroller/model/v20_pres_create_request_request.py b/aries_cloudcontroller/model/v20_pres_create_request_request.py index b09a8a203..080b04e18 100644 --- a/aries_cloudcontroller/model/v20_pres_create_request_request.py +++ b/aries_cloudcontroller/model/v20_pres_create_request_request.py @@ -20,11 +20,13 @@ class V20PresCreateRequestRequest(BaseModel): V20PresCreateRequestRequest - a model defined in OpenAPI presentation_request: The presentation_request of this V20PresCreateRequestRequest. + auto_verify: Verifier choice to auto-verify proof presentation [Optional]. comment: The comment of this V20PresCreateRequestRequest [Optional]. trace: Whether to trace event (default false) [Optional]. """ presentation_request: V20PresRequestByFormat + auto_verify: Optional[bool] = None comment: Optional[str] = None trace: Optional[bool] = None @@ -32,11 +34,13 @@ def __init__( self, *, presentation_request: V20PresRequestByFormat = None, + auto_verify: Optional[bool] = None, comment: Optional[str] = None, trace: Optional[bool] = None, **kwargs, ): super().__init__( + auto_verify=auto_verify, comment=comment, presentation_request=presentation_request, trace=trace, diff --git a/aries_cloudcontroller/model/v20_pres_ex_record.py b/aries_cloudcontroller/model/v20_pres_ex_record.py index fd3122f4d..aed49610f 100644 --- a/aries_cloudcontroller/model/v20_pres_ex_record.py +++ b/aries_cloudcontroller/model/v20_pres_ex_record.py @@ -23,6 +23,7 @@ class V20PresExRecord(BaseModel): V20PresExRecord - a model defined in OpenAPI auto_present: Prover choice to auto-present proof as verifier requests [Optional]. + auto_verify: Verifier choice to auto-verify proof presentation [Optional]. by_format: Attachment content by format for proposal, request, and presentation [Optional]. connection_id: Connection identifier [Optional]. created_at: Time of record creation [Optional]. @@ -41,6 +42,7 @@ class V20PresExRecord(BaseModel): """ auto_present: Optional[bool] = None + auto_verify: Optional[bool] = None by_format: Optional[V20PresExRecordByFormat] = None connection_id: Optional[str] = None created_at: Optional[str] = None @@ -72,6 +74,7 @@ def __init__( self, *, auto_present: Optional[bool] = None, + auto_verify: Optional[bool] = None, by_format: Optional[V20PresExRecordByFormat] = None, connection_id: Optional[str] = None, created_at: Optional[str] = None, @@ -102,6 +105,7 @@ def __init__( ): super().__init__( auto_present=auto_present, + auto_verify=auto_verify, by_format=by_format, connection_id=connection_id, created_at=created_at, diff --git a/aries_cloudcontroller/model/v20_pres_send_request_request.py b/aries_cloudcontroller/model/v20_pres_send_request_request.py index 8c996eb68..015546eb2 100644 --- a/aries_cloudcontroller/model/v20_pres_send_request_request.py +++ b/aries_cloudcontroller/model/v20_pres_send_request_request.py @@ -21,12 +21,14 @@ class V20PresSendRequestRequest(BaseModel): V20PresSendRequestRequest - a model defined in OpenAPI connection_id: Connection identifier. presentation_request: The presentation_request of this V20PresSendRequestRequest. + auto_verify: Verifier choice to auto-verify proof presentation [Optional]. comment: The comment of this V20PresSendRequestRequest [Optional]. trace: Whether to trace event (default false) [Optional]. """ connection_id: str presentation_request: V20PresRequestByFormat + auto_verify: Optional[bool] = None comment: Optional[str] = None trace: Optional[bool] = None @@ -35,11 +37,13 @@ def __init__( *, connection_id: str = None, presentation_request: V20PresRequestByFormat = None, + auto_verify: Optional[bool] = None, comment: Optional[str] = None, trace: Optional[bool] = None, **kwargs, ): super().__init__( + auto_verify=auto_verify, comment=comment, connection_id=connection_id, presentation_request=presentation_request, diff --git a/aries_cloudcontroller/model/v20_presentation_send_request_to_proposal.py b/aries_cloudcontroller/model/v20_presentation_send_request_to_proposal.py new file mode 100644 index 000000000..4eed9aa8a --- /dev/null +++ b/aries_cloudcontroller/model/v20_presentation_send_request_to_proposal.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +from __future__ import annotations + +from datetime import date, datetime # noqa: F401 + +import re # noqa: F401 +from typing import Any, Dict, List, Optional, Union, Literal # noqa: F401 + +from pydantic import AnyUrl, BaseModel, EmailStr, validator, Field, Extra # noqa: F401 + + +class V20PresentationSendRequestToProposal(BaseModel): + """NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + + Do not edit the class manually. + + V20PresentationSendRequestToProposal - a model defined in OpenAPI + auto_verify: Verifier choice to auto-verify proof presentation [Optional]. + trace: Whether to trace event (default false) [Optional]. + """ + + auto_verify: Optional[bool] = None + trace: Optional[bool] = None + + def __init__( + self, + *, + auto_verify: Optional[bool] = None, + trace: Optional[bool] = None, + **kwargs, + ): + super().__init__( + auto_verify=auto_verify, + trace=trace, + **kwargs, + ) + + class Config: + allow_population_by_field_name = True + + +V20PresentationSendRequestToProposal.update_forward_refs() diff --git a/generator/data/openapi.patch b/generator/data/openapi.patch index 878798a20..b8f1dc149 100644 --- a/generator/data/openapi.patch +++ b/generator/data/openapi.patch @@ -1,8 +1,8 @@ diff --git a/generator/data/openapi.yml b/generator/data/openapi.yml -index 29a1393..7fea529 100644 +index b438b6c..12ed983 100644 --- a/generator/data/openapi.yml +++ b/generator/data/openapi.yml -@@ -710,7 +710,9 @@ paths: +@@ -722,7 +722,9 @@ paths: content: application/json: schema: @@ -13,7 +13,7 @@ index 29a1393..7fea529 100644 x-codegen-request-body-name: body operationId: publish_cred_def /credential-definitions/created: -@@ -3422,7 +3424,9 @@ paths: +@@ -3447,7 +3449,9 @@ paths: content: application/json: schema: @@ -24,7 +24,7 @@ index 29a1393..7fea529 100644 x-codegen-request-body-name: body operationId: publish_revocations /revocation/registries/created: -@@ -3533,7 +3537,9 @@ paths: +@@ -3558,7 +3562,9 @@ paths: content: application/json: schema: @@ -35,7 +35,7 @@ index 29a1393..7fea529 100644 operationId: publish_rev_reg_def /revocation/registry/{rev_reg_id}/entry: post: -@@ -3710,7 +3716,9 @@ paths: +@@ -3801,7 +3807,9 @@ paths: content: application/json: schema: @@ -46,7 +46,7 @@ index 29a1393..7fea529 100644 x-codegen-request-body-name: body operationId: publish_schema /schemas/created: -@@ -5148,7 +5156,8 @@ components: +@@ -5281,7 +5289,8 @@ components: description: Tag within credential definition identifier example: tag type: @@ -56,7 +56,7 @@ index 29a1393..7fea529 100644 description: 'Signature type: CL for Camenisch-Lysyanskaya' example: CL value: -@@ -5190,6 +5199,8 @@ components: +@@ -5323,6 +5332,8 @@ components: example: default CredentialDefinitionSendResult: type: object @@ -65,7 +65,7 @@ index 29a1393..7fea529 100644 properties: credential_definition_id: pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$ -@@ -6025,14 +6036,12 @@ components: +@@ -6160,14 +6171,12 @@ components: type: object properties: from: @@ -80,7 +80,7 @@ index 29a1393..7fea529 100644 minimum: 0 type: integer description: Latest time of interest in non-revocation interval -@@ -6194,7 +6203,6 @@ components: +@@ -6329,7 +6338,6 @@ components: description: Schema identifier example: WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0 timestamp: @@ -88,7 +88,7 @@ index 29a1393..7fea529 100644 minimum: 0 type: integer description: Timestamp epoch -@@ -6275,18 +6283,14 @@ components: +@@ -6410,18 +6418,14 @@ components: type: object properties: from: @@ -107,7 +107,7 @@ index 29a1393..7fea529 100644 example: 1640995199 IndyProofReqPredSpec: required: -@@ -6332,18 +6336,14 @@ components: +@@ -6467,18 +6471,14 @@ components: type: object properties: from: @@ -126,7 +126,7 @@ index 29a1393..7fea529 100644 example: 1640995199 IndyProofRequest: required: -@@ -6384,18 +6384,14 @@ components: +@@ -6519,18 +6519,14 @@ components: type: object properties: from: @@ -145,7 +145,7 @@ index 29a1393..7fea529 100644 example: 1640995199 IndyProofRequestedProof: type: object -@@ -6483,11 +6479,9 @@ components: +@@ -6618,11 +6614,9 @@ components: a UUID) example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 timestamp: @@ -157,7 +157,7 @@ index 29a1393..7fea529 100644 example: 1640995199 IndyRevRegDef: type: object -@@ -6705,9 +6699,11 @@ components: +@@ -6840,9 +6834,11 @@ components: type: string - did:sov:WgWxqztrNooG92RXvxSTWv items: @@ -172,7 +172,7 @@ index 29a1393..7fea529 100644 InvitationRecord: type: object properties: -@@ -7652,6 +7648,8 @@ components: +@@ -7784,6 +7780,8 @@ components: example: 0 RevRegResult: type: object @@ -181,7 +181,7 @@ index 29a1393..7fea529 100644 properties: result: $ref: '#/components/schemas/IssuerRevRegRecord' -@@ -7819,6 +7817,7 @@ components: +@@ -7973,6 +7971,7 @@ components: SchemaSendResult: required: - schema_id @@ -189,7 +189,7 @@ index 29a1393..7fea529 100644 type: object properties: schema: -@@ -7969,10 +7968,7 @@ components: +@@ -8123,10 +8122,7 @@ components: mechanism: type: string time: @@ -200,7 +200,7 @@ index 29a1393..7fea529 100644 example: 1640995199 TAAInfo: type: object -@@ -8127,6 +8123,7 @@ components: +@@ -8281,6 +8277,7 @@ components: example: 2021-12-31 23:59:59+00:00 TxnOrCredentialDefinitionSendResult: type: object @@ -208,7 +208,7 @@ index 29a1393..7fea529 100644 properties: sent: $ref: '#/components/schemas/CredentialDefinitionSendResult' -@@ -8137,6 +8134,7 @@ components: +@@ -8291,6 +8288,7 @@ components: - $ref: '#/components/schemas/TransactionRecord' TxnOrPublishRevocationsResult: type: object @@ -216,7 +216,7 @@ index 29a1393..7fea529 100644 properties: sent: $ref: '#/components/schemas/PublishRevocations' -@@ -8147,6 +8145,7 @@ components: +@@ -8313,6 +8311,7 @@ components: - $ref: '#/components/schemas/TransactionRecord' TxnOrRevRegResult: type: object @@ -224,7 +224,7 @@ index 29a1393..7fea529 100644 properties: sent: $ref: '#/components/schemas/RevRegResult' -@@ -8157,6 +8156,7 @@ components: +@@ -8323,6 +8322,7 @@ components: - $ref: '#/components/schemas/TransactionRecord' TxnOrSchemaSendResult: type: object diff --git a/setup.py b/setup.py index 2fedfd995..3d0560636 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ def parse_requirements(filename: str): if __name__ == "__main__": setup( name=PACKAGE_NAME, - version="0.5.3", + version="0.5.4", description="A simple python package for controlling an aries agent through the admin-api interface", long_description=long_description, long_description_content_type="text/markdown", From f7e7b1344a7a02241172c516242c9aa0975104cd Mon Sep 17 00:00:00 2001 From: Moriarty Date: Tue, 20 Sep 2022 13:24:37 +0200 Subject: [PATCH 3/5] chore: code review fedback bump version 0.6 instead of minor due to breaking changes Signed-off-by: Moriarty --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 3d0560636..977f45cdd 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ def parse_requirements(filename: str): if __name__ == "__main__": setup( name=PACKAGE_NAME, - version="0.5.4", + version="0.6.0", description="A simple python package for controlling an aries agent through the admin-api interface", long_description=long_description, long_description_content_type="text/markdown", From 13dfafb1087a1bbee91be24b0aefa5948cd8cc50 Mon Sep 17 00:00:00 2001 From: Moriarty Date: Wed, 21 Sep 2022 13:22:48 +0200 Subject: [PATCH 4/5] chore: code review feedback Signed-off-by: Moriarty --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 607bc9015..31ff5f629 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ Each Cloud Controller version maps to a specific ACA-Py version, which is outlin | Aries Cloud Controller Version | Aries Cloud Agent Python Version | | ------------------------------ | -------------------------------- | | 0.5.1-0.5.2 | 0.7.3 | +| 0.6.0 | 0.7.4 | ## Features From bbcd0cbed5b130ac86d669f73804d7378eb86f3d Mon Sep 17 00:00:00 2001 From: Moriarty Date: Thu, 22 Sep 2022 09:14:53 +0200 Subject: [PATCH 5/5] chore: fix missing import in init generator did not pick up acapyclient to expose via init Signed-off-by: Moriarty --- README.md | 2 +- aries_cloudcontroller/__init__.py | 3 +++ setup.py | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 31ff5f629..95517dbb6 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Each Cloud Controller version maps to a specific ACA-Py version, which is outlin | Aries Cloud Controller Version | Aries Cloud Agent Python Version | | ------------------------------ | -------------------------------- | | 0.5.1-0.5.2 | 0.7.3 | -| 0.6.0 | 0.7.4 | +| 0.6.0-0.6.1 | 0.7.4 | ## Features diff --git a/aries_cloudcontroller/__init__.py b/aries_cloudcontroller/__init__.py index dc8bd9c2f..2c84e6df8 100644 --- a/aries_cloudcontroller/__init__.py +++ b/aries_cloudcontroller/__init__.py @@ -1,3 +1,5 @@ +from aries_cloudcontroller.acapy_client import AcaPyClient + from aries_cloudcontroller.api import ( ActionMenuApi, BasicmessageApi, @@ -298,6 +300,7 @@ ) __all__ = [ + "AcaPyClient", "AMLRecord", "ActionMenuFetchResult", "AdminConfig", diff --git a/setup.py b/setup.py index 977f45cdd..4926aa595 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ def parse_requirements(filename: str): if __name__ == "__main__": setup( name=PACKAGE_NAME, - version="0.6.0", + version="0.6.1", description="A simple python package for controlling an aries agent through the admin-api interface", long_description=long_description, long_description_content_type="text/markdown",