Interface Identity

A General Identity object. This does not have to be a private key (for example, the Anonymous identity), but it must be able to transform request.

Hierarchy

Identity

Implemented by

Index

Methods

Methods

getPrincipal

getPrincipal(): Principal

- Defined in packages/agent/src/auth.ts:46
Get the principal represented by this identity. Normally should be a Principal.selfAuthenticating().

Returns Principal

transformRequest

transformRequest(request: HttpAgentRequest): Promise<unknown>

- Defined in packages/agent/src/auth.ts:53
Transform a request into a signed version of the request. This is done last after the transforms on the body of a request. The returned object can be anything, but must be serializable to CBOR.

Parameters
- request: HttpAgentRequest
Returns Promise<unknown>

Generated using TypeDoc