AtlassianApp

@appfire/fuse-auth-core • Docs

---

@appfire/fuse-auth-core / AtlassianApp

Class: AtlassianApp

Abstract class that serves as the base for the App class.

Extends

• App

Constructors

new AtlassianApp()

new AtlassianApp(key, clientKey, baseUrl, oauthClientId, sharedSecret): AtlassianApp

Parameters

• key: string

• clientKey: string

• baseUrl: string

• oauthClientId: string

• sharedSecret: string

Returns

AtlassianApp

Overrides

App.constructor

Defined in

products/atlassian/atlassian.app.ts:40

Properties

clientKey

protected clientKey: string

Inherited from

App.clientKey

Defined in

products/App.ts:52

---

eventType

protected eventType: string

Inherited from

App.eventType

Defined in

products/App.ts:57

---

fuseSecret

protected fuseSecret: string

Inherited from

App.fuseSecret

Defined in

products/App.ts:55

---

key

protected key: string

Inherited from

App.key

Defined in

products/App.ts:51

---

oauthClientId

protected oauthClientId: string

Inherited from

App.oauthClientId

Defined in

products/App.ts:53

---

productType

protected productType: string

Inherited from

App.productType

Defined in

products/App.ts:56

---

sharedSecret

protected sharedSecret: string

Inherited from

App.sharedSecret

Defined in

products/App.ts:54

Methods

getAccountId()

getAccountId(): string

Returns

string

Defined in

products/atlassian/atlassian.app.ts:85

---

getAppInfo()

getAppInfo(): Promise\<AppInfo>

Returns

Promise\<AppInfo>

Defined in

products/atlassian/atlassian.app.ts:190

---

getBaseUrl()

getBaseUrl(): string

Returns

string

Defined in

products/atlassian/atlassian.app.ts:51

---

getClaims()

getClaims(token): Claims

Parameters

• token: string

Returns

Claims

Inherited from

App.getClaims

Defined in

products/App.ts:146

---

getClientKey()

getClientKey(): string

Returns

string

Inherited from

App.getClientKey

Defined in

products/App.ts:122

---

getCreatedAt()

getCreatedAt(): number

Returns

number

Defined in

products/atlassian/atlassian.app.ts:151

---

getDescription()

getDescription(): string

Returns

string

Defined in

products/atlassian/atlassian.app.ts:77

---

getDisplayUrl()

getDisplayUrl(): string

Returns

string

Defined in

products/atlassian/atlassian.app.ts:89

---

getDisplayUrlServicedeskHelpCenter()

getDisplayUrlServicedeskHelpCenter(): string

Returns

string

Defined in

products/atlassian/atlassian.app.ts:93

---

getEntitlementId()

getEntitlementId(): undefined | string

Returns

undefined | string

Defined in

products/atlassian/atlassian.app.ts:166

---

getEntitlementNumber()

getEntitlementNumber(): undefined | string

Returns

undefined | string

Defined in

products/atlassian/atlassian.app.ts:169

---

getFilteredAppData()

getFilteredAppData(): GetAtlassianApp

Returns

GetAtlassianApp

Defined in

products/atlassian/atlassian.app.ts:200

---

getFuseSecret()

getFuseSecret(): string

Returns

string

Inherited from

App.getFuseSecret

Defined in

products/App.ts:134

---

getHostVal()

getHostVal(): string

Returns

string

Defined in

products/atlassian/atlassian.app.ts:159

---

getJwtToken()

getJwtToken(apiPath, method): string

Parameters

• apiPath: string

• method: string

Returns

string

Defined in

products/atlassian/atlassian.app.ts:65

---

getKey()

getKey(): string

Returns

string

Inherited from

App.getKey

Defined in

products/App.ts:119

---

getLifecycleFunctionVersion()

getLifecycleFunctionVersion(): string

Returns

string

Defined in

products/atlassian/atlassian.app.ts:163

---

getOauthClientId()

getOauthClientId(): string

Returns

string

Inherited from

App.getOauthClientId

Defined in

products/App.ts:125

---

getOAuthToken()

getOAuthToken(userAccountId): Promise\<string>

Parameters

• userAccountId: string

Returns

Promise\<string>

Defined in

products/atlassian/atlassian.app.ts:55

---

getProductType()

getProductType(): string

Returns

string

Inherited from

App.getProductType

Defined in

products/App.ts:131

---

getRealm()

getRealm(): string

Returns

string

Defined in

products/atlassian/atlassian.app.ts:73

---

getSen()

getSen(): string

Returns

string

Defined in

products/atlassian/atlassian.app.ts:81

---

getSharedSecret()

getSharedSecret(): string

Returns

string

Inherited from

App.getSharedSecret

Defined in

products/App.ts:128

---

getStatus()

getStatus(): string

Returns

string

Defined in

products/atlassian/atlassian.app.ts:69

---

getUpdatedAt()

getUpdatedAt(): number

Returns

number

Defined in

products/atlassian/atlassian.app.ts:155

---

setAccountId()

setAccountId(accountId): void

Parameters

• accountId: string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:121

---

setBaseUrl()

setBaseUrl(baseUrl): void

Parameters

• baseUrl: string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:97

---

setCreatedAt()

setCreatedAt(createdAt): void

Parameters

• createdAt: number

Returns

void

Defined in

products/atlassian/atlassian.app.ts:135

---

setDescription()

setDescription(description): void

Parameters

• description: string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:113

---

setDisplayUrl()

setDisplayUrl(displayUrl): void

Parameters

• displayUrl: string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:125

---

setDisplayUrlServicedeskHelpCenter()

setDisplayUrlServicedeskHelpCenter(displayUrlServicedeskHelpCenter): void

Parameters

• displayUrlServicedeskHelpCenter: string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:129

---

setEntitlementId()

setEntitlementId(entitlementId): void

Parameters

• entitlementId: undefined | string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:172

---

setEntitlementNumber()

setEntitlementNumber(entitlementNumber): void

Parameters

• entitlementNumber: undefined | string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:175

---

setEventType()

setEventType(eventType): void

Parameters

• eventType: string

Returns

void

Inherited from

App.setEventType

Defined in

products/App.ts:143

---

setFuseSecret()

setFuseSecret(fuseSecret): void

Parameters

• fuseSecret: string

Returns

void

Inherited from

App.setFuseSecret

Defined in

products/App.ts:140

---

setHostVal()

setHostVal(hostVal): void

Parameters

• hostVal: string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:143

---

setLifecycleFunctionVersion()

setLifecycleFunctionVersion(lifecycleFunctionVersion): void

Parameters

• lifecycleFunctionVersion: string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:147

---

setOauthclientId()

setOauthclientId(oauthClientId): void

Parameters

• oauthClientId: string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:101

---

setProductType()

setProductType(productType): void

Parameters

• productType: string

Returns

void

Inherited from

App.setProductType

Defined in

products/App.ts:137

---

setRealm()

setRealm(realm): void

Parameters

• realm: string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:109

---

setSen()

setSen(sen): void

Parameters

• sen: string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:117

---

setStatus()

setStatus(status): void

Parameters

• status: string

Returns

void

Defined in

products/atlassian/atlassian.app.ts:105

---

setUpdatedAt()

setUpdatedAt(updatedAt): void

Parameters

• updatedAt: number

Returns

void

Defined in

products/atlassian/atlassian.app.ts:139

---

toJSON()

toJSON(): object

Converts the App object to JSON.

Returns

object

The JSON representation of the App object.

Inherited from

App.toJSON

Defined in

products/App.ts:109

---

validateFuseToken()

validateFuseToken(token): boolean

Validates a Fuse token.

Parameters

• token: string

The Fuse token to validate.

Returns

boolean

True if the token is valid, false otherwise.

Inherited from

App.validateFuseToken

Defined in

products/App.ts:91

---

validateToken()

validateToken(token, request): boolean

Abstract method for validating a token.

Parameters

• token: string

The token to validate.

• request: Request

The JWT request object.

Returns

boolean

True if the token is valid, false otherwise.

Overrides

App.validateToken

Defined in

products/atlassian/atlassian.app.ts:179