Atlassian has begun rolling out major Cloud platform changes that will impact CLI users. These changes are partially due to their efforts to to meet Atlassian's GDPR Commitment.
The platform changes relate to removal or changes to REST APIs that are critical for CLI operations. CLI users needing to access Cloud platforms will need to upgrade their CLI client to the latest level available as these platform changes rollout and finally complete.
Cloud Platform Rollouts
Jira Cloud
Platform rollouts started April 29, 2019, for a few instances and will likely continue throughout the month of May. See Atlassian information for the latest from them on this topic.
Jira Cloud CLI users should update their clients to Release 8.8 or newer to continue to work properly. Some result data related to users returned by the platform will be different and this will show in the CLI output data.
One of the most important changes, is that user references for reporter, assignee, lead, etc...., must now be done using the Atlassian account id (this is unique user key) associated with the user or the user's full display name or substitute. A substitute could be the user's email address but only if that user has chosen to publicly share that address. Using the account id is the most efficient, otherwise, a lookup needs to be done to convert the name to their actual Atlassian account id. Script writers should use account ids whenever possible. User Identification has a bit more on this topic.
Confluence Cloud
Platform rollouts started July 1, 2019. See Atlassian information for the latest from them on this topic.
Confluence Cloud CLI users should update their clients to Release 8.8 or newer to continue to work properly. Some actions are no longer available for Confluence Cloud as Confluence Cloud has not yet provided replacement APIs for the APIs they removed. Once support is returned to Confluence Cloud, the CLI will re-enable those actions. Some result data related to users returned by the platform will be different and this will show in CLI output data. CSOAP-1050 - Getting issue details... STATUS has more detailed information on this. One of the most likely impact areas is with managing space permissions (add and remove) - these actions will no longer be possible on Release 8.6 or higher.
One of the most important changes is that user references for author and similar must now be done using the Atlassian account id (a unique id) associated with the user or the user's full display name or substitute. A substitute could be the user's email address but only if that user has chosen to publicly share that address. Using the account id is the most efficient, otherwise, a lookup needs to be done to convert the name to their actual Atlassian account id. Script writers should use account ids whenever possible. User Identification has a bit more on this topic.
Bitbucket Cloud
Platform rollouts that impact Bitbucket Cloud CLI have already been rolled out. These impacts are relatively minor.
Bitbucket Cloud CLI users should update their clients to Release 8.5 or newer to continue to work properly.
Cloud Authentication Changes
Earlier this year, other Cloud platform changes were made to force the use of API tokens (in place of passwords) for Cloud API access. Earlier releases of CLI 8.x were modified to support this use. See Authentication for more information on this topic.
Problem Determination
- For some Confluence Cloud API removals, you may see the following if you do not have an updated CLI client:
- Remote error: Action disallowed. Response code: 403.
- Remote error: Unknown error occurred on server. Response code: 501.
- If you are NOT using the email address and API token for your user credentials for accessing Cloud sites (see Authentication), you will likely receive: Remote error: User is not authorized to perform the request. Response code: 401.
- Even when using an API token, we have cases of 401 errors caused by older API tokens. Generate a new token and try again.
Links
- Authentication - different authentication requirements for Atlassian access
- User Identification - CLI terminology related to users
- Major Change to Jira Cloud REST APIs are Coming to Improve User Privacy
- Bitbucket Cloud REST APIs are Changing to Improve User Privacy
- CSOAP-1050 - Getting issue details... STATUS
- JCLI-1471 - Getting issue details... STATUS
