How to pull data from Oracle IDCS (Identity Cloud Services) rest API

Updated: Nov 3, 2018

Oracle IDCS has various rest apis which can be used to pull data and you can utilize it further for data analytics. Lets see how we can pull data using simple shell scripts.

Step1: Create a parameter file "param.txt" which will contain Customer ID, Customer secret and organization url (all in new line). You can leave the environment name as it is. Please note below values are just dummy values to showcase how you need to create param file. Validate using postman if your keys are working properly before running the script.

scripts> pwd


scripts> more param.txt








Step2: At the same path create the script for pulling data in JSON format, brief description is given before each step.

#Check if parameter file exists and its parameters


[ -f ./param.txt ] && echo "Parameter file is present" || echo "Parameter file not found!! Create param.txt with CID,CSEC,ORG,ENV details."

ENV=`head -8 ./param.txt | tail -1`

[ -z "$ENV" ] && echo "Environment variable is empty" || echo "Environment variable looks good"

case $ENV in

DEV) echo "Welcome to DEV environment!" ;;

QUAL) echo "Welcome to QUAL environment!"

CID=`head -2 ./param.txt | tail -1`

CSEC=`head -4 ./param.txt | tail -1`

ORG=`head -6 ./param.txt | tail -1`

sleep 1;;

PL) echo "Welcome to ProdLike environment!" ;;

PT) echo "Welcome to ProdTest environment!" ;;

PROD) echo "Welcome to PROD environment!" ;;

*) echo "Invalid environment selection!" ;;


# Create basic_token base64, basic_token generated at

basic_token=`echo -n $CID:$CSEC | base64 -w 0`

# Function to regenerate token if token test fails or expires



curl -X POST \

"$ORG/oauth2/v1/token" \

-H "Authorization: Basic $basic_token" \

-H "Cache-Control: no-cache" \

-H "Content-Type: application/x-www-form-urlencoded" \

-d "grant_type=client_credentials&scope=urn%3Aopc%3Aidm%3A__myscopes__" | awk -F[":"] '{print$2}' | awk -F[","] '{print$1}' | awk '{print substr($0, 2, length($0) - 2)}' > access_token.tmp

echo "New token is generated.. access_token refreshed!!"


# Testing if token is valid, if invalid generate the new token

access_token=`more access_token.tmp`

tokenTest=`curl -X POST "$ORG/oauth2/v1/introspect" -H "Authorization: Basic $basic_token" -H "Cache-Control: no-cache" -H "Content-Type: application/x-www-form-urlencoded" -d token=$access_token | awk -F"," '{print$1}' | awk -F":" '{print$2}' | sed 's/[{}]//g'`

if [ "$tokenTest" = "true" ]; then echo "Token is valid..";


echo "Invalid token! Invoking func to pull new token.."


access_token=`more access_token.tmp`


# Remove all the previous files. Script can be modified later to pull delta records only

rm -f auditevents.idcs*

# Pull totalResults count

totalResults=`curl -X GET "$ORG/admin/v1/AuditEvents?&count=0" -H "Authorization: Bearer $access_token" -H "Cache-Control: no-cache" | awk -F"\"totalResults\"\:" '{print$2}'

| awk -F"," '{print$1}'`

echo "Total number of qualified records: $totalResults"

sleep 5

# Loop to pull the records with maximum limitation of 1000 items per page



while [ $startIndex -le $totalResults ]


echo "startIndex: $startIndex"

curl -X GET \

"$ORG/admin/v1/AuditEvents?&startIndex=$startIndex&count=$itemsPerPage" \

-H "Authorization: Bearer $access_token" \

-H "Cache-Control: no-cache" | awk -F"Resources" '{print$2}' | awk -F"startIndex" '{print$1}' | cut -c 4- | rev | cut -c 4- | rev > auditevents.idcs.json

# Formatting the JSON output and writing into a file with date time



sed "s/$PAT/$REP_PAT/g" auditevents.idcs.json > auditevents.idcs.json_`date +"%Y%m%d_%H%M%S%N"`

startIndex=`expr $startIndex + 1000`


# Remove access token temp file

rm -f access_token.tmp


See also -

Thank you!! If you enjoyed this post, I’d be very grateful if you’d help it spread by emailing it to a friend, or sharing it on Google or Facebook. Refer the links below.

Also click on "Subscribe" button on top right corner to stay updated with latest posts. Your opinion matters a lot please comment if you have any suggestion for me.

#howto #PULL #DATA #oracle #idcs #howtopulldatafromoracleidcs #identitycloudservices

383 views0 comments

Help others, write your first blog today!