Important Update Effective February 1, 2024!
Due to recent changes in Jira and Confluence, we've made the tough decision to discontinue the OpenID Connect (OIDC)/OAuth app and no longer provide new versions for the newest Jira/Confluence releases as of January 31, 2024.
This is due to some necessary components no longer shipping with Jira/Confluence, which would require some extensive rewrites of the OIDC App.
Modify a Usersync Configuration Offline
This tutorial explains how to download an existing Usersync connector configuration via REST, how to modify it and upload it back again via REST.
That way you could re-use parts of existing configurations, i.e. on a staging server, without creating everything again by hand.
Normally this only makes sense, if you've added a lot of transformation rules across the config.
The steps below are intended for users who are familiar with REST and JSON, please contact our support, if you have any doubts.
Changing a configuration that way should be done with good care.
- Find the Usersync connector Id by clicking on the edit button first, and then scroll down to the Connector Id field of the first tab.
GET the connector configuration, i.e. with Postman. The URL to retrieve the config looks like this, with the connector ID at the end:
https://<basurl>/rest/samlsso-admin/1.0/usersync/connector/68e7f826-af8d-43f3-b303-4d3a28e83993Use a local user and password (or API Token) with admin permissions for the Basic Auth. REST doesn't work with SAML
- Extract the configuration from the response
- not everything in the response from the call above is the configuration, you only need to preserve the configuration node of the JSON response
- We recommend pasting the response to a config.json file and open it in a text editor like Notepad++ or any other editor which highlights opening and closing brackets
- the below example shows the part which needs to be extracted, the value of the configuration field, including the curly brackets
- some of the child nodes have been collapsed for better readability
- some of the child nodes have been collapsed for better readability
- Copy that part, paste it to a new file and edit it as required
- in the sample below I've changed the connector name and added a transformation
- in the sample below I've changed the connector name and added a transformation
- Copy the edited configuration and paste it back to Postman...
- ... into the Body tab with the radio button at "raw" and As JSON
- change the request method to PUT and press send
- you should get a 200 OK Result and see the complete response again
- checking the Usersync connector via the UI after refreshing the page should reflect the changes
