Configuring IdentityIQ to Integrate with Atlassian Data Center Jira Service Management
This section provides the required information for configuring IdentityIQ to integrate with Atlassian Data Center Jira Service Management.
This is intended as an introduction to the configuration required to integrate IdentityIQ with Atlassian Data Center Jira Service Management. It outlines some examples that must be used as a reference point for implementation. Some changes may be required to meet specific use case and expertise around both systems are a must for the successful implementations.
SailPoint provides a default Atlassian Data Center Jira Service Management configuration. This configuration implements the integration between IdentityIQ and the Atlassian Data Center Jira Service Management to fulfill (fulfillment of the ticket is done manually) creation of tickets based on IdentityIQ access certification remediation events.
The default configuration is located in the following directory, where iiqHome is the location where IdentityIQ was installed:
iiqHome/WEB-INF/config/connector/IdentityIQforAtlassianDataCenterJiraServiceDesk.xml
Note
Once the following configuration information is populated then import the IdentityIQforAtlassianDataCenterJiraServiceDesk.xml file. This would create an application.
The configuration must include the following entries:
url*
In the URL field, enter the URL of the Atlassian Data Center Jira Service Management system that you want to integrate with.
Note
If Jira is installed to run in a non-root context path(i.e. it has a context path), the URL also must include this context path. For example, if Jira is running at http://www.foobar.com/Jira then the URL must be http://www.foobar.com/Jira
authenticationType*
Authentication method that is supported by the managed system:
-
Basic
This is applicable if authentication type is selected as Basic.
username*
Service Account username.
password*
Service Account password.
-
Personal Access Token
This is applicable if authentication type is selected as Personal Access Token.
apiToken*
Created Personal Access Token.
Note
For more information, see Generating a new Personal Access Token in Atlassian documentation.Note
For existing SDIMs, the user needs to add the encrypted key to the SDIM XML file.
requesterSource
The application name by which Atlassian Data Center Jira Service Management accounts are aggregated. Required for Plan Initializer script.
ticketType
Enter one of the following ticket type to generate ticket on Service Desk system:
-
serviceRequest
-
incident
-
changeRequest
Application Configuration XML would have all configurations for Service Request, Incident and Change Request. Depending on the type of selection for ticketType, respective configuration would be executed by connector for the request processing.
Each module would have provision and checkStatus entries as mentioned below:
Provision
|
Entries |
Description |
|
resource |
Ticket creation rest endpoint. Do not provide the base url in the value. Base url would be appended to this endpoint value. Provide only remaining endpoint URL. Atlassian Data Center Jira Service Management: /rest/servicedeskapi/request |
|
responseElement* |
The value is JSON path expression which provides information about where to find ticket number in the response from rest endpoint. For example, issueKey |
|
request* |
Map that represents the request payload, which has velocity template expression and velocity variables that would be dynamically updated by integration before making rest call. |
|
serviceDeskId* |
ID of the Service Desk in Jira Service Desk. To obtain the Service Desk ID, execute the following request from POSTMAN with valid credentials. If Jira is installed to run in a non-root context path (that is, it has a context path), then the url should include this context path. For example, if Jira is running at: http://www.foobar.com/Jira then the url should be: GET http://www.foobar.com/Jira/rest/servicedeskapi/servicedesk Use the id field from response and add it in the integration xml. |
|
requestTypeId* |
ID for each request type. For example,
To obtain the requestTypeId, execute the following request from POSTMAN with valid credentials. For example, if Jira is running at: http://www.foobar.com/Jira then the url must be: GET http://www.foobar.com/Jira/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype Use the value of the id which is obtained from response. Ensure that the requestTypeId belongs to the same project which would be used. Verify the serviceDeskId for the same. |
|
raiseOnBehalfOf* |
The value represents the name of the reporter. |
|
requestFieldValues* |
The map of request filed values containing description and summary. |
|
description* |
The main body of the request in Jira Service Desk, which includes the details about the request. |
|
summary* |
Title / Summary of the request in Jira Service Desk. |
Check Status
|
Entries |
Description |
|
resource |
Ticket creation rest endpoint. Do not provide the base url in the value. Base url would be appended to this endpoint value. Provide only remaining endpoint URL. Atlassian Data Center Jira Service Management: /rest/servicedeskapi/request/$ticketId |
|
responseElement* |
The value is JSON path expression which provides information about where to find ticket number status in the response from rest endpoint. For example, currentStatus.status |
|
statusMap |
Map that relates Ticket System status to IdentityIQ status. |
If any changes required in the mapping, change the default value /key values in statusMap as mentioned in the following tables:
statusMap for Service Request
|
Entry key (Atlassian Data Center Jira Service Management) |
Value (IdentityIQ) |
|
Canceled |
Failed |
|
Waiting for support |
Queued |
|
Waiting for customer |
Queued |
|
Escalated |
Queued |
|
In Progress |
Queued |
|
Pending |
Queued |
|
Closed |
Committed |
|
Resolved |
Committed |
statusMap for Incident
|
Entry key (Atlassian Data Center Jira Service Management) |
Values (IdentityIQ) |
|
Closed |
Committed |
|
Canceled |
Failed |
|
Work In Progress |
Queued |
|
Open |
Queued |
|
Pending |
Queued |
|
Completed |
Committed |
statusMap for Change Request
|
Entry key (Atlassian Data Center Jira Service Management) |
Value (IdentityIQ) |
|
Planning |
Queued |
|
Implementing |
Queued |
|
Canceled |
Failed |
|
Declined |
Failed |
|
Peer review/ change manager approval |
Queued |
|
Resolved |
Committed |
|
Closed |
Committed |
|
Pending |
Queued |
|
Awaiting CAB approval |
Queued |
|
Awaiting Implementation |
Queued |