ActivityPlug

Appearance

ActivityPlug API / @activityplug/core / AuthService

Interface: AuthService ​

Defined in: packages/core/src/auth/service.ts:79

Properties ​

availableStrategies ​

readonly availableStrategies: readonly AuthStrategyKind[]

Defined in: packages/core/src/auth/service.ts:80

createAuthorizationUrl ​

readonly createAuthorizationUrl: (input) => Promise<OAuthAuthorizationRequest>

Defined in: packages/core/src/auth/service.ts:100

Parameters ​

input ​

OAuthAuthorizationUrlInput

Returns ​

Promise<OAuthAuthorizationRequest>

Deprecated ​

Use auth.oauth.start().

emailChallenge ​

readonly emailChallenge: EmailChallengeAuthService

Defined in: packages/core/src/auth/service.ts:83

exchangeAuthorizationCode ​

readonly exchangeAuthorizationCode: (input) => Promise<AuthSession>

Defined in: packages/core/src/auth/service.ts:104

Parameters ​

input ​

OAuthCodeExchangeInput

Returns ​

Promise<AuthSession>

Deprecated ​

Use auth.oauth.exchange().

injectToken ​

readonly injectToken: (input) => Promise<AuthSession>

Defined in: packages/core/src/auth/service.ts:92

Parameters ​

input ​

InjectTokenInput

Returns ​

Promise<AuthSession>

Deprecated ​

Use auth.token.importToken().

oauth ​

readonly oauth: OAuthAuthService

Defined in: packages/core/src/auth/service.ts:81

passkey ​

readonly passkey: PasskeyAuthService

Defined in: packages/core/src/auth/service.ts:84

refresh ​

readonly refresh: (input) => Promise<AuthSession>

Defined in: packages/core/src/auth/service.ts:106

Parameters ​

input ​

OAuthRefreshInput

Returns ​

Promise<AuthSession>

Deprecated ​

Use auth.refreshSession().

refreshSession ​

readonly refreshSession: (session) => Promise<AuthSession>

Defined in: packages/core/src/auth/service.ts:86

Parameters ​

session ​

AuthSession

Returns ​

Promise<AuthSession>

registerOAuthClient ​

readonly registerOAuthClient: (input) => Promise<OAuthClientRegistration>

Defined in: packages/core/src/auth/service.ts:96

Parameters ​

input ​

OAuthClientRegistrationInput

Returns ​

Promise<OAuthClientRegistration>

Deprecated ​

Use auth.oauth.registerClient().

revoke ​

readonly revoke: (input) => Promise<void>

Defined in: packages/core/src/auth/service.ts:108

Parameters ​

input ​

OAuthRevokeInput

Returns ​

Promise<void>

Deprecated ​

Use auth.revokeSession().

revokeSession ​

readonly revokeSession: (session, tokenTypeHint?) => Promise<void>

Defined in: packages/core/src/auth/service.ts:87

Parameters ​

session ​

AuthSession

tokenTypeHint? ​

"access_token" | "refresh_token"

Returns ​

Promise<void>

token ​

readonly token: TokenAuthService

Defined in: packages/core/src/auth/service.ts:82

verifyCredentials ​

readonly verifyCredentials: (session) => Promise<VerifyCredentialsResult>

Defined in: packages/core/src/auth/service.ts:94

Parameters ​

session ​

AuthSession

Returns ​

Promise<VerifyCredentialsResult>

Deprecated ​

Use auth.verifySession().

verifySession ​

readonly verifySession: (session) => Promise<VerifyCredentialsResult>

Defined in: packages/core/src/auth/service.ts:85

Parameters ​

session ​

AuthSession

Returns ​

Promise<VerifyCredentialsResult>