Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejavascript
titleUser authentication create/update format
"auth": {
	"WPUserID": string, // Optional - in "update" commands this can be populated (equal to email address if no WPUserID originally specified) and the "user" object left blank
	"password": string, // The password, mandatory for "register" API calls (otherwise optional). Can either be in the clear or SHA-256/Base64 encoded
	"accountType": string, // Optional, defaults to "user". Admins can set this to be "admin" to create new administrators.
	"apiKey": string // Optional, if specified then the URL parameter "infinite_api_key" can be used instead of logging in
}

Note that in many places, these objects are referred to as "wpuser" or "WordPressUser" and "wpauth"/"WordPressAuth" because they were originally only used in integrated CMS (eg WordPress) scenarios. Their role was later expanded to being the sole way of managing users.

(Note also that in addition to posting the aggregate object, the individual objects can be encoded and sent as URL parameters in a GET request, as described in the API pages linked above.)