Interface IAuthentication

Authentication for Lens API.

interface IAuthentication {
    authenticate(request): Promise<void>;
    authenticateWith(__namedParameters): Promise<void>;
    fetch(): PromiseResult<ApprovedAuthenticationFragment, NotAuthenticatedError | CredentialsExpiredError>;
    fetchAll(request?): PromiseResult<PaginatedResult<ApprovedAuthenticationFragment>, NotAuthenticatedError | CredentialsExpiredError>;
    generateChallenge(request): Promise<AuthChallengeFragment>;
    getAccessToken(): PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>;
    getAuthorizationId(): Promise<null | string>;
    getIdentityToken(): PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>;
    getProfileId(): Promise<null | string>;
    getRefreshToken(): PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>;
    getWalletAddress(): Promise<null | string>;
    isAuthenticated(): Promise<boolean>;
    logout(): Promise<void>;
    revoke(request): PromiseResult<void, NotAuthenticatedError | CredentialsExpiredError>;
    upgradeCredentials(request): PromiseResult<void, NotAuthenticatedError | CredentialsExpiredError>;
    verify(request): Promise<boolean>;
    verify(request): Promise<boolean>;
}

Implemented by

Authentication

Index

Methods

authenticate authenticateWith fetch fetchAll generateChallenge getAccessToken getAuthorizationId getIdentityToken getProfileId getRefreshToken getWalletAddress isAuthenticated logout revoke upgradeCredentials verify

Methods

authenticate

authenticate(request): Promise<void>
Authenticate a user with a signature.
Parameters
- request: SignedAuthChallenge
  Authentication request
Returns Promise<void>
- Defined in packages/client/src/authentication/IAuthentication.ts:42

authenticateWith

authenticateWith(__namedParameters): Promise<void>
Authenticate with an existing, valid refresh token.
Parameters
- __namedParameters: {
  refreshToken: string;
  }
  - refreshToken: string
Returns Promise<void>
- Defined in packages/client/src/authentication/IAuthentication.ts:27

fetch

fetch(): PromiseResult<ApprovedAuthenticationFragment, NotAuthenticatedError | CredentialsExpiredError>
Fetch current active authentication session.

⚠️ Requires authenticated LensClient.

Returns PromiseResult<ApprovedAuthenticationFragment, NotAuthenticatedError | CredentialsExpiredError>
ApprovedAuthenticationFragment
```
const result = await client.authentication.fetch();
```
- Defined in packages/client/src/authentication/IAuthentication.ts:143

fetchAll

fetchAll(request?): PromiseResult<PaginatedResult<ApprovedAuthenticationFragment>, NotAuthenticatedError | CredentialsExpiredError>
Fetch all active authentication sessions.

⚠️ Requires authenticated LensClient.
Parameters
- Optional request: ApprovedAuthenticationRequest
  Request object for the query
Returns PromiseResult<PaginatedResult<ApprovedAuthenticationFragment>, NotAuthenticatedError | CredentialsExpiredError>
ApprovedAuthenticationFragment wrapped in PaginatedResult
Example
```
const result = await client.authentication.fetchAll();
```
- Defined in packages/client/src/authentication/IAuthentication.ts:161

generateChallenge

generateChallenge(request): Promise<AuthChallengeFragment>
Generate a challenge for a wallet or profile to sign.
Parameters
- request: ChallengeRequest
  Challenge request
Returns Promise<AuthChallengeFragment>
A challenge string
- Defined in packages/client/src/authentication/IAuthentication.ts:35

getAccessToken

getAccessToken(): PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>
Get the access token.

Returns PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>
A Result with the access token or possible error scenarios
- Defined in packages/client/src/authentication/IAuthentication.ts:88

getAuthorizationId

getAuthorizationId(): Promise<null | string>
Get the authorization id needed to revoke the active authentication session.

Returns Promise<null | string>
The authorization id or null if not authenticated
- Defined in packages/client/src/authentication/IAuthentication.ts:123

getIdentityToken

getIdentityToken(): PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>
Get the identity token.

Returns PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>
A Result with the identity token or possible error scenarios
- Defined in packages/client/src/authentication/IAuthentication.ts:102

getProfileId

getProfileId(): Promise<null | string>
Get the authenticated profile id.

Returns Promise<null | string>
The profile id or null if not authenticated or authenticated with wallet only
- Defined in packages/client/src/authentication/IAuthentication.ts:109

getRefreshToken

getRefreshToken(): PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>
Get the refresh token.

Returns PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>
A Result with the refresh token or possible error scenarios
- Defined in packages/client/src/authentication/IAuthentication.ts:95

getWalletAddress

getWalletAddress(): Promise<null | string>
Get the authenticated wallet address.

Returns Promise<null | string>
The wallet address or null if not authenticated
- Defined in packages/client/src/authentication/IAuthentication.ts:116

isAuthenticated

isAuthenticated(): Promise<boolean>
Check if the user is authenticated. If the credentials are expired, try to refresh them.

Returns Promise<boolean>
Whether the user is authenticated
- Defined in packages/client/src/authentication/IAuthentication.ts:81

logout

logout(): Promise<void>
Logout the authenticated profile. Cleanup the storage.

Returns Promise<void>
Nothing
- Defined in packages/client/src/authentication/IAuthentication.ts:130

revoke

revoke(request): PromiseResult<void, NotAuthenticatedError | CredentialsExpiredError>
Revoke an active authentication session.

⚠️ Requires authenticated LensClient.
Parameters
- request: RevokeAuthenticationRequest
  Request object for the mutation
Returns PromiseResult<void, NotAuthenticatedError | CredentialsExpiredError>
PromiseResult with void
Example
```
await client.authentication.revoke({
  authorizationId: '8a905b63-1236-4d69-8969-95e93b7dd35d',
});
```
- Defined in packages/client/src/authentication/IAuthentication.ts:183

upgradeCredentials

upgradeCredentials(request): PromiseResult<void, NotAuthenticatedError | CredentialsExpiredError>
Upgrade the credentials from wallet only to profile authentication.

⚠️ Requires authenticated LensClient with wallet only.
Parameters
- request: WalletAuthenticationToProfileAuthenticationRequest
Returns PromiseResult<void, NotAuthenticatedError | CredentialsExpiredError>
Example
```
await client.authentication.upgradeCredentials();
```
- Defined in packages/client/src/authentication/IAuthentication.ts:54

verify

verify(request): Promise<boolean>
Check the validity of the provided token.
Parameters
- request: string
  Access token as a string
Returns Promise<boolean>
Whether the provided token is valid

Deprecated
Use with VerifyRequest instead.
- Defined in packages/client/src/authentication/IAuthentication.ts:66
verify(request): Promise<boolean>
Check the validity of the provided token.
Parameters
- request: VerifyRequest
  Verify request
Returns Promise<boolean>
Whether the provided token is valid
- Defined in packages/client/src/authentication/IAuthentication.ts:74

Interface IAuthentication

Implemented by

Index

Methods

Methods

authenticate

Parameters

request: SignedAuthChallenge

Returns Promise<void>

authenticateWith

Parameters

__namedParameters: { refreshToken: string; }

refreshToken: string

Returns Promise<void>

fetch

Returns PromiseResult<ApprovedAuthenticationFragment, NotAuthenticatedError | CredentialsExpiredError>

fetchAll

Parameters

Optional request: ApprovedAuthenticationRequest

Returns PromiseResult<PaginatedResult<ApprovedAuthenticationFragment>, NotAuthenticatedError | CredentialsExpiredError>

Example

generateChallenge

Parameters

request: ChallengeRequest

Returns Promise<AuthChallengeFragment>

getAccessToken

Returns PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>

getAuthorizationId

Returns Promise<null | string>

getIdentityToken

Returns PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>

getProfileId

Returns Promise<null | string>

getRefreshToken

Returns PromiseResult<string, NotAuthenticatedError | CredentialsExpiredError>

getWalletAddress

Returns Promise<null | string>

isAuthenticated

Returns Promise<boolean>

logout

Returns Promise<void>

revoke

Parameters

request: RevokeAuthenticationRequest

Returns PromiseResult<void, NotAuthenticatedError | CredentialsExpiredError>

Example

upgradeCredentials

Parameters

request: WalletAuthenticationToProfileAuthenticationRequest

Returns PromiseResult<void, NotAuthenticatedError | CredentialsExpiredError>

Example

verify

Parameters

request: string

Returns Promise<boolean>

Deprecated

Parameters

request: VerifyRequest

Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

__namedParameters: {
refreshToken: string;
}

`Optional` request: ApprovedAuthenticationRequest