UserAPI

object UserAPI

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 #operation/GetTerms and can then be followed by the #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 #operation/CheckTerms API before the application, together with a redirectUri to the next step of the application process.

Types

AuditLogAPI
Link copied to clipboard
class AuditLogAPI
CallbacksAPI
Link copied to clipboard
class CallbacksAPI
CredentialsAPI
Link copied to clipboard
class CredentialsAPI
FederatedIdentityAPI
Link copied to clipboard
class FederatedIdentityAPI
OAuth2API
Link copied to clipboard
class OAuth2API
PhoneAPI
Link copied to clipboard
class PhoneAPI
PreferencesAPI
Link copied to clipboard
class PreferencesAPI
SessionsAPI
Link copied to clipboard
class SessionsAPI
TermsAPI
Link copied to clipboard
class TermsAPI
TOTPAPI
Link copied to clipboard
class TOTPAPI
UserAPI
Link copied to clipboard
class UserAPI

Properties

auditLog
Link copied to clipboard
val API.auditLog: UserAPI.AuditLogAPI
callbacks
Link copied to clipboard
val API.callbacks: UserAPI.CallbacksAPI
credentials
Link copied to clipboard
val API.credentials: UserAPI.CredentialsAPI
federatedIdentity
Link copied to clipboard
val API.federatedIdentity: UserAPI.FederatedIdentityAPI
oAuth2
Link copied to clipboard
val API.oAuth2: UserAPI.OAuth2API
phone
Link copied to clipboard
val API.phone: UserAPI.PhoneAPI
preferences
Link copied to clipboard
val API.preferences: UserAPI.PreferencesAPI
sessions
Link copied to clipboard
val API.sessions: UserAPI.SessionsAPI
terms
Link copied to clipboard
val API.terms: UserAPI.TermsAPI
totp
Link copied to clipboard
val API.totp: UserAPI.TOTPAPI
user
Link copied to clipboard
val API.user: UserAPI.UserAPI
VERSION
Link copied to clipboard
const val VERSION: String