models

Type Members

1. case class AtlassianHost(clientKey: ClientKey, key: String, publicKey: String, oauthClientId: Option[String], sharedSecret: String, serverVersion: String, pluginsVersion: String, baseUrl: String, productType: String, description: String, serviceEntitlementNumber: Option[String], installed: Boolean) extends Product with Serializable

   

   An Atlassian host in which the add-on is or has been installed.

   An Atlassian host in which the add-on is or has been installed. Hosts are stored in AtlassianHostRepository.

   During processing of a request from an Atlassian host, the details of the host and of the user at the browser can be obtained from the AtlassianHostUser.

   clientKey

   Identifying key for the Atlassian product instance that the add-on was installed into.

   key

   Add-on key that was installed into the Atlassian Product, as it appears in your add-on's descriptor.

   publicKey

   Public key for this Atlassian product instance.

   oauthClientId

   OAuth 2.0 client ID for the add-on used for OAuth 2.0 - JWT Bearer token authorization grant type.

   sharedSecret

   Secret to sign outgoing JWT tokens and validate incoming JWT tokens. Only sent on the installed event.

   serverVersion

   Host product's version.

   pluginsVersion

   Semver compliant version of Atlassian Connect which is running on the host server.

   baseUrl

   URL prefix for this Atlassian product instance.

   productType

   Identifies the category of Atlassian product, e.g. jira or confluence.

   description

   Host product description.

   serviceEntitlementNumber

   Service entitlement number (SEN) is the add-on license id. Only included during installation of a paid add-on.

   installed

   Indicates if the add-on is currently installed on the host. Upon uninstallation, the value of this flag will be set to false.

2. case class AtlassianHostUser(host: AtlassianHost, userKey: Option[String]) extends Product with Serializable

   

   Authentication principal for requests coming from an Atlassian host application in which the add-on is installed.

   Authentication principal for requests coming from an Atlassian host application in which the add-on is installed.

   host

   Host from which the request originated.

   userKey

   Key of the user on whose behalf a request was made.