# PACE User Management

> This is version `2025-1` of this API documentation. Last update on Apr 3, 2025.
> The PACE User API is responsible for user related actions.

[Documentation](https://developer.pace.cloud/doc/user/2025-1.md)

OpenAPI file: https://developer.pace.cloud/doc/user/2025-1.json

## MCP server

Connect AI agents to this documentation with the User MCP server (Model Context Protocol, no authentication, Streamable HTTP transport):

- URL: `https://developer.pace.cloud/doc/user/mcp`

## [Servers](https://developer.pace.cloud/doc/user/2025-1/servers.md)
- Production server (stable release 2025-1): https://api.pace.cloud/user/2025-1 (Production server (stable release 2025-1))


## Topics

### [Authentication](https://developer.pace.cloud/doc/user/2025-1/authentication.md)


## Endpoints

### [Attributes](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-attributes.md)

- [Get the users keycloak attributes](https://developer.pace.cloud/doc/user/2025-1/operation/operation-getuserattributes.md)

- [Update the users attributes](https://developer.pace.cloud/doc/user/2025-1/operation/operation-setuserattributes.md)


### [Auditlogs](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-auditlogs.md)

- [Record audit log action](https://developer.pace.cloud/doc/user/2025-1/operation/operation-recordauditlog.md)


### [Callbacks](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-callbacks.md)

- [Password reset](https://developer.pace.cloud/doc/user/2025-1/operation/operation-callbackpasswordreset.md)


### [Federated identities](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-federated-identities.md)

- [Define federated identity](https://developer.pace.cloud/doc/user/2025-1/operation/operation-setfederatedidentity.md)

- [Delete federated identity](https://developer.pace.cloud/doc/user/2025-1/operation/operation-deletefederatedidentity.md)

- [Provide a token for a federated identity provider](https://developer.pace.cloud/doc/user/2025-1/operation/operation-grantfederatedtoken.md)


### [Gdpr](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-gdpr.md)

- [Retrieves a GDPR takeout](https://developer.pace.cloud/doc/user/2025-1/operation/operation-getgdprtakeout.md)

- [Lists GDPR takeouts](https://developer.pace.cloud/doc/user/2025-1/operation/operation-listgdprtakeouts.md)

- [Requests a GDPR takeout](https://developer.pace.cloud/doc/user/2025-1/operation/operation-requestgdprtakeout.md)

- [Retrieves a user's GDPR takeout](https://developer.pace.cloud/doc/user/2025-1/operation/operation-getusergdprtakeout.md)

- [Lists user's GDPR takeouts](https://developer.pace.cloud/doc/user/2025-1/operation/operation-listusergdprtakeouts.md)

- [Requests a GDPR takeout for a user](https://developer.pace.cloud/doc/user/2025-1/operation/operation-requestusergdprtakeout.md)


### [Maintenance](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-maintenance.md)

- [Compares the scopes between our api-definitions and Keycloak](https://developer.pace.cloud/doc/user/2025-1/operation/operation-postcheckscopes.md)


### [Preferences](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-preferences.md)

- [Get the users app preferences](https://developer.pace.cloud/doc/user/2025-1/operation/operation-getapppreferences.md)

- [Update the users app preferences](https://developer.pace.cloud/doc/user/2025-1/operation/operation-updateapppreferences.md)


### [Protocol](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-protocol.md)

- [Exchange User  Token](https://developer.pace.cloud/doc/user/2025-1/operation/operation-tokenexchange.md)


### [Sessions](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-sessions.md)

- [Update session](https://developer.pace.cloud/doc/user/2025-1/operation/operation-updatesession.md)


### [Terms](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-terms.md)

- [Checks acceptance of the terms of service for a user and a service.](https://developer.pace.cloud/doc/user/2025-1/operation/operation-checkterms.md)

- [Returns the latest terms of service by serviceName](https://developer.pace.cloud/doc/user/2025-1/operation/operation-latestterms.md)

- [Returns the latest terms of service by UUID](https://developer.pace.cloud/doc/user/2025-1/operation/operation-getterms.md)

- [Accepts the terms presented under the UUID](https://developer.pace.cloud/doc/user/2025-1/operation/operation-acceptterms.md)

- [Update the terms cache](https://developer.pace.cloud/doc/user/2025-1/operation/operation-updateterms.md)


### [User](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-user.md)

- [Deletes the current account](https://developer.pace.cloud/doc/user/2025-1/operation/operation-deletecurrentuser.md)

- [Check if user has a PIN](https://developer.pace.cloud/doc/user/2025-1/operation/operation-checkuserpin.md)

- [Set the new PIN](https://developer.pace.cloud/doc/user/2025-1/operation/operation-updateuserpin.md)

- [Check if user has a Password](https://developer.pace.cloud/doc/user/2025-1/operation/operation-checkuserpassword.md)

- [Request to set a password](https://developer.pace.cloud/doc/user/2025-1/operation/operation-createuserpassword.md)

- [Verify Email](https://developer.pace.cloud/doc/user/2025-1/operation/operation-verifyemail.md)

- [Reset password for a user.](https://developer.pace.cloud/doc/user/2025-1/operation/operation-resetpassword.md)

- [Check if user has a PIN or Password](https://developer.pace.cloud/doc/user/2025-1/operation/operation-checkuserpinorpassword.md)

- [Check if user has a phone number set.](https://developer.pace.cloud/doc/user/2025-1/operation/operation-checkuserphone.md)

- [Request a change of the users phone number](https://developer.pace.cloud/doc/user/2025-1/operation/operation-updateuserphone.md)

- [Verifies the users phone number](https://developer.pace.cloud/doc/user/2025-1/operation/operation-verifyuserphone.md)

- [Create device TOTP](https://developer.pace.cloud/doc/user/2025-1/operation/operation-createtotp.md)

- [Verify OTP](https://developer.pace.cloud/doc/user/2025-1/operation/operation-verifyotp.md)

- [Send OTP via Mail](https://developer.pace.cloud/doc/user/2025-1/operation/operation-sendmailotp.md)

- [Create OTP](https://developer.pace.cloud/doc/user/2025-1/operation/operation-createotp.md)


### [Users](https://developer.pace.cloud/doc/user/2025-1/group/endpoint-users.md)

- [Returns the user data for the given user](https://developer.pace.cloud/doc/user/2025-1/operation/operation-getuser.md)

- [Set the user data of the given user.](https://developer.pace.cloud/doc/user/2025-1/operation/operation-setuser.md)

- [Deletes a user identified by UUID](https://developer.pace.cloud/doc/user/2025-1/operation/operation-deleteuser.md)

- [Updates the user data of the given user](https://developer.pace.cloud/doc/user/2025-1/operation/operation-updateuser.md)




## Changelog

- [Changelog](https://developer.pace.cloud/doc/user/2025-1/changes.md)
- [Changelog index (llms.txt)](https://developer.pace.cloud/doc/user/2025-1/changes/llms.txt)

## Other versions (branches)

- [2025-2 (llms.txt)](https://developer.pace.cloud/doc/user/llms.txt)
- [2025-2 changelog index (llms.txt)](https://developer.pace.cloud/doc/user/changes/llms.txt)
- [2020-4 (llms.txt)](https://developer.pace.cloud/doc/user/2020-4/llms.txt)
- [2020-4 changelog index (llms.txt)](https://developer.pace.cloud/doc/user/2020-4/changes/llms.txt)
- [2021-2 (llms.txt)](https://developer.pace.cloud/doc/user/2021-2/llms.txt)
- [2021-2 changelog index (llms.txt)](https://developer.pace.cloud/doc/user/2021-2/changes/llms.txt)
- [2022-1 (llms.txt)](https://developer.pace.cloud/doc/user/2022-1/llms.txt)
- [2022-1 changelog index (llms.txt)](https://developer.pace.cloud/doc/user/2022-1/changes/llms.txt)
- [2023-1 (llms.txt)](https://developer.pace.cloud/doc/user/2023-1/llms.txt)
- [2023-1 changelog index (llms.txt)](https://developer.pace.cloud/doc/user/2023-1/changes/llms.txt)
- [2024-1 (llms.txt)](https://developer.pace.cloud/doc/user/2024-1/llms.txt)
- [2024-1 changelog index (llms.txt)](https://developer.pace.cloud/doc/user/2024-1/changes/llms.txt)
- [2024-2 (llms.txt)](https://developer.pace.cloud/doc/user/2024-2/llms.txt)
- [2024-2 changelog index (llms.txt)](https://developer.pace.cloud/doc/user/2024-2/changes/llms.txt)
- [2024-3 (llms.txt)](https://developer.pace.cloud/doc/user/2024-3/llms.txt)
- [2024-3 changelog index (llms.txt)](https://developer.pace.cloud/doc/user/2024-3/changes/llms.txt)
- [2024-4 (llms.txt)](https://developer.pace.cloud/doc/user/2024-4/llms.txt)
- [2024-4 changelog index (llms.txt)](https://developer.pace.cloud/doc/user/2024-4/changes/llms.txt)

[Powered by Bump.sh](https://bump.sh)
