Backup and Restore

This tab will help you to transfer your app configurations when you change your Jira instance; e.g. when you migrate from the test environment to production, the app configurations can be transferred in two ways:

1. Download/Upload app Configurations by File.

  • Download the app configuration file by clicking on the link given below.
  • Install the app on the new Jira instance.
  • Upload the configuration file in the Download/Upload app Configurations by File section.

2. Configure/Fetch app configuration via REST API.

  • To fetch app configuration from the test instance you need a URL from the test environment and you need to use GET.
  • To configure the app at the production instance you need a URL from production and you need to use POST.
  • URLs and steps you will find below in Configure app via REST API section.
  • And just like that, all your app configurations will be transferred!

Example Raw format data to be send/receive in body

{
    "PLUGIN_NAME": "OAuth/OpenID Connect (OIDC) for  Jira  SSO",
    "PLUGIN_VERSION": "2.0.0",
    "Identity Providers": [
    {
    "ID": "07260006-28c1-4174-9df0-919a46478da2",
    "Name": "OKTA",
    "SSO Configuration": {
    "CLIENT_ID": "",
    "REALM_NAME": "",
    "USERINFO_END_POINT": "",
    "TENANT_ID": "",
    "DOMAIN_NAME": "",
    "AUTHORIZE_END_POINT": "",
    "FETCH_GROUPS_ENDPOINT": "",
    "CUSTOM_APP_NAME": "OKTA",
    "IDP_ID": "",
    "CUSTOMIZABLE_CALLBACK_URL": "",
    "ACCESSTOKEN_END_POINT": "",
    "SINGLE_LOGOUT_URL": "",
    "APP_HOSTED_ON": "cloud",
    "CLIENT_SECRET": "",
    "SCOPE": "openid",
    "DEFAULT_APP_NAME": "Okta"
    },
    "Attribute Mapping": {
    "ENABLE_LANGUAGE_MAPPING": false,
    "ENABLE_REGEX_PATTERN": false,
    "UPDATE_EXISTING_USER_ATTRIBUTES": false,
    "CUSTOM_ATTRIBUTE_MAPPING": {},
    "LAST_NAME_ATTRIBUTE": "",
    "USE_SEPARATE_NAME_ATTRIBUTE": false,
    "LOGIN_USER_BY_ATTRIBUTE": "username",
    "FULL_NAME_ATTRIBUTE": "displayName",
    "EMAIL_ATTRIBUTE": "",
    "USERNAME_ATTRIBUTE": "givenName",
    "LANGUAGEMAP": "",
    "CUSTOM_LANGUAGE_ATTRIBUTE": "",
    "FIRST_NAME_ATTRIBUTE": "",
    "REGEX_PATTERN": ""
    },
    "Group Mapping": {
    "KEEP_EXISTING_USER_ROLES_OAUTH": false,
    "RESTRICT_USER_CREATION": false,
    "EXCLUDE_GROUPS": "jira-administrators",
    "ON_THE_FLY_GROUP_MAPPING": false,
    "ON_THE_FLY_FILTER_GROUP_KEY": "",
    "DEFAULT_GROUPS": "jira-software-users",
    "ENABLE_DEFAULT_GROUPS_FOR": "newUsers",
    "ROLE_ATTRIBUTE": "",
    "ON_THE_FLY_ASSIGN_NEW_GROUPS_ONLY": true,
    "CREATE_USER_IF_ROLE_MAPPED": false,
    "REMOTE_DIRECTORY_SYNC": false,
    "ON_THE_FLY_GROUP_OPTION": "None",
    "CREATE_NEW_GROUPS": false,
    "ROLE_MAPPING": {},
    "KEEP_EXISTING_USER_ROLES": false
    }
    }],
    "Sign In Settings": {
    "ALLOWED_DOMAINS": "",
    "ADMIN_SESSION_OPTION": "",
    "DISABLE_DEFAULT_LOGIN": "true",
    "ENABLE_AUTO_REDIRECT_DELAY": "false",
    "ENABLE_BACKDOOR": "true",
    "BACKDOOR_KEY": "oauth_sso",
    "BACKDOOR_VALUE": "false",
    "ENABLE_FOR_SOFTWARE": "",
    "ENABLE_FOR_SERVICE_DESK": "",
    "ENABLE_FOR_AGENTS": "",
    "AGENTS_GROUP_REGEX_PATTERN": "",
    "DISABLE_DEFAULT_LOGIN_JSM": "false",
    "ENABLE_BACKDOOR_JSM": "true",
    "RESTRICT_AUTO_REDIRECT_URL": "",
    "AUTO_REDIRECT_DELAY_INTERVAL": "5",
    "RESTRICT_BACKDOOR": "true",
    "BACKDOOR_GROUPS": ["jira-administrators"],
    "DISABLE_ANONYMOUS_ACCESS": "false",
    "ALLOW_GUEST_LOGIN": "false",
    "RELAY_STATE": "",
    "GUEST_SESSION_TIMEOUT": ""
    },
    "Domain mapping": {
    "USE_DOMAIN_MAPPING": "",
    "DOMAINS": "",
    "DOMAIN_MAPPING": ""
    },
    "Redirection rules": {
    "LOGIN_BUTTON_TEXT": "",
    "SSO_BUTTON_LOCATION": "",
    "RELAY_STATE": "",
    "REDIRECTION_RULE": "",
    "APP_REDIRECTION_RULES": "",
    "JSM_REDIRECTION_RULES": "",
    "APP_DEFAULT_REDIRECT_URL": "",
    "JSM_DEFAULT_REDIRECT_URL": "",
    "DEFAULT_APP_IDP": "a10dd75d-fa58-4156-8730-9e2abe8a2bc5",
    "DEFAULT_JSM_IDP": "07260006-28c1-4174-9df0-919a46478da2"
    },
    "Global Settings": {
    "ENABLE_FOR_SOFTWARE": "",
    "ENABLE_FOR_SERVICE_DESK": "",
    "ENABLE_FOR_AGENTS": "",
    "ENABLE_PASSWORD_CHANGE": "",
    "PLUGIN_API_ACCESS_RESTRICTION": "",
    "AUTO_ACTIVATE_USER": "",
    "ENABLE_OAUTH_SSO": "true",
    "CHECK_IDP_SESSION": "false",
    "ENABLE_DEBUG_LOGS": ""
    },
    "Session management": {
    "USER_SESSION_TIMEOUT": {},
    "LOGIN_COOKIE": "",
    "REMEMBERME_COOKIE": ""
    },
    "Advanced Configuration": {
    "CUSTOM_LOGOUT_URL": "",
    "ENABLE_LOGOUT_TEMPLATE": "true",
    "LOGOUT_TEMPLATE":  ""
    "ENABLE_LOGIN_TEMPLATE": "",
    "LOGIN_TEMPLATE": "",
    "ENABLE_JSM_LOGIN_TEMPLATE": "",
    "SSO_BUTTON_LOCATION": "",
    "JSM_LOGIN_TEMPLATE": "",
    "ENABLE_ERRORMSG_TEMPLATE": "",
    "ERROR_MSG_TEMPLATE": "",
    "CUSTOM_ERROR_TEMPLATE": "",
    "AUTO_ACTIVATE_USER": ""
    }
    }