list_credentials

#!/bin/bash
#
# This script is used to list all the Workload Factory credentials the
# user has access to. 
#
# It is dependent on the 'wf_utils' file that is included in this repo. That
# file contains the 'get_token' function that is used to obtain a valid
# access token that is needed to run the Workload Factory APIs. The file needs
# to either be in the command search path or in the current directory.
################################################################################

################################################################################
# Display usage information then exits the script.
################################################################################
usage() {
  cat >&2 <<EOF
This script lists all the Workload Factory credentials you has access to.

Usage: $(basename $0) -t refresh_token -a blueXP_account_ID [-o] [-j]

Where: refresh_token - Is a refresh token used to obtain an access token needed
                       to run the Workload Factory APIs. You can obtain a refresh
                       token by going to https://services.cloud.netapp.com/refresh-token
       blueXP_account_ID - is the BlueXP account ID. You can find all the accounts
                           you have access to by running the "list_bluexp_accts" script
       -o means to also show the ONTAP credentials
       -j means to output the results in JSON format instead of a table.

Instead of passing parameters on the command line, you can set the
following environment variables:

    export REFRESH_TOKEN=<refresh_token>
    export BLUEXP_ACCOUNT_ID=<blueXP_account_ID>
EOF
  exit 1
}

################################################################################
# Main logic starts here.
################################################################################
tmpout=$(mktemp /tmp/list_credentials-out.XXXXXX)
tmpout2=$(mktemp /tmp/list_credentials-out2.XXXXXX)
tmperr=$(mktemp /tmp/list_credentials-err.XXXXXX)
trap 'rm -f $tmpout $tmpout2 $tmperr' exit
#
# Source the wf_utils file.
wf_utils=$(command -v wf_utils)
if [ -z "$wf_utils" ]; then
  if [ ! -x "./wf_utils" ]; then
    cat >&2 <<EOF
Error: The 'wf_utils' script was not found in the current directory or in the command search path.
It is required to run this script. You can download it from:
https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples
EOF
    exit 1
  else
    wf_utils=./wf_utils
  fi
fi
. "$wf_utils"
#
# Set defaults.
raw=false
filter="filter=$(urlencode "type eq 'AWS_ASSUME_ROLE'")"
while getopts "ht:a:oj" opt; do
  case $opt in
    t) REFRESH_TOKEN="$OPTARG" ;;
    a) BLUEXP_ACCOUNT_ID="$OPTARG" ;;
    o) filter="";; # No filter, list all credentials.
    j) raw=true ;;
    *) usage ;;
  esac
done
#
# Declare an array of required options and the error message to display if they are not set.
declare -A required_options
required_options["REFRESH_TOKEN"]='Error: A BlueXP refresh tokon is required to run this script. It can be obtain from this web page:
  https://services.cloud.netapp.com/refresh-token\n\n'
required_options["BLUEXP_ACCOUNT_ID"]='Error: A BlueXP account ID is required to run this script.
You can get the list of accounts you have access to by running the "list_bluexp_accts" script
found in this GitHub repository: https://github.com/NetApp/FSx-ONTAP-samples-scripts/tree/main/Management-Utilities/Workload-Factory-API-Samples\n\n'

check_required_options
#
# Check that the required commands are available.
for cmd in curl jq; do
  if ! command -v $cmd > /dev/null 2>&1; then
    echo "Error: The required command '$cmd' was not found. Please install it." >&2
    exit 1
  fi
done

token=$(get_token)
if [ -z "$token" ]; then
  echo "Error: Failed to obtain an access token. Exiting." >&2
  exit 1
fi

jq_query='.items[] | if(.type == "ONTAP") then "\(if(.metadata.fileSystemId != null) then .metadata.fileSystemId else if(.metadata.onPremId != null) then .metadata.onPremId else empty end end) \(.type) \(.metadata.userName) \(.id) \(.numAssociatedResources)" else "\(if(.metadata.name != null) then .metadata.name else "N/A" end) \(.type) \( if(.credentials != null) then .credentials | split(":") | .[4] else "N/A" end) \(.id) \(.numAssociatedResources)" end'

run_curl GET "$token" "https://api.workloads.netapp.com/accounts/${BLUEXP_ACCOUNT_ID}/credentials/v1/credentials?$filter" $tmpout $tmperr
if [ $raw == "true" ]; then
  if jq -r . $tmpout 2>&1 > /dev/null ; then
    :
  else
    cat $tmpout
  fi
else
  if jq -r "$jq_query" $tmpout > $tmpout2 2> $tmperr; then
    :
  else
    echo "Failed to parse the output from the API."
    cat $tmperr >&2
    exit 1
  fi
fi
#
# Check to see if there are more.
nextToken=$(jq -r '.nextToken' $tmpout)
while [ "$nextToken" != "null" ]; do
  run_curl GET "$token" "https://api.workloads.netapp.com/accounts/${BLUEXP_ACCOUNT_ID}/credentials/v1/credentials?nextToken=$nextToken" $tmpout $tmperr
  if [ $raw == "true" ]; then
    if jq -r . $tmpout 2>&1 > /dev/null ; then
      :
    else
      cat $tmpout
    fi
  else
    if jq -r "$jq_query" $tmpout >> $tmpout2 2> $tmperr; then
      :
    else
      echo "Failed to parse the output from the API."
      cat $tmperr >&2
      exit 1
    fi
  fi
  nextToken=$(jq -r '.nextToken' $tmpout)
done

if [ $raw != "true" ]; then
  sort -f -k 2,2 -k 1,1 $tmpout2 | column -t -N "Name,Type,Account,ID,Number Associated Resources"
fi