Progress Software

Progress Software Users API

IAM local users are not attached to external identity providers. They can be members of IAM teams and IAM policies.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 19

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PUT /apis/iam/v2/self/{id} Update my own IAM display name or password · Update self (as user) #
Ask an LLM
“How do I change my own password as a local IAM user?”
“Do I need my previous password to set a new one on my own account?”
Tell an agent
Change my IAM display name for user {id} to {name}.
Update my own password on IAM user {id} from {previous_password} to {password}, keeping name {name}.
GET /apis/iam/v2/users List local IAM users · List all users #
Ask an LLM
“Which local IAM users exist in Automate?”
“Can I see every local user who can sign in and join IAM teams?”
Tell an agent
List all local IAM users.
Show me every local user account defined in IAM.
POST /apis/iam/v2/users Create a local IAM user · Create a user #
Ask an LLM
“How do I create a local IAM user who can sign in and be added to policies?”
“What does a new local IAM user need besides an ID, a name and a password?”
Tell an agent
Create local IAM user {id} named {name} with password {password}.
Add a new IAM sign-in for {name} using login ID {id} and password {password}.
GET /apis/iam/v2/users/{id} Get a local IAM user · Get a user #
Ask an LLM
“How do I look up the details of one local IAM user by ID?”
“What membership details does IAM return for a single local user?”
Tell an agent
Show the IAM user {id}.
Get the details of local IAM account {id}.
PUT /apis/iam/v2/users/{id} Update another local IAM user's name or password · Update a user #
Ask an LLM
“As an admin, how do I reset a local IAM user's password without their old one?”
“Can I rename a local IAM user?”
Tell an agent
Rename IAM user {id} to {name}.
Set a new password {password} for IAM user {id}, keeping name {name}.
DELETE /apis/iam/v2/users/{id} Delete a local IAM user · Delete a user #
Ask an LLM
“How do I delete a local IAM user who has left?”
“Is removing a local IAM user permanent?”
Tell an agent destructive · confirm first
Delete IAM user {id}.
Remove the local IAM sign-in {id}.
GET /api/v1/users/self Get my own transfer account details · Get current user details #
Ask an LLM
“Who am I signed in as on the file transfer server?”
“What permission level and email does my current transfer account have?”
Tell an agent
Show the details of the transfer user I'm signed in as.
Get my current account profile from the file transfer server.
GET /api/v1/users/{Id} Get a transfer user's details · Get user details #
Ask an LLM
“How do I look up a file transfer user's account by ID?”
“Can I see a transfer user's folder quota and status?”
Tell an agent
Show the transfer account details for user {Id}.
Get file transfer user {Id}'s profile.
DELETE /api/v1/users/{Id} Delete a transfer user account · Delete user #
Ask an LLM
“How do I delete a file transfer user account?”
“Can I remove a transfer user by their ID?”
Tell an agent destructive · confirm first
Delete transfer user {Id}.
Remove the file transfer account {Id} permanently.
PATCH /api/v1/users/{Id} Update a transfer user's profile · Partial user update #
Ask an LLM
“How do I change a transfer user's email address or full name?”
“Can I suspend a transfer user by changing their status?”
Tell an agent
Change transfer user {Id}'s email to {email}.
Set transfer user {Id}'s status to {status} with note {statusNote}.
GET /api/v1/users/{Id}/groups List the groups a transfer user belongs to · Get list of user groups #
Ask an LLM
“Which groups is a given transfer user a member of?”
“Can I page through a user's group memberships?”
Tell an agent
List the groups transfer user {Id} belongs to.
Show page {page} of user {Id}'s group memberships.
GET /api/v1/users/self/externaltokens List my own external tokens · Get current user external tokens #
Ask an LLM
“What external tokens are registered on my own transfer account?”
“Can I sort my registered external tokens?”
Tell an agent
List the external tokens on my account.
Show my external tokens sorted by {sortField}.
POST /api/v1/users/self/externaltokens Register an external token on my account · Register an external token with the current user's account #
Ask an LLM
“How do I register an external token with my own transfer account?”
“Can I check whether a token would be accepted without actually registering it?”
Tell an agent
Register external token {token} of type {type} on my account.
Just check whether token {token} would be accepted, check {check}.
DELETE /api/v1/users/self/externaltokens Remove my external token by its token string · Delete external token of the current user using the encoded token string #
Ask an LLM
“How do I remove one of my external tokens when I only have the encoded token string?”
“Can I unregister my own token by its value instead of its ID?”
Tell an agent destructive · confirm first
Delete my external token whose value is {token}.
Unregister my {type} token using the token string {token}.
GET /api/v1/users/{Id}/externaltokens List another user's external tokens · Get user external tokens #
Ask an LLM
“Which external tokens has a specific transfer user registered?”
“As an admin, can I audit a user's external tokens?”
Tell an agent
List the external tokens for transfer user {Id}.
Show user {Id}'s external tokens, page {page}.
GET /api/v1/users Search transfer user accounts · Get list of users #
Ask an LLM
“How do I find a transfer user by email or username?”
“Can I list only the transfer users with a given permission level or status?”
Tell an agent
Find the transfer user with email {email}.
List transfer users with permission {permission} and status {status}.
POST /api/v1/users Create or clone a transfer user · Create new user #
Ask an LLM
“How do I create a new file transfer user with a home folder?”
“Can I create a user by cloning the settings of an existing one?”
Tell an agent
Create transfer user {username} for {fullName} with email {email}.
Clone transfer user {sourceUserId} into a new account {username}.
DELETE /api/v1/users/self/externaltokens/{Id} Remove my external token by its ID · Delete external token of the current user #
Ask an LLM
“How do I revoke one of my own external tokens using its token ID?”
“Can I delete a specific token from my account if I know its ID?”
Tell an agent destructive · confirm first
Delete my external token with ID {Id}.
Revoke token {Id} from my own account.
DELETE /api/v1/users/{UserId}/externaltokens/{Id} Remove another user's external token · Delete external token of the user #
Ask an LLM
“As an admin, how do I revoke an external token belonging to another user?”
“Can I delete a specific token from someone else's transfer account?”
Tell an agent destructive · confirm first
Delete external token {Id} from user {UserId}.
Revoke user {UserId}'s token {Id}.

Documentation

📖
Documentation
https://docs.chef.io/automate/
📖
APIReference
https://docs.chef.io/automate/api/
📖
APIReference
https://docs.ipswitch.com/MOVEit/Transfer2025/Api/Rest/
📖
Documentation
https://docs.progress.com/category/moveit
📖
APIReference
https://docs.ipswitch.com/NM/WhatsUpGold2026/02_Guides/rest_api/index.html
📖
Documentation
https://www.whatsupgold.com/rest-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/progress-software/refs/heads/main/openapi/progress-software-users-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/progress-software:progress-software-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

progress-software-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Progress Software Users API
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  - x-swagger-net-version differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged users across 2 of this provider''s published API definitions: progress-software-chef-automate-openapi-original.json, progress-software-moveit-transfer-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://automate.chef.io
- url: https://127.0.0.1
tags:


# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/progress-software/refs/heads/main/openapi/progress-software-users-api-openapi.yml