This page is part of the Gadget Developers' JavaScript Cookbook.
How do I use authentication in my gadget?
Excerpt |
---|
Specify the appropriate features as 'required' in your gadget XML, include the necessary resources in the CDATA section, and use the useOauth parameter when constructing your gadget: - Specify the appropriate features as 'required' in the gadget XML:
Code Block |
---|
|
<Require feature="oauthpopup" />
#oauth
|
- Include the following resources at the beginning of the CDATA section:
Code Block |
---|
|
#requireResource("com.atlassian.jira.gadgets:common")
#includeResources()
|
- Construct a gadget passing the URL in the
useOauth param: Code Block |
---|
|
var gadget = AJS.Gadget({
baseUrl: "__ATLASSIAN_BASE_URL__",
useOauth: "/rest/gadget/1.0/currentUser",
...
|
- Any Ajax call will now go through the authentication steps if required.For example:
Code Block |
---|
|
AJS.$.ajax({
url: "/rest/gadget/1.0/filtersAndProjects",
type: "GET",
data: ({projectsOnly : "true"}),
dataType: "json",
success: function(msg) {
alert(msg);
}
});
|
|
Gadget Developers' JavaScript Cookbook
Using the Atlassian Gadgets JavaScript Framework