cacheServerClient_ICacheServerClient.ICacheServerClient.md

Interface: ICacheServerClient

cacheServerClient/ICacheServerClient.ICacheServerClient

Implemented by

• CacheServerClient

Table of contents

Properties

• pubKeyAndIdentityToken

Methods

• addDIDToWatchList
• deleteClaim
• getAppDefinition
• getApplicationRoles
• getApplicationsByOrganization
• getApplicationsByOwner
• getAssetById
• getAssetHistory
• getClaimsByIssuer
• getClaimsByRequester
• getClaimsBySubject
• getClaimsBySubjects
• getDIDsForRole
• getDidDocument
• getNamespaceBySearchPhrase
• getOfferedAssets
• getOrgDefinition
• getOrgHierarchy
• getOrganizationRoles
• getOrganizationsByOwner
• getOwnedAssets
• getPreviouslyOwnedAssets
• getRoleDefinition
• getRolesByOwner
• getRolesDefinition
• getSubOrganizationsByOrganization
• isAuthEnabled
• issueClaim
• login
• rejectClaim
• requestClaim
• testLogin

Properties

pubKeyAndIdentityToken

• pubKeyAndIdentityToken: undefined | IPubKeyAndIdentityToken

Methods

addDIDToWatchList

▸ addDIDToWatchList(__namedParameters): Promise<void>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "did">

Returns

Promise<void>

---

deleteClaim

▸ deleteClaim(__namedParameters): Promise<void>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "claimId">

Returns

Promise<void>

---

getAppDefinition

▸ getAppDefinition(__namedParameters): Promise<IAppDefinition>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "namespace">

Returns

Promise<IAppDefinition>

---

getApplicationRoles

▸ getApplicationRoles(__namedParameters): Promise<IRole[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "namespace">

Returns

Promise<IRole[]>

---

getApplicationsByOrganization

▸ getApplicationsByOrganization(__namedParameters): Promise<IApp[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "namespace">

Returns

Promise<IApp[]>

---

getApplicationsByOwner

▸ getApplicationsByOwner(__namedParameters): Promise<IApp[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "owner">

Returns

Promise<IApp[]>

---

getAssetById

▸ getAssetById(__namedParameters): Promise<Asset>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "id">

Returns

Promise<Asset>

---

getAssetHistory

▸ getAssetHistory(__namedParameters): Promise<AssetHistory[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "type" | "id" | "order" | "take" | "skip">

Returns

Promise<AssetHistory[]>

---

getClaimsByIssuer

▸ getClaimsByIssuer(__namedParameters): Promise<Claim[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "did" | "isAccepted" | "parentNamespace">

Returns

Promise<Claim[]>

---

getClaimsByRequester

▸ getClaimsByRequester(__namedParameters): Promise<Claim[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "did" | "isAccepted" | "parentNamespace">

Returns

Promise<Claim[]>

---

getClaimsBySubject

▸ getClaimsBySubject(__namedParameters): Promise<Claim[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "did" | "isAccepted" | "parentNamespace">

Returns

Promise<Claim[]>

---

getClaimsBySubjects

▸ getClaimsBySubjects(subjects): Promise<Claim[]>

Parameters

Name	Type
subjects	string[]

Returns

Promise<Claim[]>

---

getDIDsForRole

▸ getDIDsForRole(__namedParameters): Promise<string[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "namespace">

Returns

Promise<string[]>

---

getDidDocument

▸ getDidDocument(__namedParameters): Promise<IDIDDocument>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "did" | "includeClaims">

Returns

Promise<IDIDDocument>

---

getNamespaceBySearchPhrase

▸ getNamespaceBySearchPhrase(__namedParameters): Promise<(IOrganization | IApp | IRole)[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "types" | "search">

Returns

Promise<(IOrganization | IApp | IRole)[]>

---

getOfferedAssets

▸ getOfferedAssets(__namedParameters): Promise<Asset[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "did">

Returns

Promise<Asset[]>

---

getOrgDefinition

▸ getOrgDefinition(__namedParameters): Promise<IOrganizationDefinition>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "namespace">

Returns

Promise<IOrganizationDefinition>

---

getOrgHierarchy

▸ getOrgHierarchy(__namedParameters): Promise<IOrganization>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "namespace">

Returns

Promise<IOrganization>

---

getOrganizationRoles

▸ getOrganizationRoles(__namedParameters): Promise<IRole[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "namespace">

Returns

Promise<IRole[]>

---

getOrganizationsByOwner

▸ getOrganizationsByOwner(__namedParameters): Promise<IOrganization[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "owner" | "excludeSubOrgs">

Returns

Promise<IOrganization[]>

---

getOwnedAssets

▸ getOwnedAssets(__namedParameters): Promise<Asset[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "did">

Returns

Promise<Asset[]>

---

getPreviouslyOwnedAssets

▸ getPreviouslyOwnedAssets(__namedParameters): Promise<Asset[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "owner">

Returns

Promise<Asset[]>

---

getRoleDefinition

▸ getRoleDefinition(__namedParameters): Promise<IRoleDefinition>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "namespace">

Returns

Promise<IRoleDefinition>

---

getRolesByOwner

▸ getRolesByOwner(__namedParameters): Promise<IRole[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "owner">

Returns

Promise<IRole[]>

---

getRolesDefinition

▸ getRolesDefinition(namespaces): Promise<Record<string, IRoleDefinition>>

Parameters

Name	Type
namespaces	string[]

Returns

Promise<Record<string, IRoleDefinition>>

---

getSubOrganizationsByOrganization

▸ getSubOrganizationsByOrganization(__namedParameters): Promise<IOrganization[]>

Parameters

Name	Type
__namedParameters	Pick<ClaimsQueryParams, "namespace">

Returns

Promise<IOrganization[]>

---

isAuthEnabled

▸ isAuthEnabled(): boolean

Returns

boolean

---

issueClaim

▸ issueClaim(__namedParameters): Promise<void>

Parameters

Name	Type
__namedParameters	IssueClaim

Returns

Promise<void>

---

login

▸ login(): Promise<Object>

Returns

Promise<Object>

---

rejectClaim

▸ rejectClaim(__namedParameters): Promise<void>

Parameters

Name	Type
__namedParameters	RejectClaim

Returns

Promise<void>

---

requestClaim

▸ requestClaim(__namedParameters): Promise<void>

Parameters

Name	Type
__namedParameters	RequestClaim

Returns

Promise<void>

---

testLogin

▸ testLogin(): Promise<void>

Returns

Promise<void>