Users

The Users API provides operations for user profiles, onboarding, workspace ownership transfer, login history, presence, multi-factor authentication, and enterprise authentication settings.

Member lifecycle operations such as role changes, member removal, and member blocking are documented under [REST API → API Reference → Teams & Members]

Endpoints

MethodPathPurpose
POST/auth/save-userSynchronize user profile
GET/auth/user/:auth0IdGet user profile
GET/auth/user-channels/:identifierReturns the channels associated with the identified user.
PUT/auth/user/:auth0IdUpdate user profile
POST/auth/user/:auth0Id/profile-pictureUpload profile picture
PUT/auth/user/:auth0Id/WorkspaceUpdates workspace business information associated with the authenticated user.
PATCH/auth/onboardComplete owner onboarding
PATCH/auth/onboarding-stepSave onboarding progress
POST/auth/workspace/transfer-ownershipStart ownership transfer
GET/auth/workspace/transfer-ownership/detailsGet transfer details
POST/auth/workspace/transfer-ownership/acceptAccept transfer
POST/auth/workspace/transfer-ownership/declineDecline transfer
GET/auth/user/:userId/login-historyGet member login historyFeature Gate: audit_logMinimum plan: GROWTH
GET/auth/login-historyGet Workspace audit historyFeature Gate: audit_logMinimum plan: GROWTH
GET/auth/login-history/usersList users with audit recordsFeature Gate: audit_logMinimum plan: GROWTH
GET/auth/login-history/exportExport audit historyFeature Gate: audit_logMinimum plan: GROWTH
POST/auth/logoutTerminate user session
GET/user-statusGet Team Member presence
POST/auth/mfa/enableEnable MFA
POST/auth/mfa/disableDisable MFA
POST/auth/mfa/dismissDismiss MFA setup notice
GET/auth/mfa/statusGet MFA status
POST/auth/sso/configConfigure SAML SSOFeature Gate: ssoMinimum plan: ENTERPRISE

The audit identifies these endpoints across user, history, MFA, role, and SSO controllers.

Need Help?

Email: support@ysdesk.com

Documentation: ttps://docs.ysplugins.com/ys-desk

Next

Conversations
Messages
Contacts