Technical Articles
SAP Analytics Cloud User and Team Provisioning API | Hands-on Video Tutorials
| Earlier this year, Matthew Shaw published a technical article about user onboarding automation
For the SAP HANA Academy and the Partner Innovation Lab, we have created a video tutorials where you can see the sample scripts in action. In this article you will find the videos embedded with references and some additional information. To be informed when new posts are published about partner-related content in the video tutorials series, follow tag Questions? Please post as comment. Useful? Give us a like and share on social media. Thanks! |
Hands-On Video Tutorials
What You Will Learn
In ten videos and a little over one hour we show how to get started.
- Covers the functionality and restrictions of the Security user interface of SAP Analytics Cloud
- Explains how to register an OAuth client and work with Postman environment and collections
- Shows how we can call APIs using the command line using Newman
- Explains the process flow of a create user API call
- Shows how we can perform delete user requests
- Shows how we can perform create teams requests
- Shows how we can perform delete teams requests
- Shows how we can perform delete teams with members requests
- Shows how we can perform add/replace/delete/keep actions on users and roles within teams
- Shows how we can perform add/replace/delete/keep actions on users and teams
Playlist
For more video tutorials on the topic, check the playlist
Security Management
SAP Analytics Cloud
In this video tutorial we discuss use case and functionality of the Security Management menu to create users, teams, and role, as a prelude to automation using the SCIM API.
Time Markers
0:00 – Introduction
1:20 – SAP API Business Hub
1:50 – User, team, and role management using the System menu
2:45 – Import users from file
Resources
For the documentation about user administration, see
- Importing or Modifying Users from a File | SAP Analytics Cloud Help
For the API specification, see
- SAP Analytics Cloud Tenant API | SAP API Business Hub
Register OAuth Client
Collection 001
In this video tutorial we start our preparations, configure the Postman environment, and create an OAuth client to obtain an access and X-CSRF token.
Postman collection:
Time Markers
0:00 – Introduction and documentation references
2:50 – Postman
3:10 – Sample scripts
4:00 – Import environment and collection 001
5:00 – Configure environment
6:30 – Create OAuth client
8:15 – Get access token
9:55 – Send POST call for access token
10:30 – GET Users for x-csrf token
Resources
For product information about creating an OAuth client, see
- Manage OAuth Clients | SAP Analytics Cloud Help
- Basic Authentication Against the Token Service | SAP Analytics Cloud User and Team Provisioning API
About CSRF, see
To download Postman, visit the website (alternatively, you can use the web client). Here you can also find the documentation and other learning material, highly recommended for those interested in learning how we can interact with APIs
For Matthew Shaw‘s API best practices, see
To download the scripts, visit SAP-samples on Github
For information about namespaces, see
Newman
Collection 101
In this video tutorial we show how we can create users programmatically using the Postman Node.js command line client newman.
Postman collection:
Time Markers
0:00 – Introduction
1:20 – Execute newman run command
2:20 – Console output
Code
The command executes collection run with the environment from env.json and with data.csv as data input.
newman run run.json -e env.json -d data.csvResources
Newman is documented and available for download from NPM.org
Create User
Collection 101
In this video tutorial we show how we can create users programmatically using the SAP Analytics Cloud User and Team Provisioning SCIM API.
Postman collection:
Time Markers
0:00 – Introduction
0:30 – Download newman
1:00 – Import environment
1:30 – Import collection
2:00 – POST Users
7:30 – POST access token
8:50 – GET Users
9:40 – Run collection
9:50 – Documentation
12:00 – Error handling
Delete User
Collection 301
In this video tutorial we show how we can delete users programmatically using the SAP Analytics Cloud User and Team Provisioning SCIM API.
Postman collection:
Time Markers
0:00 – Introduction
0:40 – Deleting users in SAP Analytics Cloud
1:30 – Import collection
2:00 – Delete request
4:10 – User guide
4:50 – Run collection
6:40 – Create and delete user
Create Team
Collection 501
In this video tutorial we show how we can create teams programmatically using the SAP Analytics Cloud User and Team Provisioning SCIM API.
Postman collection:
Time Markers
0:00 – Introduction
0:30 – Teams in SAP Analytics Cloud
2:00 – Import collection
2:20 – User guide
3:50 – Input file
4:20 – Read team (GET)
5:50 – Create team (POST)
6:50 – Update team (PUT)
7:40 – Run collection
9:05 – Teams in SAP Analytics Cloud
Delete Team
Collection 801 & 802
In this video tutorial we show how we can delete teams programmatically using the SAP Analytics Cloud User and Team Provisioning SCIM API.
For very large teams with 10,000 users or more, consider using collection 802 which removes users and role assignment first before deleting the team. This to avoid a time-out on the delete statement.
Postman collections
Time Markers
0:00 – Introduction
0:30 – Import collections and set environment
0:55 – User guide
1:55 – Collection 801, common request features
3:45 – GET READ team
3:55 – DELETE team
4:20 – GET READ non-existent team
4:50 – Run collection 801
6:15 – Run collection 103 to recreate users with team
7:15 – Collection 802
7:25 – GET READ team
7:55 – PUT EMPTY team
9:05 – DELETE team
9:25 – Run collection 802
Delete Team and Users
Collection 851
In this video tutorial we show how we can delete teams and users programmatically using the SAP Analytics Cloud User and Team Provisioning SCIM API.
Postman collection
Time Markers
0:00 – Introduction
0:30 – Documentation
1:15 – GET Groups
1:50 – DELETE Users
2:15 – DELETE Groups
2:30 – GET Groups
2:45 – Run collection 851
3:50 – Result in SAP Analytics Cloud
Users and Roles Actions on Teams
Collection 602 (612)
In this video tutorial we show how we can perform add/replace/delete/keep actions on users and roles within teams using the SAP Analytics Cloud User and Team Provisioning SCIM API.
Postman collection
Time Markers
0:00 – Introduction
0:40 – User Guide
1:30 – Data file
2:10 – GET Groups
3:25 – PUT Groups
4:30 – POST Groups
5:25 – User security before
6:10 – Run collection 602
7:35 – User security after
Update Users and Teams
Collection 401 | 403 | 404
In this video tutorial we show how we can perform add/replace/delete/keep actions on users and teams using the SAP Analytics Cloud User and Team Provisioning SCIM API.
Postman collection
Time Markers
0:00 – Introduction
2:00 – User Guide
2:30 – Collection 401
6:00 – Collection 404
7:00 – Collection 403
Share and Connect
Questions? Please post as comment.
Useful? Give us a like and share on social media.
Thanks!
If you would like to receive updates, connect with me on
- LinkedIn > linkedin.com/in/dvankempen
- Twitter > @dvankempen
For the author page of SAP PRESS, visit
|
Over the years, for the SAP HANA Academy, SAP’s Partner Innovation Lab, and à titre personnel, I have written a little over 300 posts here for the SAP Community. Some articles only reached a few readers. Others attracted quite a few more.
For your reading pleasure and convenience, here is a curated list of posts which somehow managed to pass the 10k-view mile stone and, as sign of current interest, still tickle the counters each month. |
/ul>
Hi Denys,
Thanks for the Blog.
Could you please let me know, how i can post data from SAP CPI to SAP Analytics Cloud.
1.Can we use HTTP receiver adapter in SAP CPI and use POST method to send data ?
2.What is the format of SAC API needs to be used in HTTP adapter in address section ?
Could you please clarify these doubts ?
Hi Mani,
Best post this question as question > answers.sap.com
This will notify those that follow the tag and allows for knowledge sharing.
Suggest to tag with SAP Analytics Cloud and SAP Integration Suite.
Thx
Hi Denys,
I appreciate you for posting this useful blog.
I got a question regarding this API.
Thanks in advance.
Best Regards
Hello Onur,
Q
Is this API gets affected by doing manual work in security tab in SAC?
A
Yes, all changes you make to the security model are reflected in both the API and the user interface. Any difference would not be expected.
When you mention 'sometimes not working properly', I wonder what you mean?
My user guide has a lot of detail in it and also troubleshooting steps, that might be helpful and worth a visit I would say.
All the best, Matthew
Hi Matthew,
Thanks for quick reply,
What I meant is, For example if we create an user manually (not with API), will that cause API works inconsistently? In other words, Is there a rule like Only use the API to Create update delete users or teams?
Thx
Hi Onur
Q
For example if we create an user manually (not with API), will that cause API works inconsistently?
A
No, a user created either manually or via the API can be managed by the other without limitations.
There are though differences between creating a user manually and via the API, as not all properties for a user can be set when creating the user manually (time/date/number formats and language etc.)
The same applies for Teams, though there are differences (the API today creates teams with team folders, unlike manually when you have the option-though the API limitation is planned to be lifted soon). Also, when creating teams manually (and other means) then unless you change a setting, those teams can't be managed by the API.
All of these differences are documented well I would say in my user guide. Take a little while to review that guide as it will help and answers these and other related questions you're likely to have.
All the best, Matthew
Thanks Matthew!