nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Using Scriptrunner in Jira to communicate to Confluence

Daniel Volinski

Hello all,

I am trying to using Scriptrunner (inside of Jira Service Desk) to communicate to Confluence (linked application) and create a Confluence space.

So far I have:

1. Parse Jira Service Desk ticket.

2. Use Rest API to pass assign some values in creating a Confluence space (title, key, description, etc.)

The main issue that I am having is that the API does not let me pass/set admins for the space upon creation. Is there something in the API that allows me to do this? What I have read is there is not and one alternative method is using Rest Endpoints (on the Confluence side) to wait and listen for actions to happen (in this case when the space is created.

The ideal solution would be to allow me to parse the Jira Service Desk ticket, pass the admins as a parameter, and set the admins for the Confluence space upon creation of the space.

So far, to my knowledge, I have a good understanding of this, and this is my current implementation, just a snippet of what is important:

def params = [
type : "global",
name: spaceName,
key: someKey, // set the space key (in Confluence - or retrieve it from the Jira ticket
description: [
plain: [
value: someDescription
]
]
]

authenticatedRequestFactory
.createRequest(Request.MethodType.POST, "rest/api/space")
.addHeader("Content-Type", "application/json")
.setRequestBody(new JsonBuilder(params).toString())
.execute(new ResponseHandler<Response>() {
@Override
void handle(Response response) throws ResponseException {
if (response.statusCode != HttpURLConnection.HTTP_OK) {
throw new Exception(response.getResponseBodyAsString())
} else { "... do some other stuff"

Any help would be greatly appreciated, thank you!

Accepted answers

Radek Dostál

Is this Cloud or Server?

For Server there's no public REST API to update Space permissions as I remember doing this recently - I was able to automate around it by just simulating the form POST.

With dev tools just add a user, find the POST request, and use that as your template - you will probably have to bypass XSRF token though (https://developer.atlassian.com/server/jira/platform/form-token-handling/#scripting).

All comments

Radek Dostál

Is this Cloud or Server?

For Server there's no public REST API to update Space permissions as I remember doing this recently - I was able to automate around it by just simulating the form POST.

Daniel Volinski

Hi Radek,

This is for data center. And what exactly do you mean "simulating the form POST." Could you please provide some more detail please.

Alternatively, if there is a way to pass parameters from Jira Scriptrunner, to Confluence Scriptrunner, this would be an alternative, as I believe Confluence Scriptrunner has some methods specifically for Confluence that allows you to manipulate permissions/groups/etc.

Thank you,

Daniel

Radek Dostál

Hi Daniel,

I meant to look up the request via Web Dev Tools (Network) -- you add a user and press "Add", then you will find the HTTP Request in the web development tools from which you can copy it out. Then you might be able to modify that to create a more generic template for your http requests.

First you can add the user to the Space via POST (following the same process as in UI, first add the user, than later add permissions)

curl 'https://<baseUrl>/spaces/doeditspacepermissions.action?key=<SPACE KEY>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'X-Atlassian-Token: no-check' \
  -H 'Cookie: JSESSIONID=XsanitizedX' \
  --data 'usersToAdd=<username>&usersToAddButton=Add'

Then you need the userKey to modify space permissions for the user, which for we can use this interface

curl 'https://<baseUrl>/rest/api/user?username=<username>' -b 'JSESSIONID=XsanitizedX' | python -c 'import json,sys;data=json.load(sys.stdin);print data["userKey"]'

With the userKey, it's possible to give the user additionally full space permissions

curl 'https://<baseUrl>/spaces/doeditspacepermissions.action?key=<SPACE KEY>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Cookie: JSESSIONID=XsanitizedX' \
  -H 'X-Atlassian-Token: no-check' \
  --data 'confluence_checkbox_viewspace_user_<USERKEY>=on&confluence_initial_viewspace_user_<USERKEY>=on&confluence_checkbox_removeowncontent_user_<USERKEY>=on&confluence_checkbox_editspace_user_<USERKEY>=on&confluence_checkbox_removepage_user_<USERKEY>=on&confluence_checkbox_editblog_user_<USERKEY>=on&confluence_checkbox_removeblog_user_<USERKEY>=on&confluence_checkbox_createattachment_user_<USERKEY>=on&confluence_checkbox_removeattachment_user_<USERKEY>=on&confluence_checkbox_comment_user_<USERKEY>=on&confluence_checkbox_removecomment_user_<USERKEY>=on&confluence_checkbox_setpagepermissions_user_<USERKEY>=on&confluence_checkbox_removemail_user_<USERKEY>=on&confluence_checkbox_exportspace_user_<USERKEY>=on&confluence_checkbox_setspacepermissions_user_<USERKEY>=on'

That last request creeps me out but it's solid enough unless that rest endpoint changes in the future versions.

Note that '-H 'Cookie: JSESSIONID=XsanitizedX'' is basically the same as basic authentication via '-u username:password', just more performant.

I'm not sure how you do authentication in your implementation but I assume it's no problem so just mentioning this in case.

Now is this a pretty implementation, heeeeelll noo, no, no no. It was my makeshift because of missing API.

If you have ScriptRunner on Confluence also then you could probably make your own REST endpoint which would be TON better: https://scriptrunner.adaptavist.com/6.16.0/confluence/rest-endpoints.html

I've found this post with a supposedly working example: https://community.atlassian.com/t5/Confluence-articles/Update-Space-Permissions-without-Space-Admin-Part-1/ba-p/1274567

I imagine it could be simplified if you are always going to give the user the same permissions, because that example goes in extra detail.

Sorry I didn't realize at first you have ScriptRunner on Confluence also, I was under the wrong impression from the beginning, otherwise I'd suggest the rest endpoint instead

Maybe you could unify everything into a single script on Confluence and just pass username(s) as parameters, effectively just skipping the entire http request chain.

Do please take a look at the link above - this should work perfectly for your use case.

Thanks,
Radek

Daniel Volinski

Hi Radek,

Thank you for all of the information, this is great!

To follow-up, this command:

curl 'https://<baseUrl>/rest/api/user?username=<username>' -b 'JSESSIONID=XsanitizedX' | python -c 'import json,sys;data=json.load(sys.stdin);print data["userKey"]'

I see there are some python library imports, is this necessary? Let me be more specific, I am implementing this inside of a post function on Scriptrunner.

I took a look at the link you provided above: https://community.atlassian.com/t5/Confluence-articles/Update-Space-Permissions-without-Space-Admin-Part-1/ba-p/1274567 and I am not sure this exactly works (please correct me if I'm wrong)...

Based on the example, it looks like the script is adding users to an already defined admin group. In my case, I am creating a space from a Jira Service Desk ticket. My instance of Jira and Confluence are linked, so they can communicate to each other:

/**
 * Retrieve the primary confluence application link
 * @return confluence app link
 */
def ApplicationLink getPrimaryConfluenceLink() {
    def applicationLinkService = ComponentLocator.getComponent(ApplicationLinkService.class)
    final ApplicationLink conflLink = applicationLinkService.getPrimaryApplicationLink(ConfluenceApplicationType.class)
    conflLink
}

However, once the space is created (from the post function in Jira Scriptrunner), the last piece I need is to set the admins of that space in Confluence (space tools -> permissions -> Individual Users) and add them here. This user(s) would be some field parsed from the Jira ticket. So how would I pass this parameter (either one item - "String" or a list[] of admins) to the Confluence side.

I hope this makes sense, and I can try to explain further if you need more explanation.

Thank you again for all of the content, much appreciated!

Daniel

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

adaptavist

embrace-remote