Class Authentication

Authentication for Lens API. Request challenge, authenticate, manage credentials.

Implements

IAuthentication

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>
Implementation of IAuthentication.authenticate
- Defined in packages/client/src/authentication/Authentication.ts:51

authenticateWith

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

fetch

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

⚠️ Requires authenticated LensClient.

Returns Promise<Result<ApprovedAuthenticationFragment, NotAuthenticatedError | CredentialsExpiredError>>
ApprovedAuthenticationFragment
```
const result = await client.authentication.fetch();
```
Implementation of IAuthentication.fetch
- Defined in packages/client/src/authentication/Authentication.ts:199

fetchAll

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

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

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
Implementation of IAuthentication.generateChallenge
- Defined in packages/client/src/authentication/Authentication.ts:47

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
Implementation of IAuthentication.getAccessToken
- Defined in packages/client/src/authentication/Authentication.ts:90

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
Implementation of IAuthentication.getAuthorizationId
- Defined in packages/client/src/authentication/Authentication.ts:185

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
Implementation of IAuthentication.getIdentityToken
- Defined in packages/client/src/authentication/Authentication.ts:140

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
Implementation of IAuthentication.getProfileId
- Defined in packages/client/src/authentication/Authentication.ts:165

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
Implementation of IAuthentication.getRefreshToken
- Defined in packages/client/src/authentication/Authentication.ts:115

getWalletAddress

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

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

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
Implementation of IAuthentication.isAuthenticated
- Defined in packages/client/src/authentication/Authentication.ts:69

logout

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

Returns Promise<void>
Nothing
Implementation of IAuthentication.logout
- Defined in packages/client/src/authentication/Authentication.ts:195

revoke

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

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

upgradeCredentials

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

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

verify

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

Deprecated
Use with VerifyRequest instead.
Implementation of IAuthentication.verify
- Defined in packages/client/src/authentication/Authentication.ts:63

Class Authentication

Implements

Index

Methods

Methods

authenticate

Parameters

request: SignedAuthChallenge

Returns Promise<void>

authenticateWith

Parameters

__namedParameters: { refreshToken: string; }

refreshToken: string

Returns Promise<void>

fetch

Returns Promise<Result<ApprovedAuthenticationFragment, NotAuthenticatedError | CredentialsExpiredError>>

fetchAll

Parameters

request: ApprovedAuthenticationRequest = {}

Returns Promise<Result<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 Promise<Result<void, NotAuthenticatedError | CredentialsExpiredError>>

Example

upgradeCredentials

Parameters

request: WalletAuthenticationToProfileAuthenticationRequest

Returns Promise<Result<void, NotAuthenticatedError | CredentialsExpiredError>>

Example

verify

Parameters

request: string | VerifyRequest

Returns Promise<boolean>

Deprecated

Settings

Member Visibility

Theme

On This Page

__namedParameters: {
refreshToken: string;
}