Automating Provisioning Jobs and Job Logs using SAP Identity Provisioning (IPS) API

[Yogananda]

Introduction:

• Introducing SAP Identity Provisioning (IPS) APIs and its importance in managing identity lifecycle processes across cloud and on-premise systems to automate the user provisioning process across SAP Products.
• Known Limitations in IPS API

Current API Capabilities:

• Triggering Jobs: The API allows you to trigger provisioning jobs programmatically, which helps in automating the process without navigating through multiple screens .
• Retrieving Job Logs: You can also retrieve job logs to monitor the status and outcomes of the provisioning jobs

SAP IPS API Documentation

Trigger a READ Job :   https://api.sap.com/api/IPS_Proxy/resource/Jobs

 To Retrieve the Job Logs :    https://api.sap.com/api/IPS_Proxy/resource/JobLogs

IPS API Limitations:

• Viewing Source and Target Systems: Currently, there is no public API available to view the source and target systems to get the UUID directly. you will have to copy the UUID manually from UI to trigger via API
• Job Logs : There is no API available to get the List of Jobs. Again will you have to copy the UUID of the Job ran in your Provisioning Logs
• Detailed Logs: The API does not provide detailed logs that include error specifics or skipped statuses
• Scheduling : There is no API available today to trigger the schedule Job.
• Additional APIs : There are few APIs which are not available in Public but those APIs are usage in sessions based.

Try Now to execute via API

To Trigger the READ Job for the Source System with UUID

To extract the Job Logs for the Job Id 

Below template is ready for using in Visual Studio Code and replace your actual tenant details for usage

@clientid = XXXXXXXXXXXXXXXXXXX             ### Replace
@clientsecret = XXXXXXXXXXXXXXXX            ### Replace
@ias = https://XXX.accounts.ondemand.com    ### Replace


#  login
POST {{ias}}/oauth2/token?grant_type=client_credentials
Content-Type: application/x-www-form-urlencoded
Authorization: Basic {{clientid}}:{{clientsecret}}

### Access Token for Portal Users

@accessToken = {{login.response.body.access_token}}

###  https://api.sap.com/api/IPS_Proxy/overview
###   XXXXXXXXXXXXXXX is your source System connector Id
POST {{ias}}/ips/service/publicapi/v1/startJob/XXXXXXXXXXXXXXX/jobs/READ
Authorization: Bearer {{accessToken}}
Content-Type: application/json

### To Get Job Logs
#### XXXXXXX = Replace Job id selected for the Particular Job from your tenant
GET {{ias}}/ips/service/publicapi/v1/jobLogs/XXXXXXXXXXXX?logType=commonLog&action=export
Authorization: Bearer {{accessToken}}
Content-Type: application/json






##########  Not available for Public - Avaiable within Browser Sessions ######## 

###
GET {{ias}}/ips/service/publicapi/v1/sourceSystems
Authorization: Bearer {{accessToken}}
Content-Type: application/json

###
GET {{ias}}/ips/service/uiapi/v1/systems?mode=read&page=0&size=20
Authorization: Bearer {{accessToken}}
Content-Type: application/json

###
GET {{ias}}/ips/service/uiapi/v1/systems?mode=write&page=0&size=20
Authorization: Bearer {{accessToken}}
Content-Type: application/json

###
GET {{ias}}/ips/service/publicapi/v1/systems/5ff94c5b-30ea-4ba5-9ef7-ed48768e3fcc
Authorization: Bearer {{accessToken}}
Content-Type: application/json