Configure authentication

Enter the details based on the authentication you want to use.

• OAuth2.0
  • Client ID:Client ID as provided by your external application.
  • Scopes:Permission scopes. Theoffline_access scope must be used with the Jira Service Management connector. To understand how the scopes work and to view all the available scopes for Jira Service Management, seeScopes.
  • Client secret:Select theSecret Manager secret. You must have created the Secret Manager secret before configuring this authorization.
  • Secret version:Secret Manager secret version for client secret.

  For theAuthorization code authentication type, after creating the connection, you must perform a few additional steps for configuring authentication. For more information, seeAdditional steps after connection creation.

  Note: If you are usingAuthorization code authentication type and have made any cofiguration changes in your Jira Service Management application, you must re-authorize your Jira Service Management connection. To understand how to re-authorize, seeRe-authorization for Authorization code.
• Basic
  • Username: The Jira Service Management user account used to authenticate.
  • Password: The password associated with the account.
• APIToken
  • Username: The Jira Service Management username used to create the API token.
  • API Token: The password for the username will be an API token. Select the Secret Manager Secret containing the API Token associated with the Jira Cloud username.

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects ofthe connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity:An entity can be thought of as an object, or a collection of properties, in theconnected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case theEntities list will be empty.

• Operation:An operation is the activity that you can perform on an entity. You can performany of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list ofoperations available for the entity. For a detailed description of the operations, see the Connectors task'sentity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in theOperations list.

• Action:An action is a first class function that is made available to the integrationthrough the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case theActions list will be empty.

Actions

The Jira Service Managmenet connector provides actions, such as AddAttachment, AttachTemporaryFile and CreateCustomer. To understand how to configure the actions, seeAction examples.

Action examples

This section describes how to perform some of the actions in this connector.

Example - Attach a temporary file

This example attaches a temporary file and provides an attachment ID that you use to add an attachment.

1. In theConfigure connector task dialog, clickActions.
2. Select theAttachTemporaryFile action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"Content":"test to create 1 temporaryid"}

If the action is successful, yourconnector task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{"TemporaryAttachmentId":"3ef17ee7-3877-4ac6-b586-481cb2121ef8","FileName":"16324233309516250343.connector.txt"}]

Example - Add an attachment

This example attaches the temoporary file to the Request ID provided in the input payload.

1. In theConfigure connector task dialog, clickActions.
2. Select theAddAttachment action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"AttachmentId":"3ef17ee7-3877-4ac6-b586-481cb2121ef8","RequestId":"10032"}

If the action is successful, yourconnector task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{"Success":"true","filename":"16324233309516250343.connector.txt",}]

Example - Create a customer

This example creates a customer.

1. In theConfigure connector task dialog, clickActions.
2. Select theCreateCustomer action, and then clickDone.
3. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {"Email":"something@something.com","FullName":"Something"}

If the action is successful, yourconnector task'sconnectorOutputPayload responseparameter will have a value similar to the following:

[{"Key":null,"AccountId":"qm:476582de-e968-4bc9-b0be-0349e8e3ec97:244dd7e4-0b49-4468-adac-561ab09bf2bb","Name":null,"EmailAddress":"something@something.com","DisplayName":"Something","Active":"true","Timezone":"Asia/Calcutta","_links.jirarest":"https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb","_links.avatarurls.48x48":"https://avatar-management.services.atlassian.com/default/48","_links.avatarurls.24x24":"https://avatar-management.services.atlassian.com/default/24","_links.avatarurls.16x16":"https://avatar-management.services.atlassian.com/default/16","_links.avatarurls.32x32":"https://avatar-management.services.atlassian.com/default/32","_links.self":"https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb"}]

Entity operation examples

Example - List all the Requests

This example lists all the requests in theRequests entity.

1. In theConfigure connector task dialog, clickEntities.
2. Select Requests from theEntity list.
3. Select theLIST operation, and then clickDone.

Example - Get Requests from a specific Service Desk ID

This example gets the request with having the RequestKey as DP1-14 from theRequests entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectRequests from theEntity list.
3. Select theLIST operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickfilterClause and then enterRequestKey='DP1-14' in theDefault Value field.

   Here,RequestKey is the primary key value of theRequests entity.

Example - Create a Request

This example creates a request in theRequests entity.

1. In theConfigure connector task dialog, clickEntities.
2. SelectRequests from theEntity list.
3. Select theCreate operation, and then clickDone.
4. In theTask Input section of theConnectors task, clickconnectorInputPayload and then enter a value similar to the following in theDefault Value field:

   {,,,)VALUES('2','1','','test');"RequestTypeId":"2","ServiceDeskId":"1","Summary":"test","Description":"test"}

   If the integration is successful, your connector task'sconnectorOutputPayload field will have a value similar to the following:

   {"RequestId":"10032"}

Use the Jira Service Management connection in an integration

After you create the connection, it becomes available in bothApigee Integration and Application Integration. You can use the connectionin an integration through the Connectors task.

• To understand how to create and use the Connectors task in Apigee Integration, seeConnectors task.
• To understand how to create and use the Connectors task in Application Integration, seeConnectors task.