Users > Users
Commerce APIUsersUsers

Users

The User entity serves as the primary entry point to the system. Authorized access is required for most queries and mutations, and users are the entities that grant such access. To register a new user, you can use the usersCreate mutation.

For more information on authentication and how it functions, see the Authentication documentation.

Endpoints

EndpointDescriptionJSON API
organizationsUsersGet organization usersGET:organizations/users.json
organizationsUsersModify organization usersPOST:organizations/users.json
organizationsUsersDeleteDelete organization usersDELETE:organizations/users.json
usersGet usersGET:users.json
usersChangeEmailChange primary emailPOST:users/change_email.json
usersConfirmEmailRe-send email confirmation messagePOST:users/confirm_email.json
usersCreateCreate usersPOST:users.json
usersInitWebauthnInitialize webauthn registeration or sign inPOST:users/init_webauthn.json
usersModifyModify usersPOST:users.json
usersOauthEnable OAuth2 login for selfPOST:users/oauth.json
usersOauthDeleteDisable OAuth2 login for selfDELETE:users/oauth.json
usersTwoFactorEnable 2FA for selfPOST:users/two_factor.json
usersTwoFactorDeleteDisable 2FA for selfDELETE:users/two_factor.json
usersTwoFactorRecoveryCodesRegenerate recovery codesPOST:users/two_factor/recovery_codes.json
usersTwoFactorRecoveryCodesShowShow recovery codesGET:users/two_factor/recovery_codes/show.json
usersTwoFactorValidateValidate 2FA for selfPOST:users/two_factor/validate.json
usersWebauthnAdd webauthn credential to existing userPOST:users/webauthn.json
usersWebauthnDeleteRemove webauthn credential from existing userDELETE:users/webauthn.json

Types

Types
OAuth2Provider
OrganizationUser
OrganizationUserModify
RecoveryOTP
TwoFactor
User
UserCreate
UserModify
WebauthnAdd
WebauthnResponse