Skip to main content

IAuthentication

@nuclia/coreDocs


@nuclia/core / IAuthentication

Interface: IAuthentication

Methods

authenticate()

authenticate(tokens): boolean

Parameters

tokens: AuthTokens

Returns

boolean

Defined in

libs/sdk-core/src/lib/models.ts:64


deleteAuthenticatedUser()

deleteAuthenticatedUser(): Observable<void>

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/models.ts:66


getAuthHeaders()

getAuthHeaders()

getAuthHeaders(): object

Returns

object

Defined in

libs/sdk-core/src/lib/models.ts:60

getAuthHeaders(method, path)

getAuthHeaders(method, path): object

Parameters

method: string

path: string

Returns

object

Defined in

libs/sdk-core/src/lib/models.ts:61


getAuthInfo()

getAuthInfo(includeIP?): Observable<AuthInfo>

Parameters

includeIP?: boolean

Returns

Observable<AuthInfo>

Defined in

libs/sdk-core/src/lib/models.ts:68


getAuthUrl()

getAuthUrl(): string

Returns

string

Defined in

libs/sdk-core/src/lib/models.ts:71


getJWTUser()

getJWTUser(): null | JwtUser

Returns

null | JwtUser

Defined in

libs/sdk-core/src/lib/models.ts:67


getRefreshToken()

getRefreshToken(): string

Returns

string

Defined in

libs/sdk-core/src/lib/models.ts:63


getToken()

getToken(force?): string

Parameters

force?: boolean

Returns

string

Defined in

libs/sdk-core/src/lib/models.ts:62


hasLoggedOut()

hasLoggedOut(): Observable<boolean>

Returns

Observable<boolean>

Defined in

libs/sdk-core/src/lib/models.ts:58


isAuthenticated()

isAuthenticated(): Observable<boolean>

Returns

Observable<boolean>

Defined in

libs/sdk-core/src/lib/models.ts:57


logout()

logout(): void

Returns

void

Defined in

libs/sdk-core/src/lib/models.ts:59


processAuthorizationResponse()

processAuthorizationResponse(authCode, returnedState): Observable<object>

Parameters

authCode: string

returnedState: string

Returns

Observable<object>

state

state: any

success

success: boolean

Defined in

libs/sdk-core/src/lib/models.ts:70


redirectToOAuth()

redirectToOAuth(queryParams?): void

Parameters

queryParams?

Returns

void

Defined in

libs/sdk-core/src/lib/models.ts:69


setPassword()

setPassword(password): Observable<boolean>

Parameters

password: string

Returns

Observable<boolean>

Defined in

libs/sdk-core/src/lib/models.ts:65


validateMagicToken()

validateMagicToken(token, zone?): Observable<MagicAction>

Parameters

token: string

zone?: string

Returns

Observable<MagicAction>

Defined in

libs/sdk-core/src/lib/models.ts:72