Skip to content

My-DIGI-ID/acapy-client

BranchesTags

Repository files navigation

acapy-client

IBM-Deutschland

  • API version: v0.7.0

  • Build date: 2021-11-08T11:11:35.214106+01:00[Europe/Berlin]

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.my_digi_id</groupId>
  <artifactId>acapy-client</artifactId>
  <version>0.7.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.my_digi_id:acapy-client:0.7.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/acapy-client-0.7.0.jar
  • target/lib/*.jar

Usage

To add a HTTP proxy for the API client, use ClientConfig:

import org.glassfish.jersey.apache.connector.ApacheConnectorProvider;
import org.glassfish.jersey.client.ClientConfig;
import org.glassfish.jersey.client.ClientProperties;
import com.my_digi_id.acapy_client.invoker.*;
import com.my_digi_id.acapy_client.api.ActionMenuApi;

...

ApiClient defaultClient = Configuration.getDefaultApiClient();
ClientConfig clientConfig = defaultClient.getClientConfig();
clientConfig.connectorProvider(new ApacheConnectorProvider());
clientConfig.property(ClientProperties.PROXY_URI, "http://proxy_url_here");
clientConfig.property(ClientProperties.PROXY_USERNAME, "proxy_username");
clientConfig.property(ClientProperties.PROXY_PASSWORD, "proxy_password");
defaultClient.setClientConfig(clientConfig);

ActionMenuApi apiInstance = new ActionMenuApi(defaultClient);

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.my_digi_id.acapy_client.invoker.*;
import com.my_digi_id.acapy_client.invoker.auth.*;
import com.my_digi_id.acapy_client.model.*;
import com.my_digi_id.acapy_client.api.ActionMenuApi;

public class ActionMenuApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        ActionMenuApi apiInstance = new ActionMenuApi(defaultClient);
        String connId = "connId_example"; // String | Connection identifier
        try {
            Object result = apiInstance.actionMenuConnIdClosePost(connId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActionMenuApi#actionMenuConnIdClosePost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ActionMenuApi actionMenuConnIdClosePost POST /action-menu/{conn_id}/close Close the active menu associated with a connection
ActionMenuApi actionMenuConnIdFetchPost POST /action-menu/{conn_id}/fetch Fetch the active menu
ActionMenuApi actionMenuConnIdPerformPost POST /action-menu/{conn_id}/perform Perform an action associated with the active menu
ActionMenuApi actionMenuConnIdRequestPost POST /action-menu/{conn_id}/request Request the active menu
ActionMenuApi actionMenuConnIdSendMenuPost POST /action-menu/{conn_id}/send-menu Send an action menu to a connection
BasicmessageApi connectionsConnIdSendMessagePost POST /connections/{conn_id}/send-message Send a basic message to a connection
ConnectionApi connectionsConnIdAcceptInvitationPost POST /connections/{conn_id}/accept-invitation Accept a stored connection invitation
ConnectionApi connectionsConnIdAcceptRequestPost POST /connections/{conn_id}/accept-request Accept a stored connection request
ConnectionApi connectionsConnIdDelete DELETE /connections/{conn_id} Remove an existing connection record
ConnectionApi connectionsConnIdEndpointsGet GET /connections/{conn_id}/endpoints Fetch connection remote endpoint
ConnectionApi connectionsConnIdEstablishInboundRefIdPost POST /connections/{conn_id}/establish-inbound/{ref_id} Assign another connection as the inbound connection
ConnectionApi connectionsConnIdGet GET /connections/{conn_id} Fetch a single connection record
ConnectionApi connectionsConnIdMetadataGet GET /connections/{conn_id}/metadata Fetch connection metadata
ConnectionApi connectionsConnIdMetadataPost POST /connections/{conn_id}/metadata Set connection metadata
ConnectionApi connectionsCreateInvitationPost POST /connections/create-invitation Create a new connection invitation
ConnectionApi connectionsCreateStaticPost POST /connections/create-static Create a new static connection
ConnectionApi connectionsGet GET /connections Query agent-to-agent connections
ConnectionApi connectionsReceiveInvitationPost POST /connections/receive-invitation Receive a new connection invitation
CredentialDefinitionApi credentialDefinitionsCreatedGet GET /credential-definitions/created Search for matching credential definitions that agent originated
CredentialDefinitionApi credentialDefinitionsCredDefIdGet GET /credential-definitions/{cred_def_id} Gets a credential definition from the ledger
CredentialDefinitionApi credentialDefinitionsPost POST /credential-definitions Sends a credential definition to the ledger
CredentialsApi credentialCredentialIdDelete DELETE /credential/{credential_id} Remove credential from wallet by id
CredentialsApi credentialCredentialIdGet GET /credential/{credential_id} Fetch credential from wallet by id
CredentialsApi credentialMimeTypesCredentialIdGet GET /credential/mime-types/{credential_id} Get attribute MIME types from wallet
CredentialsApi credentialRevokedCredentialIdGet GET /credential/revoked/{credential_id} Query credential revocation status by id
CredentialsApi credentialW3cCredentialIdDelete DELETE /credential/w3c/{credential_id} Remove W3C credential from wallet by id
CredentialsApi credentialW3cCredentialIdGet GET /credential/w3c/{credential_id} Fetch W3C credential from wallet by id
CredentialsApi credentialsGet GET /credentials Fetch credentials from wallet
CredentialsApi credentialsW3cPost POST /credentials/w3c Fetch W3C credentials from wallet
DidExchangeApi didexchangeConnIdAcceptInvitationPost POST /didexchange/{conn_id}/accept-invitation Accept a stored connection invitation
DidExchangeApi didexchangeConnIdAcceptRequestPost POST /didexchange/{conn_id}/accept-request Accept a stored connection request
DidExchangeApi didexchangeCreateRequestPost POST /didexchange/create-request Create and send a request against public DID's implicit invitation
DidExchangeApi didexchangeReceiveRequestPost POST /didexchange/receive-request Receive request against public DID's implicit invitation
EndorseTransactionApi transactionTranIdResendPost POST /transaction/{tran_id}/resend For Author to resend a particular transaction request
EndorseTransactionApi transactionsConnIdSetEndorserInfoPost POST /transactions/{conn_id}/set-endorser-info Set Endorser Info
EndorseTransactionApi transactionsConnIdSetEndorserRolePost POST /transactions/{conn_id}/set-endorser-role Set transaction jobs
EndorseTransactionApi transactionsCreateRequestPost POST /transactions/create-request For author to send a transaction request
EndorseTransactionApi transactionsGet GET /transactions Query transactions
EndorseTransactionApi transactionsTranIdCancelPost POST /transactions/{tran_id}/cancel For Author to cancel a particular transaction request
EndorseTransactionApi transactionsTranIdEndorsePost POST /transactions/{tran_id}/endorse For Endorser to endorse a particular transaction record
EndorseTransactionApi transactionsTranIdGet GET /transactions/{tran_id} Fetch a single transaction record
EndorseTransactionApi transactionsTranIdRefusePost POST /transactions/{tran_id}/refuse For Endorser to refuse a particular transaction record
EndorseTransactionApi transactionsTranIdWritePost POST /transactions/{tran_id}/write For Author / Endorser to write an endorsed transaction to the ledger
IntroductionApi connectionsConnIdStartIntroductionPost POST /connections/{conn_id}/start-introduction Start an introduction between two connections
IssueCredentialV10Api issueCredentialCreateOfferPost POST /issue-credential/create-offer Create a credential offer, independent of any proposal or connection
IssueCredentialV10Api issueCredentialCreatePost POST /issue-credential/create Send holder a credential, automating entire flow
IssueCredentialV10Api issueCredentialRecordsCredExIdDelete DELETE /issue-credential/records/{cred_ex_id} Remove an existing credential exchange record
IssueCredentialV10Api issueCredentialRecordsCredExIdGet GET /issue-credential/records/{cred_ex_id} Fetch a single credential exchange record
IssueCredentialV10Api issueCredentialRecordsCredExIdIssuePost POST /issue-credential/records/{cred_ex_id}/issue Send holder a credential
IssueCredentialV10Api issueCredentialRecordsCredExIdProblemReportPost POST /issue-credential/records/{cred_ex_id}/problem-report Send a problem report for credential exchange
IssueCredentialV10Api issueCredentialRecordsCredExIdSendOfferPost POST /issue-credential/records/{cred_ex_id}/send-offer Send holder a credential offer in reference to a proposal with preview
IssueCredentialV10Api issueCredentialRecordsCredExIdSendRequestPost POST /issue-credential/records/{cred_ex_id}/send-request Send issuer a credential request
IssueCredentialV10Api issueCredentialRecordsCredExIdStorePost POST /issue-credential/records/{cred_ex_id}/store Store a received credential
IssueCredentialV10Api issueCredentialRecordsGet GET /issue-credential/records Fetch all credential exchange records
IssueCredentialV10Api issueCredentialSendOfferPost POST /issue-credential/send-offer Send holder a credential offer, independent of any proposal
IssueCredentialV10Api issueCredentialSendPost POST /issue-credential/send Send holder a credential, automating entire flow
IssueCredentialV10Api issueCredentialSendProposalPost POST /issue-credential/send-proposal Send issuer a credential proposal
IssueCredentialV20Api issueCredential20CreateOfferPost POST /issue-credential-2.0/create-offer Create a credential offer, independent of any proposal or connection
IssueCredentialV20Api issueCredential20CreatePost POST /issue-credential-2.0/create Create credential from attribute values
IssueCredentialV20Api issueCredential20RecordsCredExIdDelete DELETE /issue-credential-2.0/records/{cred_ex_id} Remove an existing credential exchange record
IssueCredentialV20Api issueCredential20RecordsCredExIdGet GET /issue-credential-2.0/records/{cred_ex_id} Fetch a single credential exchange record
IssueCredentialV20Api issueCredential20RecordsCredExIdIssuePost POST /issue-credential-2.0/records/{cred_ex_id}/issue Send holder a credential
IssueCredentialV20Api issueCredential20RecordsCredExIdProblemReportPost POST /issue-credential-2.0/records/{cred_ex_id}/problem-report Send a problem report for credential exchange
IssueCredentialV20Api issueCredential20RecordsCredExIdSendOfferPost POST /issue-credential-2.0/records/{cred_ex_id}/send-offer Send holder a credential offer in reference to a proposal with preview
IssueCredentialV20Api issueCredential20RecordsCredExIdSendRequestPost POST /issue-credential-2.0/records/{cred_ex_id}/send-request Send issuer a credential request
IssueCredentialV20Api issueCredential20RecordsCredExIdStorePost POST /issue-credential-2.0/records/{cred_ex_id}/store Store a received credential
IssueCredentialV20Api issueCredential20RecordsGet GET /issue-credential-2.0/records Fetch all credential exchange records
IssueCredentialV20Api issueCredential20SendOfferPost POST /issue-credential-2.0/send-offer Send holder a credential offer, independent of any proposal
IssueCredentialV20Api issueCredential20SendPost POST /issue-credential-2.0/send Send holder a credential, automating entire flow
IssueCredentialV20Api issueCredential20SendProposalPost POST /issue-credential-2.0/send-proposal Send issuer a credential proposal
IssueCredentialV20Api issueCredential20SendRequestPost POST /issue-credential-2.0/send-request Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request
JsonldApi jsonldSignPost POST /jsonld/sign Sign a JSON-LD structure and return it
JsonldApi jsonldVerifyPost POST /jsonld/verify Verify a JSON-LD structure.
LedgerApi ledgerDidEndpointGet GET /ledger/did-endpoint Get the endpoint for a DID from the ledger.
LedgerApi ledgerDidVerkeyGet GET /ledger/did-verkey Get the verkey for a DID from the ledger.
LedgerApi ledgerGetNymRoleGet GET /ledger/get-nym-role Get the role from the NYM registration of a public DID.
LedgerApi ledgerRegisterNymPost POST /ledger/register-nym Send a NYM registration to the ledger.
LedgerApi ledgerRotatePublicDidKeypairPatch PATCH /ledger/rotate-public-did-keypair Rotate key pair for public DID.
LedgerApi ledgerTaaAcceptPost POST /ledger/taa/accept Accept the transaction author agreement
LedgerApi ledgerTaaGet GET /ledger/taa Fetch the current transaction author agreement, if any
MediationApi mediationDefaultMediatorDelete DELETE /mediation/default-mediator Clear default mediator
MediationApi mediationDefaultMediatorGet GET /mediation/default-mediator Get default mediator
MediationApi mediationKeylistsGet GET /mediation/keylists Retrieve keylists by connection or role
MediationApi mediationKeylistsMediationIdSendKeylistQueryPost POST /mediation/keylists/{mediation_id}/send-keylist-query Send keylist query to mediator
MediationApi mediationKeylistsMediationIdSendKeylistUpdatePost POST /mediation/keylists/{mediation_id}/send-keylist-update Send keylist update to mediator
MediationApi mediationMediationIdDefaultMediatorPut PUT /mediation/{mediation_id}/default-mediator Set default mediator
MediationApi mediationRequestConnIdPost POST /mediation/request/{conn_id} Request mediation from connection
MediationApi mediationRequestsGet GET /mediation/requests Query mediation requests, returns list of all mediation records
MediationApi mediationRequestsMediationIdDelete DELETE /mediation/requests/{mediation_id} Delete mediation request by ID
MediationApi mediationRequestsMediationIdDenyPost POST /mediation/requests/{mediation_id}/deny Deny a stored mediation request
MediationApi mediationRequestsMediationIdGet GET /mediation/requests/{mediation_id} Retrieve mediation request record
MediationApi mediationRequestsMediationIdGrantPost POST /mediation/requests/{mediation_id}/grant Grant received mediation
OutOfBandApi outOfBandCreateInvitationPost POST /out-of-band/create-invitation Create a new connection invitation
OutOfBandApi outOfBandReceiveInvitationPost POST /out-of-band/receive-invitation Receive a new connection invitation
PresentProofV10Api presentProofCreateRequestPost POST /present-proof/create-request Creates a presentation request not bound to any proposal or connection
PresentProofV10Api presentProofRecordsGet GET /present-proof/records Fetch all present-proof exchange records
PresentProofV10Api presentProofRecordsPresExIdCredentialsGet GET /present-proof/records/{pres_ex_id}/credentials Fetch credentials for a presentation request from wallet
PresentProofV10Api presentProofRecordsPresExIdDelete DELETE /present-proof/records/{pres_ex_id} Remove an existing presentation exchange record
PresentProofV10Api presentProofRecordsPresExIdGet GET /present-proof/records/{pres_ex_id} Fetch a single presentation exchange record
PresentProofV10Api presentProofRecordsPresExIdProblemReportPost POST /present-proof/records/{pres_ex_id}/problem-report Send a problem report for presentation exchange
PresentProofV10Api presentProofRecordsPresExIdSendPresentationPost POST /present-proof/records/{pres_ex_id}/send-presentation Sends a proof presentation
PresentProofV10Api presentProofRecordsPresExIdSendRequestPost POST /present-proof/records/{pres_ex_id}/send-request Sends a presentation request in reference to a proposal
PresentProofV10Api presentProofRecordsPresExIdVerifyPresentationPost POST /present-proof/records/{pres_ex_id}/verify-presentation Verify a received presentation
PresentProofV10Api presentProofSendProposalPost POST /present-proof/send-proposal Sends a presentation proposal
PresentProofV10Api presentProofSendRequestPost POST /present-proof/send-request Sends a free presentation request not bound to any proposal
PresentProofV20Api presentProof20CreateRequestPost POST /present-proof-2.0/create-request Creates a presentation request not bound to any proposal or connection
PresentProofV20Api presentProof20RecordsGet GET /present-proof-2.0/records Fetch all present-proof exchange records
PresentProofV20Api presentProof20RecordsPresExIdCredentialsGet GET /present-proof-2.0/records/{pres_ex_id}/credentials Fetch credentials from wallet for presentation request
PresentProofV20Api presentProof20RecordsPresExIdDelete DELETE /present-proof-2.0/records/{pres_ex_id} Remove an existing presentation exchange record
PresentProofV20Api presentProof20RecordsPresExIdGet GET /present-proof-2.0/records/{pres_ex_id} Fetch a single presentation exchange record
PresentProofV20Api presentProof20RecordsPresExIdProblemReportPost POST /present-proof-2.0/records/{pres_ex_id}/problem-report Send a problem report for presentation exchange
PresentProofV20Api presentProof20RecordsPresExIdSendPresentationPost POST /present-proof-2.0/records/{pres_ex_id}/send-presentation Sends a proof presentation
PresentProofV20Api presentProof20RecordsPresExIdSendRequestPost POST /present-proof-2.0/records/{pres_ex_id}/send-request Sends a presentation request in reference to a proposal
PresentProofV20Api presentProof20RecordsPresExIdVerifyPresentationPost POST /present-proof-2.0/records/{pres_ex_id}/verify-presentation Verify a received presentation
PresentProofV20Api presentProof20SendProposalPost POST /present-proof-2.0/send-proposal Sends a presentation proposal
PresentProofV20Api presentProof20SendRequestPost POST /present-proof-2.0/send-request Sends a free presentation request not bound to any proposal
ResolverApi resolverResolveDidGet GET /resolver/resolve/{did} Retrieve doc for requested did
RevocationApi revocationActiveRegistryCredDefIdGet GET /revocation/active-registry/{cred_def_id} Get current active revocation registry by credential definition id
RevocationApi revocationClearPendingRevocationsPost POST /revocation/clear-pending-revocations Clear pending revocations
RevocationApi revocationCreateRegistryPost POST /revocation/create-registry Creates a new revocation registry
RevocationApi revocationCredentialRecordGet GET /revocation/credential-record Get credential revocation status
RevocationApi revocationPublishRevocationsPost POST /revocation/publish-revocations Publish pending revocations to ledger
RevocationApi revocationRegistriesCreatedGet GET /revocation/registries/created Search for matching revocation registries that current agent created
RevocationApi revocationRegistryRevRegIdDefinitionPost POST /revocation/registry/{rev_reg_id}/definition Send revocation registry definition to ledger
RevocationApi revocationRegistryRevRegIdEntryPost POST /revocation/registry/{rev_reg_id}/entry Send revocation registry entry to ledger
RevocationApi revocationRegistryRevRegIdGet GET /revocation/registry/{rev_reg_id} Get revocation registry by revocation registry id
RevocationApi revocationRegistryRevRegIdIssuedGet GET /revocation/registry/{rev_reg_id}/issued Get number of credentials issued against revocation registry
RevocationApi revocationRegistryRevRegIdPatch PATCH /revocation/registry/{rev_reg_id} Update revocation registry with new public URI to its tails file
RevocationApi revocationRegistryRevRegIdSetStatePatch PATCH /revocation/registry/{rev_reg_id}/set-state Set revocation registry state manually
RevocationApi revocationRegistryRevRegIdTailsFileGet GET /revocation/registry/{rev_reg_id}/tails-file Download tails file
RevocationApi revocationRegistryRevRegIdTailsFilePut PUT /revocation/registry/{rev_reg_id}/tails-file Upload local tails file to server
RevocationApi revocationRevokePost POST /revocation/revoke Revoke an issued credential
SchemaApi schemasCreatedGet GET /schemas/created Search for matching schema that agent originated
SchemaApi schemasPost POST /schemas Sends a schema to the ledger
SchemaApi schemasSchemaIdGet GET /schemas/{schema_id} Gets a schema from the ledger
ServerApi featuresGet GET /features Query supported features
ServerApi pluginsGet GET /plugins Fetch the list of loaded plugins
ServerApi shutdownGet GET /shutdown Shut down server
ServerApi statusConfigGet GET /status/config Fetch the server configuration
ServerApi statusGet GET /status Fetch the server status
ServerApi statusLiveGet GET /status/live Liveliness check
ServerApi statusReadyGet GET /status/ready Readiness check
ServerApi statusResetPost POST /status/reset Reset statistics
TrustpingApi connectionsConnIdSendPingPost POST /connections/{conn_id}/send-ping Send a trust ping to a connection
WalletApi walletDidCreatePost POST /wallet/did/create Create a local DID
WalletApi walletDidGet GET /wallet/did List wallet DIDs
WalletApi walletDidLocalRotateKeypairPatch PATCH /wallet/did/local/rotate-keypair Rotate keypair for a DID not posted to the ledger
WalletApi walletDidPublicGet GET /wallet/did/public Fetch the current public DID
WalletApi walletDidPublicPost POST /wallet/did/public Assign the current public DID
WalletApi walletGetDidEndpointGet GET /wallet/get-did-endpoint Query DID endpoint in wallet
WalletApi walletSetDidEndpointPost POST /wallet/set-did-endpoint Update endpoint in wallet and on ledger if posted to it

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyHeader

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

About

No description, website, or topics provided.

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

1 star

Watchers

1 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

 
 
 

Contributors 2

  •  
  •  

Languages