Developer
Documentation
Resources
Get Support
Sign in
Developer
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Developer
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Classes
Enumerations
Interfaces
TypeAliases

ConfigAsCodeAPI

Forge api class, scoped to Compass config as code requests

Constructors

new ConfigAsCodeAPI(api: FetchAPI, userCompassRequests?: CompassRequests, appCompassRequests?: CompassRequests): ConfigAsCodeAPI

1
2
const configAsCodeAPI = new ConfigAsCodeAPI(
  {},
  {}
)

Properties

Property NameTypeDescription
apiFetchAPI
appCompassRequestsCompassRequests
userCompassRequestsCompassRequests

Methods

AsApp

asApp(): ConfigAsCodeRequests

Authenticates with Atlassian GraphQL Gateway as your Forge app.

1
2
const resp = configAsCodeAPI.asApp()

AsUser

asUser(): ConfigAsCodeRequests

Authenticates with Atlassian GraphQL Gateway as user.

1
2
const resp = configAsCodeAPI.asUser()

Rate this page: