WilliamLam.com

  • About
    • About
    • Privacy
  • VMware Cloud Foundation
  • VKS
  • Homelab
    • Resources
    • Nested Virtualization
  • VMware Nostalgia
  • Apple
You are here: Home / Automation / How to retrieve the CSP Refresh Token expiry using the CSP API

How to retrieve the CSP Refresh Token expiry using the CSP API

01.11.2019 by William Lam // Leave a Comment

I recently had question from a customer who wanted to automate the retrieval of the expiry for a given Cloud Services Platform (CSP) Refresh Token so that they could monitor it programmatically and setup notifications before the token expires. The CSP Refresh Token is required to interact with solutions within CSP including VMware Cloud on AWS (VMC).

Customers can check the current Refresh Token expiry along with the initiate create and last used time by navigating to "My Account" in the CSP UI and under "API Tokens" as shown in the screenshot below.


To retrieve this programmatically using the CSP REST API, you will need to provide a valid Refresh Token and then perform a POST am/api/auth/api-tokens/details

Here is an example using cURL:

curl -s -X POST -H "Content-Type: application/json" "https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/details" -d "{tokenValue=$REFRESH_TOKEN}"


Similarly, for those that use PowerCLI and PowerShell, I have updated my PowerShell CSP community module to include a new function called Get-CSPRefreshTokenExpiry which will nicely return the formatted output given a Refresh Token as shown in the example below.

Get-CSPRefreshTokenExpiry -RefreshToken $RefreshToken

More from my site

  • PowerShell for PhotonOS on Raspberry Pi 3
  • Managing Distributed Firewall Rules in VMC using PowerShell & NSX-T Policy API
  • Automation with the VMware Cloud Services Platform (CSP)
  • 5 ways to a run PowerCLI script using the PowerCLI Docker Container
  • VMware PowerCLI for Mac OS X, Linux & More? Yes, please!

Categories // Automation, VMware Cloud on AWS Tags // Cloud Services Platform, CSP, PowerCLI, powershell

Thanks for the comment!Cancel reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Search

Thank Author

Author

William is Distinguished Platform Engineering Architect in the VMware Cloud Foundation (VCF) Division at Broadcom. His primary focus is helping customers and partners build, run and operate a modern Private Cloud using the VMware Cloud Foundation (VCF) platform.

Connect

  • Bluesky
  • Email
  • GitHub
  • LinkedIn
  • Mastodon
  • Reddit
  • RSS
  • Twitter
  • Vimeo

Recent

  • VCF 9.0 Hardware Considerations 05/30/2025
  • VMware Flings is now available in Free Downloads of Broadcom Support Portal (BSP) 05/19/2025
  • VMUG Connect 2025 - Minimal VMware Cloud Foundation (VCF) 5.x in a Box  05/15/2025
  • Programmatically accessing the Broadcom Compatibility Guide (BCG) 05/06/2025
  • Quick Tip - Validating Broadcom Download Token  05/01/2025

Advertisment

Privacy & Cookies: This site uses cookies. By continuing to use this website, you agree to their use.
To find out more, including how to control cookies, see here: Cookie Policy

Copyright WilliamLam.com © 2025

 

Loading Comments...