- Get started
- About
- Conditions and validators comparison
- Migration to Cloud
- Connect to Assets API
- Use cases
- Dynamic Forms
- Dynamic Forms Overview
- Add Dynamic Fields
- Add Translations
- Configure Conditions
- Configure Validators
- Copy Dynamic Fields
- Display Dynamic Fields
- Dynamic Fields in Team-managed projects
- REST API
- Use Case
- Supported fields
- Bundled Fields
- Bundled Fields Overview
- Global Configuration
- Project Configuration
- Display Bundled Fields
- Search with Bundled Fields
- Automation
- Request details view
- Customization Overview
- Display Additional Details
- Display Attachments
- Display Related Issues
- Display SLAs
- Use Case
Connect to Assets API
Learn how to connect to the Assets API
You can fully exploit all functionalities of the Extension app by establishing a connection with the Assets API.
The connection is required for including the Assets custom field into your Dynamic Forms. Users with no access to the Assets API won’t be able to add the field while creating dynamic request forms.
Note that in order to use Assets in Jira Service Management it’s required to upgrade to the Premium Plan.
Accessing configuration
In order to connect to the Assets API, start with accessing the Assets API configuration view.
Before you start, log in as a user with Jira Administrators global permissions. For more information, see Atlassian documentation.
Steps
- Go to the Manage apps screen.
- Navigate to Extension for JSM.
- Select Assets API.
Result
You are redirected to the view with the Assets API configuration. The next step is to establish the connection by using your Atlassian account credentials.
Establishing connection
You can establish your connection with the Assets API by using your Atlassian account credentials:
- email address
- API token
API tokens serve for authentication allowing users to securely work with the app. The tokens can be generated from your Atlassian account. You can use your generated token by applying the copy and paste options.
To find out how to create and manage API tokens, see Atlassian documentation.
Bear in mind that the approach of connecting to the Assets API is not recommended by Atlassian. Providing your Atlassian account credentials can be done at your own risk.
Steps
- Access the Assets API configuration view.
- Enter your email address.
- Provide your API token which can be created by using the Atlassian account view.
- Click Connect.
Result
The introduced email and API token are verified. If your credentials are correct, the connection is established.
Connection problems
If you’ve introduced wrong credentials or your token’s already expired, the connection with the app can’t be established. In the case of connection problems, you’ll see the Error label under the Connection status section.
To resolve your problems with connection, try following the steps below.
Steps
- Check your credentials or generate a new API token by using the Atlassian account view.
- Click Try again.
- Establish your connection by introducing correct credentials.
Result
Your connection is established and the app functionalities are available when the label under the Connection status section is changed to Connected.
Disconnecting Assets API
You can terminate the established connection anytime simply by disconnecting the Assets API.
By terminating your connection with the Assets API you will have limited access to the app features. Users with no access to the Assets API won’t be able to include the Assets field while creating dynamic request forms.
Steps
- Access the Assets API configuration view.
- Click Disconnect.
- Confirm that you wish to disconnect the Assets API.
Result
The connection with the Assets API is terminated. You can establish a new connection by providing your API token and email address later.
If you can’t find the answer you need in our documentation, raise
a support request.
Include as much information as possible to help our support team resolve your issue faster.
