User Endpoint
Last updated
Last updated
The User Endpoint handles all User-related Functionalities within a valid Frontend Session. It does not handle User Interaction, you can find those Endpoints here:
POST https://api.nexx.cloud/v3.1/user/register
This Endpoint registers a User. All User entered Details must be valid POST Attributes (like username, firstname etc).
| Name | Type | Description |
|---|---|---|
POST https://api.nexx.cloud/v3.1/user/registeranonymous
This Endpoint registers an anonymous User. All User-related Details may be sent via POST (all Attributes are valid except Username).
POST https://api.nexx.cloud/v3.1/user/verifyaccountdetailsunique/:item
This Endpoint validates a Username and/or Email Address for Uniqueness.
POST https://api.nexx.cloud/v3.1/user/verifytokenunique/:token
This Endpoint validates a 3rd Party Connector Token for Uniqueness.
POST https://api.nexx.cloud/v3.1/user/authorize/:token
This Endpoint represents the final Step in a Registration Process (if AutoAuthorize is disabled).
POST https://api.nexx.cloud/v3.1/user/authorizedevice
will verify a new Device for a User with 2FA Login.
POST https://api.nexx.cloud/v3.1/user/authorizelogin
will verify a Login for a User with U2F Device
POST https://api.nexx.cloud/v3.1/user/prepareavsupdate
POST https://api.nexx.cloud/v3.1/user/finishavsupdate
POST https://api.nexx.cloud/v3.1/user/registerdeviceforpush
marks the Device as willing to receive Push Messages
POST https://api.nexx.cloud/v3.1/user/prepareregisteru2fdevice
will create the Challenge for a new U2F Request
POST https://api.nexx.cloud/v3.1/user/finishregisteru2fdevice
POST https://api.nexx.cloud/v3.1/user/prepareregisterauthenticator
will create the Challenge for a new U2F Request
POST https://api.nexx.cloud/v3.1/user/finishregisterauthenticator
POST https://api.nexx.cloud/v3.1/user/requesttakeout
POST https://api.nexx.cloud/v3.1/user/resetpassword/:token
will reset the User Password to a self-given new Value. This is only valid for a predefined Password Reset Link, which Token must be given too.
POST https://api.nexx.cloud/v3.1/user/resendwelcomemail
will resent the User Welcome Email (needs the Eternal Session and a Backend Process).
POST https://api.nexx.cloud/v3.1/user/verifywelcome
will verify, that the given Password matches the stored User Password
GET https://api.nexx.cloud/v3.1/user/profile
GET https://api.nexx.cloud/v3.1/user/requestpass
will try to find a registered and authorized User and sends an Email with new Login Details to that Account.
GET https://api.nexx.cloud/v3.1/user/requestkeycode
will invalidate all open 2FA Codes and generates a new Code for the given Device.
PUT https://api.nexx.cloud/v3.1/user/changepassword
PUT https://api.nexx.cloud/v3.1/user/updatestatus
PUT https://api.nexx.cloud/v3.1/user/updatechannelsubscriptions
updates a User Notification Preferences for new Media in a given Channel.
PUT https://api.nexx.cloud/v3.1/user/updatedata
will update all User Details (except Password, Username and Status). All given User Details must be sent via PUT Parameters as in the /register Endpoint.
DELETE https://api.nexx.cloud/v3.1/user/unsubscribe
unsubscribe from all Newsletters
DELETE https://api.nexx.cloud/v3.1/user/unregister
will remove the User completey. This Operation cannot be undone, so use with extreme Care.
Media Item List Endpoints return Lists of Media Items, that the User interacted in any Way.
GET https://api.nexx.cloud/v3.1/user/history
GET https://api.nexx.cloud/v3.1/user/historyformerge
This special Endpoint is designed for History Synchronization on Login. It only returnes the Media IDs and will always return ALL of them - Paging is not supported in this Case.
GET https://api.nexx.cloud/v3.1/user/searchhistory
GET https://api.nexx.cloud/v3.1/user/purchaseditems
GET https://api.nexx.cloud/v3.1/user/favourites
GET https://api.nexx.cloud/v3.1/user/watchlist
GET https://api.nexx.cloud/v3.1/user/cart
GET https://api.nexx.cloud/v3.1/user/itemsininterest
GET https://api.nexx.cloud/v3.1/user/likes
GET https://api.nexx.cloud/v3.1/user/ratings
GET https://api.nexx.cloud/v3.1/user/comments
GET https://api.nexx.cloud/v3.1/user/clips
GET https://api.nexx.cloud/v3.1/user/uploads
GET https://api.nexx.cloud/v3.1/user/teams
GET https://api.nexx.cloud/v3.1/user/events
POST https://api.nexx.cloud/v3.1/user/prepareupload
This Endpoint will return Upload URLs, Tokens and Filenames for all file based UGC Uploads.
POST https://api.nexx.cloud/v3.1/user/finishupload
This Endpoint will return Upload URLs, Tokens and Filenames for all file based UGC Uploads.
POST https://api.nexx.cloud/v3.1/user/addarticle
This Endpoint will create a UGC Media Item of Streamtype "article".
POST https://api.nexx.cloud/v3.1/user/addplaylist
Thsi Endpoint will create a UGC Media Item of Streamtype "playlist".
POST https://api.nexx.cloud/v3.1/user/addcollection
This Endpoint will create a UGC Media Item of Streamtype "collection"
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|