User

Returns data and authentication tokens for a user based on their username and password.

get
User Information

https://xyz.spaces.nexudus.com/en/user/me
Gets the details of the logged in user
Request
Response
Request
Headers
Authorization
required
string
Basic ZGVtb2FjY291b....cy5jb206RGVtbzEyMzQ=
Response
200: OK
Cake successfully retrieved.
{
"NewPasswordConfirm": null,
"OldPassword": null,
"DefaultBusinessId": 287964677,
"DefaultBusinessName": "Demo Space A",
"DefaultCurrencyId": 0,
"DefaultCurrencyName": null,
"DefaultCurrencyCode": null,
"DefaultCountryId": 0,
"DefaultCountryName": null,
"DefaultSimpleTimeZoneId": 0,
"DefaultSimpleTimeZoneName": null,
"DefaultSimpleTimeZoneNameIana": null,
"FullName": "John Doe (Original)",
"Email": "demoaccount@nexudus.com",
"AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImRlbW9hY2NvdW50QG5leHVkdXMuY29tIiwiaXNzIjoic2VsZiIsImF1ZCI6Imh0dHBzOi8vc3BhY2VzLm5leHVkdXMuY29tIiwiZXhwIjoxNTc1OTA2MTQxLCJuYmYiOjE1NzU5MDQzNDF9.42EcWcSC7C0Ym9Rvvo4B1JC0uj_sWtgbusfPrn1kQDs",
"PreferredLanguageId": 287965678,
"NewPassword": null,
"PassportNumber": null,
"PassportCardNumber": null,
"EnablePassportAccess": true,
"Active": true,
"IsAdmin": true,
"APIAccess": true,
"Validated": true,
"MustResetPassword": false,
"LastAccess": "2019-12-09T14:50:04Z",
"Devices": null,
"OnNewEmail": true,
"OnHelpDeskMsg": true,
"OnNewWallPost": true,
"OnNewMember": true,
"OnProfileChanges": true,
"OnNewBlogComment": false,
"OnNewEventComment": false,
"OnTariffChange": true,
"OnBookingChange": true,
"OnPurchases": true,
"OnVisitorRegistration": true,
"OnPlaformInvoices": true,
"ReceiveCommunityDigest": false,
"ReceiveEveryMessage": true,
"Businesses": [
287964677,
627703076,
627703077
],
"AddedBusinesses": null,
"RemovedBusinesses": null,
"UserRoles": [
770685918,
800349553,
961091136,
961274353
],
"AddedUserRoles": null,
"RemovedUserRoles": null,
"ChatRooms": [],
"AddedChatRooms": null,
"RemovedChatRooms": null,
"NewAvatarUrl": null,
"AvatarFileName": null,
"ClearAvatarFile": false,
"Id": 303914611,
"UpdatedOn": "2019-12-09T15:13:58Z",
"CreatedOn": "2017-02-24T23:45:48Z",
"UniqueId": "d3767b81-49c3-4167-bd0b-d185a079e9ff",
"UpdatedBy": "demoaccount@nexudus.com",
"IsNew": false,
"SystemId": null,
"ToStringText": "John Doe (Original) - demoaccount@nexudus.com",
"LocalizationDetails": null
}
401: Unauthorized
Invalid username and/or password

get
User Exists

https://xyz.spaces.nexudus.com/en/user/exists?email=:email
Checks if a user is already registered with this location
Request
Response
Request
Query Parameters
email
required
string
email@example.net
Response
200: OK
true

get
Login

https://xyz.spaces.nexudus.com/en/user/login?t=:accessToken
Logs are user into the members portal based on a one-time JWT access token
Request
Response
Request
Query Parameters
redirectUrl
optional
string
A relative redirect URL to send the user after logging in.
accessToken
required
string
A JWT access token for the user to be logged in. Use the "AccessToken" property of the User Information Endpoint. This token can only be used once.
Response
200: OK
true

post
Validate Credentials

https://spaces.nexudus.com/api/sys/users/validate
Logs are user into the members portal based on a one-time JWT access token. NOTE: This endpoint uses the REST API domain (spaces.nexudus.com)
Request
Response
Request
Body Parameters
Email
optional
string
Password
required
string
Response
200: OK
{
"Status": 200,
"Message": "OK",
"Value": {
"NewPasswordConfirm": null,
"OldPassword": null,
"DefaultBusinessId": 287964677,
"DefaultBusinessName": "Demo Space A",
"DefaultCurrencyId": 0,
"DefaultCurrencyName": null,
"DefaultCurrencyCode": null,
"DefaultCountryId": 0,
"DefaultCountryName": null,
"DefaultSimpleTimeZoneId": 0,
"DefaultSimpleTimeZoneName": null,
"DefaultSimpleTimeZoneNameIana": null,
"FullName": "John Doe (Original)",
"Email": "demoaccount@nexudus.com",
"AccessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImRlbW9hY2NvdW50QG5leHVkdXMuY29tIiwiaXNzIjoic2VsZiIsImF1ZCI6Imh0dHBzOi8vc3BhY2VzLm5leHVkdXMuY29tIiwiZXhwIjoxNTc1OTA2MTQxLCJuYmYiOjE1NzU5MDQzNDF9.42EcWcSC7C0Ym9Rvvo4B1JC0uj_sWtgbusfPrn1kQDs",
"PreferredLanguageId": 287965678,
"NewPassword": null,
"PassportNumber": null,
"PassportCardNumber": null,
"EnablePassportAccess": true,
"Active": true,
"IsAdmin": true,
"APIAccess": true,
"Validated": true,
"MustResetPassword": false,
"LastAccess": "2019-12-09T14:50:04Z",
"Devices": null,
"OnNewEmail": true,
"OnHelpDeskMsg": true,
"OnNewWallPost": true,
"OnNewMember": true,
"OnProfileChanges": true,
"OnNewBlogComment": false,
"OnNewEventComment": false,
"OnTariffChange": true,
"OnBookingChange": true,
"OnPurchases": true,
"OnVisitorRegistration": true,
"OnPlaformInvoices": true,
"ReceiveCommunityDigest": false,
"ReceiveEveryMessage": true,
"Businesses": [
287964677,
627703076,
627703077
],
"AddedBusinesses": null,
"RemovedBusinesses": null,
"UserRoles": [
770685918,
800349553,
961091136,
961274353
],
"AddedUserRoles": null,
"RemovedUserRoles": null,
"ChatRooms": [],
"AddedChatRooms": null,
"RemovedChatRooms": null,
"NewAvatarUrl": null,
"AvatarFileName": null,
"ClearAvatarFile": false,
"Id": 303914611,
"UpdatedOn": "2019-12-09T15:25:28Z",
"CreatedOn": "2017-02-24T23:45:48Z",
"UniqueId": "d3767b81-49c3-4167-bd0b-d185a079e9ff",
"UpdatedBy": "demoaccount@nexudus.com",
"IsNew": false,
"SystemId": null,
"ToStringText": "John Doe (Original) - demoaccount@nexudus.com",
"LocalizationDetails": null
},
"OpenInDialog": false,
"OpenInWindow": false,
"RedirectURL": null,
"JavaScript": null,
"UpdatedOn": null,
"UpdatedBy": null,
"Errors": null,
"WasSuccessful": true
}
500: Internal Server Error
{
"Status": 500,
"Message": "The email address or password you entered is not valid.",
"Value": null,
"OpenInDialog": false,
"OpenInWindow": false,
"RedirectURL": null,
"JavaScript": null,
"UpdatedOn": null,
"UpdatedBy": null,
"Errors": null,
"WasSuccessful": false
}

get
Refresh Access Token

https://spaces.nexudus.com/api/sys/users/:userId/token/refresh
Generates a new access token for for a user. This endpoint requires a full unrestricted admin credential or a user that has the User-Edit role. NOTE: This endpoint requires the user-edit role. NOTE: This endpoint uses the REST API domain (spaces.nexudus.com)
Request
Response
Request
Path Parameters
userId
required
string
The Id of the user to refresh the token for
Headers
Authorization
required
string
Basic ZGVtb2FjY291...5jb206RGVtbzEyMzQ=
Response
200: OK
{
"Status": 200,
"Message": "OK",
"Value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJlbWFpbCI6ImRlbW9hY2NvdW50QG5leHVkdXMuY29tIiwiaXNzIjoic2VsZiIsImF1ZCI6Imh0dHBzOi8vc3BhY2VzLm5leHVkdXMuY29tIiwiZXhwIjoxNTc1OTA3MjY2LCJuYmYiOjE1NzU5MDU0NjZ9._qXna9_rtYd9xYnNz8JxTG_sLgmPVhAgWzXeWY43l1Q",
"OpenInDialog": false,
"OpenInWindow": false,
"RedirectURL": null,
"JavaScript": null,
"UpdatedOn": null,
"UpdatedBy": null,
"Errors": null,
"WasSuccessful": true
}

Requires user role user-edit