arlas-wui-toolkit / Exports / ArlasIamService

Class: ArlasIamService

Hierarchy

• ArlasAuthentificationService

↳ ArlasIamService

Table of contents

Constructors

• constructor

Properties

• authConfigValue
• reloadState
• tokenRefreshed$
• user

Methods

• areSettingsValid
• change
• clearStore
• consumeReloadState
• createPermission
• declareReloadState
• forgot
• getAccessToken
• getOrganisation
• getRefreshToken
• initAuthService
• login
• logout
• logoutWithoutRedirection
• notifyTokenRefresh
• refresh
• reset
• setArlasIamApi
• setHeaders
• setHeadersFromAccesstoken
• setOptions
• signUp
• startRefreshTokenTimer
• stopRefreshTokenTimer
• storeAccessToken
• storeOrganisation
• storeRefreshToken
• verify

Constructors

constructor

• new ArlasIamService(router, settings)

Parameters

Name	Type
router	Router
settings	ArlasSettingsService

Overrides

ArlasAuthentificationService.constructor

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:36

Properties

authConfigValue

• authConfigValue: AuthentSetting

Inherited from

ArlasAuthentificationService.authConfigValue

Defined in

projects/arlas-toolkit/src/lib/services/arlas-authentification/arlas-authentification.service.ts:9

---

reloadState

• reloadState: string

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:34

---

tokenRefreshed$

• tokenRefreshed$: Observable<LoginData>

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:32

---

user

• user: UserData

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:33

Methods

areSettingsValid

▸ areSettingsValid(authentSetting): [boolean, string]

Parameters

Name	Type
authentSetting	AuthentSetting

Returns

[boolean, string]

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:221

---

change

▸ change(oldPassword, newPassword): Observable<UserData>

Parameters

Name	Type
oldPassword	string
newPassword	string

Returns

Observable<UserData>

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:289

---

clearStore

▸ clearStore(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:244

---

consumeReloadState

▸ consumeReloadState(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:47

---

createPermission

▸ createPermission(oid, permissionDef): Observable<PermissionData>

Parameters

Name	Type
oid	string
permissionDef	PermissionDef

Returns

Observable<PermissionData>

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:293

---

declareReloadState

▸ declareReloadState(reloadState): void

Parameters

Name	Type
reloadState	any

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:43

---

forgot

▸ forgot(email): Observable<string>

Parameters

Name	Type
email	string

Returns

Observable<string>

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:285

---

getAccessToken

▸ getAccessToken(): string

Returns

string

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:91

---

getOrganisation

▸ getOrganisation(): string

Gets organisation from localstorage. The method checks if the organisation is defined If not returned the first of the list in user's organisations.

Returns

string

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:119

---

getRefreshToken

▸ getRefreshToken(): RefreshToken

Returns

RefreshToken

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:99

---

initAuthService

▸ initAuthService(): Promise<void>

Returns

Promise<void>

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:178

---

login

▸ login(email, password): Observable<LoginData>

Parameters

Name	Type
email	string
password	string

Returns

Observable<LoginData>

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:269

---

logout

▸ logout(redirectPageAfterLogout?): void

Parameters

Name	Type
redirectPageAfterLogout	string[]

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:258

---

logoutWithoutRedirection

▸ logoutWithoutRedirection(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:249

---

notifyTokenRefresh

▸ notifyTokenRefresh(loginData): void

Parameters

Name	Type
loginData	LoginData

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:134

---

refresh

▸ refresh(refreshToken): Observable<LoginData>

Parameters

Name	Type
refreshToken	any

Returns

Observable<LoginData>

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:265

---

reset

▸ reset(userId, token, password): Observable<UserData>

Parameters

Name	Type
userId	string
token	string
password	string

Returns

Observable<UserData>

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:281

---

setArlasIamApi

▸ setArlasIamApi(api): void

Parameters

Name	Type
api	ArlasIamApi

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:57

---

setHeaders

▸ setHeaders(org, accessToken): void

Stores the given org and access token in localstorage + set iamService headers.

Parameters

Name	Type
org	string
accessToken	string

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:77

---

setHeadersFromAccesstoken

▸ setHeadersFromAccesstoken(accessToken): void

• Strores the given access token in localstorage
• Set the headers of iamService with an already stored organisation in localstorage.

Parameters

Name	Type
accessToken	string

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:64

---

setOptions

▸ setOptions(options): void

Parameters

Name	Type
options	any

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:53

---

signUp

▸ signUp(email): Observable<UserData>

Parameters

Name	Type
email	string

Returns

Observable<UserData>

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:273

---

startRefreshTokenTimer

▸ startRefreshTokenTimer(loginData): void

Parameters

Name	Type
loginData	LoginData

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:147

---

stopRefreshTokenTimer

▸ stopRefreshTokenTimer(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:237

---

storeAccessToken

▸ storeAccessToken(accessToken): void

Parameters

Name	Type
accessToken	string

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:87

---

storeOrganisation

▸ storeOrganisation(organisation): void

Parameters

Name	Type
organisation	string

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:130

---

storeRefreshToken

▸ storeRefreshToken(refreshToken): void

Parameters

Name	Type
refreshToken	RefreshToken

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:95

---

verify

▸ verify(userId, token, password): Observable<UserData>

Parameters

Name	Type
userId	string
token	string
password	string

Returns

Observable<UserData>

Defined in

projects/arlas-toolkit/src/lib/services/arlas-iam/arlas-iam.service.ts:277