Authentication

If you are integrating directly with the Customer Service Management (CSM) REST APIs it is recommended to use the OAuth 2.0 authorization code grants (3LO) method.

For implementations with low security requirements, such as scripts and bots, it is also possible to use the Basic authentication method.

Authentication for Atlassian Forge Apps

You can access the API from a Forge app using product authentication. Use the requestJira() method of the product fetch API to have authentication applied automatically. Forge apps must declare OAuth 2.0 scopes to be authorized to access. The scopes required for each operation are listed in the documentation.

The URIs for Forge app REST API calls have this structure: /jsm/csm/api/v1/<resource-name>

For example, to retrieve an organization profile with id 123, the URI would look like: /jsm/csm/api/v1/organization/profile/123

Authentication Limitations

User Context Required: Currently these APIs only support asUser() authentication. The asApp() method is not supported. Requests using service accounts have limited support.

Authentication using OAuth 2.0

OAuth 2.0 authorization code grants (3LO) for security (3LO scopes are shown as for operations OAuth scopes required). See OAuth 2.0 (3LO) apps for details.

Authentication for Atlassian Connect apps

Support for Atlassian Connect apps to interact with the CSM APIs is currently unavailable.