Skip to content
Matthew Shaw edited this page May 24, 2024 · 46 revisions

Welcome to the analytics-cloud-scim-api-samples wiki!

Change log

24 May 2024

SCIM: new samples:

SCIM 2666 Migrate User ID (reads a data file with 2 columns - see sample data file). It creates a new user based off the old, copies roles/teams/manager assignment etc. as well as the e-mail and all other SCIM exposed properties to a new target user. It then deletes the old source user. Controls are possible to prevent source user deletion if the source user has personal and/or public content.

SCIM 2667 Scan and repair (no data file needed). It scans and optionally repairs errors for your users. The scan checks for lots of different 'tests'. Ideal for identifying and resolving any user login issue, or some SCIM API provisioning issues related to the user definition, and also ideal to check your user definitions are correct before changing the Identity Provider used by SAP Analytics Cloud. This should be a 'go to' sample. Perfectly safe to use, it won't make any changes by default.

SCIM 2668 List System Owner. It prints to the console log the current system owner.

The documentation update that describes these new samples and a blog will follow.

SCIM: error handling for very rare events improved when re-submitting Team updates (PUT /Groups/TEAMID) for samples 1654, 2665, 1403, 1903, 1203, 1665, 1123, 1113, 1653, 1133, 1233, 1983, 1612, 1953, 1933, 1602, 1103, 1802, 2666. The improvement was to prevent chunk size changes if there had previously been an error, when in some rare cases, changing the chunk size would be not ideal as sub repeated requests can complete very quickly.

3 November 2023

SCIM: scripts are now renumbered so a '1' proceeds the previous number. 001 becomes 1001 as an example.

SCIM: AdminToolKit now supports many more tests including things like last login, number of logins, personal folder content, and creator of public content. It means dormant users can now be selected with confidence enabling their optional deletion. Many new scenarios have been added to support dormant users.

SCIM: 1601 and 2601 scripts added, these list all the teams to the postman console.

SCIM: All scripts previously used the v1 API to create a team, now all scripts use v2 API to create a team which means teams are now created without a team folder.

SCIM: Sample 1653 had a minor bug, if the target team did not exist, it created it, but then didn't update it. It meant you had to run the script twice. This has now been fixed.

1 February 2023

Activities Log: Minor update to help manage http 500 response codes (these are very rare)

18 January 2023

Activities Log: First version published 0.8. This is a nodejs solution that downloads the activities log.

25 November 2022

Embedded: Added sample data file to add a new live connection to connect to DWC (officially unsupported connection, but it works!)

14 November 2022

SCIM: Minor bug fix to SCIM sample 665 - the filter optimisation was enabled when it should not always had been. Happened when the action was invert, exclude and exclude all. This is now corrected.

11 November 2022

Embedded: Various minor updates including: new config setting "ignore team namespace" that simplified Scenario E01 leading to updates to the Sample 721-E-SCIM Express setup. Added automatic creation of Postman variables required by the SCIM API samples (thanks to updates to those samples). Added a few more default system configuration settings. Added additional role to the Scenario E01 as the 'Admin' role didn't quite give everything, that's now resolved.

10 October 2022

Embedded: Minor updates to sample data files (files now have the correct name and a minor update to the roles required for admin user)

31 August 2022

Export Data: Added a duplicate set of Samples that support 3-legged OAuth. The 3-legged OAuth sample scripts start with an '8' rather than a '7' for example the 3-legged OAuth version of sample '765' is '865' etc. Whilst the user guide will be updated later, a few short instructions to get these 3-legged OAuth samples to work: You need to create a new SAC OAuth client as this new OAuth client must have the 'Redirect URI' to be 'https://oauth.pstmn.io/v1/callback'. Your web browser must allow pop-ups and re-directs for 'oauth.pstmn.io' and finally the user you use to login to SAP Analytics Cloud needs to be a non-admin user, assuming you want that user to see a restricted set of models/data. And don't forget you need to press the 'Get New Access Token' in the 'Authorization' tab of the request.

12 August 2022

SCIM: Updated environment templates. With NEO the accesstoken is required to contain a value, even an invalid value for the correct response code to be returned by the SAC API. This update simply adds a dummy value into the accesstoken value preventing a problem on the NEO platform when the Test scripts are not run beforehand. It also solves the problem when the environment is exported to be used by newman and the environment values are not persisted.

1 August 2022

SCIM: Fixed 2 bugs in script 983 related to file_transport_primary_team_displayname and file_transport_primary_team_user_membership when set to true - the display name and team members where not updated in the target when other file parameters where false this is now fixed.

SCIM: Fixed 2 bugs in script 983 related to error handling of updating the target team. This is now fixed.

SCIM: new sample 601: This lists all teams in your SAP Analytics Cloud Service. Handy to help create the data file for other sample scripts such as 953, 983

4 July 2022

Embedded: Script 743 updated: updated to reflect change in parameter. userName is changing to username. This is in response to a defect in SAP Analytics Cloud effective from wave 2022.16. It means BASIC authentication will then work but the username must be username and not userName (as the current API expects it to be). SAP internal reference FPA45-8240

1 July 2022

Embedded: Script 743 sample data file: updated to reflect change in parameter. userName is changing to username. This is in response to a defect in SAP Analytics Cloud effective from wave 2022.16. It means BASIC authentication will then work but the username must be username and not userName (as the current API expects it to be). SAP internal reference FPA45-8240

17 May 2022

Embedded: Script 711: Fixed bug when SAMLSSO was set to default caused an error at end of printing system config to console. Version 0.7.3

15 May 2022

SCIM: Version 0.7.1 update for a few of the samples. Bug fixed (typo error meant variable managerid was mistyped)

Embedded: Script 711: Added default setting for STORY_PAGE_CACHE_WIDGET_LIMIT. Added SAC and DWC URLs in summary. Version 0.7.2

14 May 2022

SCIM: Version 0.7 update published. For what's new see https://blogs.sap.com/2022/05/12/sap-analytics-cloud-user-and-team-provisioning-scim-api-sample-scripts-update-v0.7-whats-new/

4 May 2022

Export Data: First version of the Export Data Samples where added. These are version 0.7. For details see https://blogs.sap.com/2022/05/04/sap-analytics-cloud-export-data-api-sample-scripts/

6 April 2022

Embedded Samples first published with User Guide. This is version 0.7

2 March 2022

Re-organised the folder structure. There is now a 'SCIM' folder containing the samples, environments and example data files. Change was needed to separate out the 'Embedded' samples from the SCIM samples

1 March 2022

Added SAP Analytics Cloud Embedded Edition 'Extension': includes 1 environment, 18 new samples and example data files to match. Currently undocumented but this will change soon

4 February 2022

Corrected bug in scripts 903,933,953,983. Script failed when 'replace' was used for updating teams in the target when transporting users

20 November 2021

Update to collection 123 and 133. Bug fix: Teams membership did not update when user already existed.

3 November 2021

Update to collection 654. Bug fix: No longer need to run the collection twice when a new team needs to be created for the team to be updated.

29 October 2021

Major update to almost all sample collections:

  • Now 'SAML SSO' aware, meaning that no code changes are needed if you are using SAML SSO as the authentication method
  • New sample collections 409 and 429 added - these are to update the custom SAML mapping 'userName' for when using SAML SSO on 'custom' or 'email'.
  • New sample collection 654 which transfers users and roles from a team that can't be managed by the API to a team that can be managed by the API
  • New sample collection 665 - the 'AdminToolKit' which performs a full user scan and adds/removes users to/from teams based upon criteria set. If you used the previous 'early' version then you need to delete the sample datafiles as the syntax has changed.
  • New 'Scenarios' concept added which is basically a bunch of predefined sample data files that enable an end-to-end use-case.
  • Bug fixes for sample 665 - various bugs fixed
  • Documentation updated which required removing the steps for editing code due to fact the samples are now "SAML SSO" aware. Also added Scenarios and other improvements

7 October 2021

Changed file name for the example data file "Example data files/457/457 sample example 1.json". This file also had a number of minor corrections made to it.

1 October 2021

Version 0.5.2 for a new collection 665 AdminTookKit) published. This is an 'early' version of the example without documentation

2 September 2021

Minor update to sample data file "201 sample example 1.csv"

27 August 2021

Updated version 0.5.1 for sample script 102. This script no longer needs a file_JSON_teams entry in the data file, that it incorrectly needed beforehand.

7 June 2021

Updated version 0.5 with a valid URL for the blog. No code changes

28 May 2021

Version 0.5 made available on GitHub for public consumption