This article will focus on all of the other functionalities available through the pyaum python module. Those miscellaneous functionalities are helper around the main methods of this library.
Set Test Environment
At some point when using the API, you may want to test the creation and removing of the users through the API without actually adding or removing anyone.
This can be achieved by using the setEnvironmentTest() method of that module.
If you are using that method, you will then create fake request to the API, that will return the value that would have been return if the request was real.
This method doesn’t take any argument, it is just adding information to the endpoint. However, if you want to get out of the test environment, you would need to re-import the configuration file.
Find your Adobe Solutions
This method (findProducts) enables you to find the different solution that are available on your admin console. It returns the list of products.
It takes one parameter but it can be any of those 3 :
- df : the dataframe that gather the group information
- csvFile : the csv file where your group information have been passed
- xslxFile : the excel file where your group information have been passed
Get all groups
This method (getAllGroups) will return a list of all of the groups, it doesn’t matter if the group is an admin group or a product profile, everything will be return in the list.
The same way that it is done with the findProducts method, it takes one parameter but 3 are possible:
- df : the dataframe that gather the group information
- csvFile : the csv file where your group information have been passed
- xslxFile : the excel file where your group information have been passed
Automate creation of the groupHandler instances
When I was creating the groupHandler class, I was quite aware that it would be pretty painful to create all of those instance by hand when you are starting your python environment. Especially if you have lots of groups already created. Therefore I created this method that will create all of the instances from the existing groups.
This method takes 2 arguments, the same way than before, for passing the group information, you can choose the element you want (csv, excel or dataframe):
- df : the dataframe that gather the group information
- csvFile : the csv file where your group information have been passed
- xslxFile : the excel file where your group information have been passed
- groupType (this is if you want to limit the creation of the instance to a specific group type), the possible values are:
- user_group : groups created by the company.
- user_admin_group : admin groups of user_groups.
- product_profile : product profile groups. The one giving custom access to a product.
- profile_admin_group : admin groups for the product_profile groups.
- profile_admin_group : admin groups for the product_profile groups.
- product_admin_group : admin groups for the products. Bind to a product.
- sysadmin_group : super admin group
- developer_group : developer group. Access to APIs of Adobe IO.
- all : all groups (default)
I hope these different methods will help you to manage the API if you want to use my python wrapper.
On this series, you may be interested to other articles:
| Articles | Comments |
| Adobe IO : JWT authentication | How to create JWT authentication with OpenSSL and python |
| Adobe IO : User Management : Introduction | What you need to know about this module |
| Adobe IO : User Management : Configuration | What do you need to have for this module. |
| Adobe IO : User Management : retrieve information | How to retrieve the information currently held on your adobe admin console. |
| Adobe IO : User Management : Create and Remove Users and Users Groups | How to create and remove users and user groups. |
| Adobe IO : User Management : User Group Class | Discover how you can handle the different group with the python class available |
| Adobe IO : User Management : Other functionnalities | Other functionalities that are included in this python module and that can be quite usefule |