Class RevocationApi

Hierarchy

BaseAPI
- RevocationApi

Index

Constructors

Properties

Methods

request revocationActiveRegistryCredDefIdGet revocationActiveRegistryCredDefIdGetRaw revocationActiveRegistryCredDefIdRotatePost revocationActiveRegistryCredDefIdRotatePostRaw revocationClearPendingRevocationsPost revocationClearPendingRevocationsPostRaw revocationCreateRegistryPost revocationCreateRegistryPostRaw revocationCredentialRecordGet revocationCredentialRecordGetRaw revocationPublishRevocationsPost revocationPublishRevocationsPostRaw revocationRegistriesCreatedGet revocationRegistriesCreatedGetRaw revocationRegistryDeleteTailsFileDelete revocationRegistryDeleteTailsFileDeleteRaw revocationRegistryRevRegIdDefinitionPost revocationRegistryRevRegIdDefinitionPostRaw revocationRegistryRevRegIdEntryPost revocationRegistryRevRegIdEntryPostRaw revocationRegistryRevRegIdFixRevocationEntryStatePut revocationRegistryRevRegIdFixRevocationEntryStatePutRaw revocationRegistryRevRegIdGet revocationRegistryRevRegIdGetRaw revocationRegistryRevRegIdIssuedDetailsGet revocationRegistryRevRegIdIssuedDetailsGetRaw revocationRegistryRevRegIdIssuedGet revocationRegistryRevRegIdIssuedGetRaw revocationRegistryRevRegIdIssuedIndyRecsGet revocationRegistryRevRegIdIssuedIndyRecsGetRaw revocationRegistryRevRegIdPatch revocationRegistryRevRegIdPatchRaw revocationRegistryRevRegIdSetStatePatch revocationRegistryRevRegIdSetStatePatchRaw revocationRegistryRevRegIdTailsFileGet revocationRegistryRevRegIdTailsFileGetRaw revocationRegistryRevRegIdTailsFilePut revocationRegistryRevRegIdTailsFilePutRaw revocationRevokePost revocationRevokePostRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new RevocationApi(configuration?): RevocationApi
Parameters
- configuration: Configuration = ...
Returns RevocationApi
Inherited from BaseAPI.constructor
- Defined in client/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

`Protected` request

request(context): Promise<Response>
Parameters
- context: RequestOpts
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in client/runtime.ts:50

revocationActiveRegistryCredDefIdGet

revocationActiveRegistryCredDefIdGet(requestParameters): Promise<RevRegResult>
Get current active revocation registry by credential definition id
Parameters
- requestParameters: RevocationActiveRegistryCredDefIdGetRequest
Returns Promise<RevRegResult>
- Defined in client/apis/RevocationApi.ts:199

revocationActiveRegistryCredDefIdGetRaw

revocationActiveRegistryCredDefIdGetRaw(requestParameters): Promise<ApiResponse<RevRegResult>>
Get current active revocation registry by credential definition id
Parameters
- requestParameters: RevocationActiveRegistryCredDefIdGetRequest
Returns Promise<ApiResponse<RevRegResult>>
- Defined in client/apis/RevocationApi.ts:164

revocationActiveRegistryCredDefIdRotatePost

revocationActiveRegistryCredDefIdRotatePost(requestParameters): Promise<RevRegsCreated>
Rotate revocation registry
Parameters
- requestParameters: RevocationActiveRegistryCredDefIdRotatePostRequest
Returns Promise<RevRegsCreated>
- Defined in client/apis/RevocationApi.ts:245

revocationActiveRegistryCredDefIdRotatePostRaw

revocationActiveRegistryCredDefIdRotatePostRaw(requestParameters): Promise<ApiResponse<RevRegsCreated>>
Rotate revocation registry
Parameters
- requestParameters: RevocationActiveRegistryCredDefIdRotatePostRequest
Returns Promise<ApiResponse<RevRegsCreated>>
- Defined in client/apis/RevocationApi.ts:210

revocationClearPendingRevocationsPost

revocationClearPendingRevocationsPost(requestParameters): Promise<PublishRevocations>
Clear pending revocations
Parameters
- requestParameters: RevocationClearPendingRevocationsPostRequest
Returns Promise<PublishRevocations>
- Defined in client/apis/RevocationApi.ts:283

revocationClearPendingRevocationsPostRaw

revocationClearPendingRevocationsPostRaw(requestParameters): Promise<ApiResponse<PublishRevocations>>
Clear pending revocations
Parameters
- requestParameters: RevocationClearPendingRevocationsPostRequest
Returns Promise<ApiResponse<PublishRevocations>>
- Defined in client/apis/RevocationApi.ts:258

revocationCreateRegistryPost

revocationCreateRegistryPost(requestParameters): Promise<RevRegResult>
Creates a new revocation registry
Parameters
- requestParameters: RevocationCreateRegistryPostRequest
Returns Promise<RevRegResult>
- Defined in client/apis/RevocationApi.ts:319

revocationCreateRegistryPostRaw

revocationCreateRegistryPostRaw(requestParameters): Promise<ApiResponse<RevRegResult>>
Creates a new revocation registry
Parameters
- requestParameters: RevocationCreateRegistryPostRequest
Returns Promise<ApiResponse<RevRegResult>>
- Defined in client/apis/RevocationApi.ts:294

revocationCredentialRecordGet

revocationCredentialRecordGet(requestParameters): Promise<CredRevRecordResult>
Get credential revocation status
Parameters
- requestParameters: RevocationCredentialRecordGetRequest
Returns Promise<CredRevRecordResult>
- Defined in client/apis/RevocationApi.ts:364

revocationCredentialRecordGetRaw

revocationCredentialRecordGetRaw(requestParameters): Promise<ApiResponse<CredRevRecordResult>>
Get credential revocation status
Parameters
- requestParameters: RevocationCredentialRecordGetRequest
Returns Promise<ApiResponse<CredRevRecordResult>>
- Defined in client/apis/RevocationApi.ts:330

revocationPublishRevocationsPost

revocationPublishRevocationsPost(requestParameters): Promise<TxnOrPublishRevocationsResult>
Publish pending revocations to ledger
Parameters
- requestParameters: RevocationPublishRevocationsPostRequest
Returns Promise<TxnOrPublishRevocationsResult>
- Defined in client/apis/RevocationApi.ts:409

revocationPublishRevocationsPostRaw

revocationPublishRevocationsPostRaw(requestParameters): Promise<ApiResponse<TxnOrPublishRevocationsResult>>
Publish pending revocations to ledger
Parameters
- requestParameters: RevocationPublishRevocationsPostRequest
Returns Promise<ApiResponse<TxnOrPublishRevocationsResult>>
- Defined in client/apis/RevocationApi.ts:375

revocationRegistriesCreatedGet

revocationRegistriesCreatedGet(requestParameters): Promise<RevRegsCreated>
Search for matching revocation registries that current agent created
Parameters
- requestParameters: RevocationRegistriesCreatedGetRequest
Returns Promise<RevRegsCreated>
- Defined in client/apis/RevocationApi.ts:450

revocationRegistriesCreatedGetRaw

revocationRegistriesCreatedGetRaw(requestParameters): Promise<ApiResponse<RevRegsCreated>>
Search for matching revocation registries that current agent created
Parameters
- requestParameters: RevocationRegistriesCreatedGetRequest
Returns Promise<ApiResponse<RevRegsCreated>>
- Defined in client/apis/RevocationApi.ts:420

revocationRegistryDeleteTailsFileDelete

revocationRegistryDeleteTailsFileDelete(requestParameters): Promise<TailsDeleteResponse>
Delete the tail files
Parameters
- requestParameters: RevocationRegistryDeleteTailsFileDeleteRequest
Returns Promise<TailsDeleteResponse>
- Defined in client/apis/RevocationApi.ts:491

revocationRegistryDeleteTailsFileDeleteRaw

revocationRegistryDeleteTailsFileDeleteRaw(requestParameters): Promise<ApiResponse<TailsDeleteResponse>>
Delete the tail files
Parameters
- requestParameters: RevocationRegistryDeleteTailsFileDeleteRequest
Returns Promise<ApiResponse<TailsDeleteResponse>>
- Defined in client/apis/RevocationApi.ts:461

revocationRegistryRevRegIdDefinitionPost

revocationRegistryRevRegIdDefinitionPost(requestParameters): Promise<TxnOrRevRegResult>
Send revocation registry definition to ledger
Parameters
- requestParameters: RevocationRegistryRevRegIdDefinitionPostRequest
Returns Promise<TxnOrRevRegResult>
- Defined in client/apis/RevocationApi.ts:546

revocationRegistryRevRegIdDefinitionPostRaw

revocationRegistryRevRegIdDefinitionPostRaw(requestParameters): Promise<ApiResponse<TxnOrRevRegResult>>
Send revocation registry definition to ledger
Parameters
- requestParameters: RevocationRegistryRevRegIdDefinitionPostRequest
Returns Promise<ApiResponse<TxnOrRevRegResult>>
- Defined in client/apis/RevocationApi.ts:502

revocationRegistryRevRegIdEntryPost

revocationRegistryRevRegIdEntryPost(requestParameters): Promise<RevRegResult>
Send revocation registry entry to ledger
Parameters
- requestParameters: RevocationRegistryRevRegIdEntryPostRequest
Returns Promise<RevRegResult>
- Defined in client/apis/RevocationApi.ts:601

revocationRegistryRevRegIdEntryPostRaw

revocationRegistryRevRegIdEntryPostRaw(requestParameters): Promise<ApiResponse<RevRegResult>>
Send revocation registry entry to ledger
Parameters
- requestParameters: RevocationRegistryRevRegIdEntryPostRequest
Returns Promise<ApiResponse<RevRegResult>>
- Defined in client/apis/RevocationApi.ts:557

revocationRegistryRevRegIdFixRevocationEntryStatePut

revocationRegistryRevRegIdFixRevocationEntryStatePut(requestParameters): Promise<RevRegWalletUpdatedResult>
Fix revocation state in wallet and return number of updated entries
Parameters
- requestParameters: RevocationRegistryRevRegIdFixRevocationEntryStatePutRequest
Returns Promise<RevRegWalletUpdatedResult>
- Defined in client/apis/RevocationApi.ts:662

revocationRegistryRevRegIdFixRevocationEntryStatePutRaw

revocationRegistryRevRegIdFixRevocationEntryStatePutRaw(requestParameters): Promise<ApiResponse<RevRegWalletUpdatedResult>>
Fix revocation state in wallet and return number of updated entries
Parameters
- requestParameters: RevocationRegistryRevRegIdFixRevocationEntryStatePutRequest
Returns Promise<ApiResponse<RevRegWalletUpdatedResult>>
- Defined in client/apis/RevocationApi.ts:612

revocationRegistryRevRegIdGet

revocationRegistryRevRegIdGet(requestParameters): Promise<RevRegResult>
Get revocation registry by revocation registry id
Parameters
- requestParameters: RevocationRegistryRevRegIdGetRequest
Returns Promise<RevRegResult>
- Defined in client/apis/RevocationApi.ts:710

revocationRegistryRevRegIdGetRaw

revocationRegistryRevRegIdGetRaw(requestParameters): Promise<ApiResponse<RevRegResult>>
Get revocation registry by revocation registry id
Parameters
- requestParameters: RevocationRegistryRevRegIdGetRequest
Returns Promise<ApiResponse<RevRegResult>>
- Defined in client/apis/RevocationApi.ts:675

revocationRegistryRevRegIdIssuedDetailsGet

revocationRegistryRevRegIdIssuedDetailsGet(requestParameters): Promise<CredRevRecordDetailsResult>
Get details of credentials issued against revocation registry
Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedDetailsGetRequest
Returns Promise<CredRevRecordDetailsResult>
- Defined in client/apis/RevocationApi.ts:756

revocationRegistryRevRegIdIssuedDetailsGetRaw

revocationRegistryRevRegIdIssuedDetailsGetRaw(requestParameters): Promise<ApiResponse<CredRevRecordDetailsResult>>
Get details of credentials issued against revocation registry
Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedDetailsGetRequest
Returns Promise<ApiResponse<CredRevRecordDetailsResult>>
- Defined in client/apis/RevocationApi.ts:721

revocationRegistryRevRegIdIssuedGet

revocationRegistryRevRegIdIssuedGet(requestParameters): Promise<RevRegIssuedResult>
Get number of credentials issued against revocation registry
Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedGetRequest
Returns Promise<RevRegIssuedResult>
- Defined in client/apis/RevocationApi.ts:804

revocationRegistryRevRegIdIssuedGetRaw

revocationRegistryRevRegIdIssuedGetRaw(requestParameters): Promise<ApiResponse<RevRegIssuedResult>>
Get number of credentials issued against revocation registry
Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedGetRequest
Returns Promise<ApiResponse<RevRegIssuedResult>>
- Defined in client/apis/RevocationApi.ts:769

revocationRegistryRevRegIdIssuedIndyRecsGet

revocationRegistryRevRegIdIssuedIndyRecsGet(requestParameters): Promise<CredRevIndyRecordsResult>
Get details of revoked credentials from ledger
Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedIndyRecsGetRequest
Returns Promise<CredRevIndyRecordsResult>
- Defined in client/apis/RevocationApi.ts:850

revocationRegistryRevRegIdIssuedIndyRecsGetRaw

revocationRegistryRevRegIdIssuedIndyRecsGetRaw(requestParameters): Promise<ApiResponse<CredRevIndyRecordsResult>>
Get details of revoked credentials from ledger
Parameters
- requestParameters: RevocationRegistryRevRegIdIssuedIndyRecsGetRequest
Returns Promise<ApiResponse<CredRevIndyRecordsResult>>
- Defined in client/apis/RevocationApi.ts:815

revocationRegistryRevRegIdPatch

revocationRegistryRevRegIdPatch(requestParameters): Promise<RevRegResult>
Update revocation registry with new public URI to its tails file
Parameters
- requestParameters: RevocationRegistryRevRegIdPatchRequest
Returns Promise<RevRegResult>
- Defined in client/apis/RevocationApi.ts:901

revocationRegistryRevRegIdPatchRaw

revocationRegistryRevRegIdPatchRaw(requestParameters): Promise<ApiResponse<RevRegResult>>
Update revocation registry with new public URI to its tails file
Parameters
- requestParameters: RevocationRegistryRevRegIdPatchRequest
Returns Promise<ApiResponse<RevRegResult>>
- Defined in client/apis/RevocationApi.ts:863

revocationRegistryRevRegIdSetStatePatch

revocationRegistryRevRegIdSetStatePatch(requestParameters): Promise<RevRegResult>
Set revocation registry state manually
Parameters
- requestParameters: RevocationRegistryRevRegIdSetStatePatchRequest
Returns Promise<RevRegResult>
- Defined in client/apis/RevocationApi.ts:961

revocationRegistryRevRegIdSetStatePatchRaw

revocationRegistryRevRegIdSetStatePatchRaw(requestParameters): Promise<ApiResponse<RevRegResult>>
Set revocation registry state manually
Parameters
- requestParameters: RevocationRegistryRevRegIdSetStatePatchRequest
Returns Promise<ApiResponse<RevRegResult>>
- Defined in client/apis/RevocationApi.ts:912

revocationRegistryRevRegIdTailsFileGet

revocationRegistryRevRegIdTailsFileGet(requestParameters): Promise<Blob>
Download tails file
Parameters
- requestParameters: RevocationRegistryRevRegIdTailsFileGetRequest
Returns Promise<Blob>
- Defined in client/apis/RevocationApi.ts:1005

revocationRegistryRevRegIdTailsFileGetRaw

revocationRegistryRevRegIdTailsFileGetRaw(requestParameters): Promise<ApiResponse<Blob>>
Download tails file
Parameters
- requestParameters: RevocationRegistryRevRegIdTailsFileGetRequest
Returns Promise<ApiResponse<Blob>>
- Defined in client/apis/RevocationApi.ts:972

revocationRegistryRevRegIdTailsFilePut

revocationRegistryRevRegIdTailsFilePut(requestParameters): Promise<object>
Upload local tails file to server
Parameters
- requestParameters: RevocationRegistryRevRegIdTailsFilePutRequest
Returns Promise<object>
- Defined in client/apis/RevocationApi.ts:1049

revocationRegistryRevRegIdTailsFilePutRaw

revocationRegistryRevRegIdTailsFilePutRaw(requestParameters): Promise<ApiResponse<object>>
Upload local tails file to server
Parameters
- requestParameters: RevocationRegistryRevRegIdTailsFilePutRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/RevocationApi.ts:1016

revocationRevokePost

revocationRevokePost(requestParameters): Promise<object>
Revoke an issued credential
Parameters
- requestParameters: RevocationRevokePostRequest
Returns Promise<object>
- Defined in client/apis/RevocationApi.ts:1092

revocationRevokePostRaw

revocationRevokePostRaw(requestParameters): Promise<ApiResponse<object>>
Revoke an issued credential
Parameters
- requestParameters: RevocationRevokePostRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/RevocationApi.ts:1060

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in client/runtime.ts:28

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...postMiddlewares: (undefined | ((context) => Promise<void | Response>))[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in client/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- Rest ...preMiddlewares: (undefined | ((context) => Promise<void | FetchParams>))[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in client/runtime.ts:34

Generated using TypeDoc