# PACE User Management ## Description This is version `2024-3` of this API documentation. Last update on Oct 14, 2024. Welcome to the PACE User Management API documentation. This API is responsible for user related actions. # Handling Terms of Service PACE services often require the acceptance of *Terms of Service* to execute API actions. The terms are required for legal reasons. Some of the API surface may not require the acceptance of terms. Usually, the terms need to be accepted before doing manipulations like `DELETE`, `PUT`, `POST` and similar. If a service requires a user to accept the terms of service a `451 Unavailable For Legal Reasons` status code will be returned together with a `Location` header that indicates the terms that need to be accepted. The URL points to the [GetTerms](#operation/GetTerms) and can then be followed by the [AcceptTerms](#operation/AcceptTerms). The terms can be viewed and accepted with a regular browser. A simple way to assure that the *terms of service* are accepted, before the user does any action is, to call the [CheckTerms](#operation/CheckTerms) API before the application, together with a `redirectUri` to the next step of the application process. ## Servers - Production server (stable release 2024-3): https://api.pace.cloud/user/2024-3 (Production server (stable release 2024-3)) ## Authentication The API accepts 2 different authentication methods: - Oidc (openIdConnect) - OAuth2 ## Endpoints and operations ### [Attributes](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-attributes.md) - [Get the users keycloak attributes](https://developer.pace.cloud/doc/user/2024-3/operation/operation-getuserattributes.md) - [Update the users attributes](https://developer.pace.cloud/doc/user/2024-3/operation/operation-setuserattributes.md) ### [Auditlogs](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-auditlogs.md) - [Record audit log action](https://developer.pace.cloud/doc/user/2024-3/operation/operation-recordauditlog.md) ### [Callbacks](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-callbacks.md) - [Password reset](https://developer.pace.cloud/doc/user/2024-3/operation/operation-callbackpasswordreset.md) ### [Federated identities](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-federated-identities.md) - [Define federated identity](https://developer.pace.cloud/doc/user/2024-3/operation/operation-setfederatedidentity.md) - [Delete federated identity](https://developer.pace.cloud/doc/user/2024-3/operation/operation-deletefederatedidentity.md) - [Provide a token for a federated identity provider](https://developer.pace.cloud/doc/user/2024-3/operation/operation-grantfederatedtoken.md) ### [Gdpr](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-gdpr.md) - [Retrieves a GDPR takeout](https://developer.pace.cloud/doc/user/2024-3/operation/operation-getgdprtakeout.md) - [Lists GDPR takeouts](https://developer.pace.cloud/doc/user/2024-3/operation/operation-listgdprtakeouts.md) - [Requests a GDPR takeout](https://developer.pace.cloud/doc/user/2024-3/operation/operation-requestgdprtakeout.md) - [Retrieves a user's GDPR takeout](https://developer.pace.cloud/doc/user/2024-3/operation/operation-getusergdprtakeout.md) - [Lists user's GDPR takeouts](https://developer.pace.cloud/doc/user/2024-3/operation/operation-listusergdprtakeouts.md) - [Requests a GDPR takeout for a user](https://developer.pace.cloud/doc/user/2024-3/operation/operation-requestusergdprtakeout.md) ### [Maintenance](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-maintenance.md) - [Compares the scopes between our api-definitions and Keycloak](https://developer.pace.cloud/doc/user/2024-3/operation/operation-post-maintenance-check-scopes.md) ### [Preferences](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-preferences.md) - [Get the users app preferences](https://developer.pace.cloud/doc/user/2024-3/operation/operation-getapppreferences.md) - [Update the users app preferences](https://developer.pace.cloud/doc/user/2024-3/operation/operation-updateapppreferences.md) ### [Protocol](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-protocol.md) - [Exchange User Token](https://developer.pace.cloud/doc/user/2024-3/operation/operation-tokenexchange.md) ### [Sessions](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-sessions.md) - [Update session](https://developer.pace.cloud/doc/user/2024-3/operation/operation-updatesession.md) ### [Terms](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-terms.md) - [Checks acceptance of the terms of service for a user and a service.](https://developer.pace.cloud/doc/user/2024-3/operation/operation-checkterms.md) - [Returns the latest terms of service by serviceName](https://developer.pace.cloud/doc/user/2024-3/operation/operation-latestterms.md) - [Returns the latest terms of service by UUID](https://developer.pace.cloud/doc/user/2024-3/operation/operation-getterms.md) - [Accepts the terms presented under the UUID](https://developer.pace.cloud/doc/user/2024-3/operation/operation-acceptterms.md) - [Update the terms cache](https://developer.pace.cloud/doc/user/2024-3/operation/operation-updateterms.md) ### [User](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-user.md) - [Deletes the current account](https://developer.pace.cloud/doc/user/2024-3/operation/operation-deletecurrentuser.md) - [Check if user has a PIN](https://developer.pace.cloud/doc/user/2024-3/operation/operation-checkuserpin.md) - [Set the new PIN](https://developer.pace.cloud/doc/user/2024-3/operation/operation-updateuserpin.md) - [Check if user has a Password](https://developer.pace.cloud/doc/user/2024-3/operation/operation-checkuserpassword.md) - [Request to set a password](https://developer.pace.cloud/doc/user/2024-3/operation/operation-createuserpassword.md) - [Verify Email](https://developer.pace.cloud/doc/user/2024-3/operation/operation-verifyemail.md) - [Reset password for a user.](https://developer.pace.cloud/doc/user/2024-3/operation/operation-resetpassword.md) - [Check if user has a PIN or Password](https://developer.pace.cloud/doc/user/2024-3/operation/operation-checkuserpinorpassword.md) - [Check if user has a phone number set.](https://developer.pace.cloud/doc/user/2024-3/operation/operation-checkuserphone.md) - [Request a change of the users phone number](https://developer.pace.cloud/doc/user/2024-3/operation/operation-updateuserphone.md) - [Verifies the users phone number](https://developer.pace.cloud/doc/user/2024-3/operation/operation-verifyuserphone.md) - [Create device TOTP](https://developer.pace.cloud/doc/user/2024-3/operation/operation-createtotp.md) - [Verify OTP](https://developer.pace.cloud/doc/user/2024-3/operation/operation-verifyotp.md) - [Send OTP via Mail](https://developer.pace.cloud/doc/user/2024-3/operation/operation-sendmailotp.md) - [Create OTP](https://developer.pace.cloud/doc/user/2024-3/operation/operation-createotp.md) ### [Users](https://developer.pace.cloud/doc/user/2024-3/group/endpoint-users.md) - [Returns the user data for the given user](https://developer.pace.cloud/doc/user/2024-3/operation/operation-getuser.md) - [Set the user data of the given user.](https://developer.pace.cloud/doc/user/2024-3/operation/operation-setuser.md) - [Deletes a user identified by UUID](https://developer.pace.cloud/doc/user/2024-3/operation/operation-deleteuser.md) - [Updates the user data of the given user](https://developer.pace.cloud/doc/user/2024-3/operation/operation-updateuser.md) [Powered by Bump.sh](https://bump.sh)