Users API

Actions in the users namespace of the Nexigon Hub API.

`users_Query`

POST /api/v1/actions/invoke/users_Query

Query the users of the instance.

Request QueryUsersAction

No fields.

Response QueryUsersOutput

Fields (JSON object)

users required
List of users.
array<QueryUsersItem>
Items
QueryUsersItem
Fields (JSON object)
userId (from user_id) required
ID of the user.

UserId string

email required
Email of the user.

string

displayName (from display_name) optional
Name of the user.

string

isAdmin (from is_admin) required
Whether the user is an instance admin.

boolean

isActive (from is_active) required
Whether the user account has been activated.

New registrations start out inactive and are activated when the user confirms their email address.

boolean

createdAt (from created_at) required
Timestamp when the user was created.

Timestamp string

`users_GetDetails`

POST /api/v1/actions/invoke/users_GetDetails

Get information about a user.

Request GetUserDetailsAction

Fields (JSON object)

userId (from user_id) required
ID of the user.

UserId string

Response GetUserDetailsOutput

Fields (JSON object)

userId (from user_id) required
ID of the user.

UserId string
email required
Email of the user.

string
displayName (from display_name) optional
Name of the user.

string
isAdmin (from is_admin) required
Whether the user is an instance admin.

boolean

`users_Create`

POST /api/v1/actions/invoke/users_Create

Create a new user.

Request CreateUserAction

Fields (JSON object)

email required
Email of the user.

string
displayName (from display_name) optional
Name of the user.

string
password optional
Password of the user.

string
isAdmin (from is_admin) optional
Whether the user is an instance admin.

boolean

Response CreateUserOutput

Cases internally — tag field result

Created
User was created successfully.

{ "result": "Created", ...<payload fields> } — or "content" for non-object payloads
CreateUserSuccess
Fields (JSON object)
- userId (from user_id) required
  ID of the user.
  
  UserId string
EmailAlreadyExists
User with the same email already exists.

{ "result": "EmailAlreadyExists" }

`users_Delete`

POST /api/v1/actions/invoke/users_Delete

Delete a user.

Request DeleteUserAction

Fields (JSON object)

userId (from user_id) required
ID of the user to delete.

UserId string

Response Empty

No fields.

`users_SetDisplayName`

POST /api/v1/actions/invoke/users_SetDisplayName

Set the display name of a user.

Request SetUserDisplayNameAction

Fields (JSON object)

userId (from user_id) required
ID of the user to update.

UserId string
displayName (from display_name) required
New name of the user.

string

Response Empty

No fields.

`users_SetPassword`

POST /api/v1/actions/invoke/users_SetPassword

Set the password of a user.

Request SetUserPasswordAction

Fields (JSON object)

userId (from user_id) required
ID of the user.

UserId string
password required
New password of the user.

string

Response Empty

No fields.

`users_SetIsAdmin`

POST /api/v1/actions/invoke/users_SetIsAdmin

Set whether the user is an instance administrator.

Request SetUserIsAdminAction

Fields (JSON object)

userId (from user_id) required
ID of the user.

UserId string
isAdmin (from is_admin) required
Whether the user is an instance administrator.

boolean

Response Empty

No fields.

`users_ResetPassword`

POST /api/v1/actions/invoke/users_ResetPassword

Reset the password of a user.

This will send an email to the user with a link to reset their password.

Request ResetUserPasswordAction

Fields (JSON object)

email required
Email of the user.

string

Response Empty

No fields.

`users_CompletePasswordReset`

POST /api/v1/actions/invoke/users_CompletePasswordReset

Complete the password reset of a user.

Request CompleteUserPasswordResetAction

Fields (JSON object)

resetToken (from reset_token) required
Token to use for password reset.

Jwt

Wraps

string
password required
New password of the user.

string

Response CompleteUserPasswordResetOutput

Cases internally — tag field result

Completed
Password has been reset.

{ "result": "Completed" }
InvalidToken
Password reset failed due to the token being invalid.

{ "result": "InvalidToken" }

`users_QueryTokens`

POST /api/v1/actions/invoke/users_QueryTokens

Query the tokens of a user.

Request QueryUserTokensAction

Fields (JSON object)

userId (from user_id) required
ID of the user.

UserId string

Response QueryUserTokensOutput

Fields (JSON object)

tokens required
List of user tokens.
array<QueryUserTokensItem>
Items
QueryUserTokensItem
Fields (JSON object)
tokenId (from token_id) required
ID of the token.

UserTokenId string

createdAt (from created_at) required
Creation date of the token.

Timestamp string

name optional
Name of the token.

string

`users_QueryOrganizations`

POST /api/v1/actions/invoke/users_QueryOrganizations

Query the organizations of a user.

Request QueryUserOrganizationsAction

Fields (JSON object)

userId (from user_id) required
ID of the user.

UserId string

Response QueryUserOrganizationsOutput

Fields (JSON object)

organizations required
List of organizations.
array<QueryUserOrganizationsItem>
Items
QueryUserOrganizationsItem
Fields (JSON object)
organizationId (from organization_id) required
ID of the organization.

OrganizationId string

name required
Name of the organization.

string

requiresSubscription (from requires_subscription) required
Whether the organization requires a paid subscription.

boolean

subscriptionPlanName (from subscription_plan_name) optional
Name of the active subscription plan, if any.

string

`users_QueryOrganizationInvitations`

POST /api/v1/actions/invoke/users_QueryOrganizationInvitations

Query the organization invitations of a user.

Request QueryUserOrganizationInvitationsAction

Fields (JSON object)

userId (from user_id) required
ID of the user.

UserId string

Response QueryUserOrganizationInvitationsOutput

Fields (JSON object)

invitations required
List of organization invitations.
array<QueryUserOrganizationInvitationsItem>
Items
QueryUserOrganizationInvitationsItem
Fields (JSON object)
invitationId (from invitation_id) required
ID of the invitation.

OrganizationInvitationId string

organization required
Information about the organization.

QueryUserOrganizationInvitationsItemOrganization

Fields (JSON object)
organizationId (from organization_id) required
ID of the organization.

OrganizationId string

name required
Name of the organization.

string

`users_QuerySessions`

POST /api/v1/actions/invoke/users_QuerySessions

Query the sessions of a user.

Request QueryUserSessionsAction

Fields (JSON object)

userId (from user_id) required
ID of the user.

UserId string

Response QueryUserSessionsOutput

Fields (JSON object)

sessions required
List of user sessions.
array<UserSession>
Items
UserSession
Fields (JSON object)
sessionId (from session_id) required
ID of the session.

UserSessionId string

createdAt (from created_at) required
Creation date of the session.

Timestamp string

expiresAt (from expires_at) required
Expiration date of the session.

Timestamp string

userAgent (from user_agent) required
User agent of the session.

string

`users_GetDevicePermissions`

POST /api/v1/actions/invoke/users_GetDevicePermissions

Check the permissions of a user for a given device.

Request GetDevicePermissionsAction

Fields (JSON object)

userId (from user_id) required
ID of the user.

UserId string
deviceId (from device_id) required
ID of the device.

DeviceId string

Response GetDevicePermissionsOutput

Fields (JSON object)

hasAccess (from has_access) required
Whether the user has access to the device.

boolean

`users_CreateToken`

POST /api/v1/actions/invoke/users_CreateToken

Create a user token.

Request CreateUserTokenAction

Fields (JSON object)

userId (from user_id) required
ID of the user.

UserId string
name optional
Name of the token.

string

Response CreateUserTokenOutput

Fields (JSON object)

tokenId (from token_id) required
ID of the token.

UserTokenId string
token required
Token.

UserToken string

`users_DeleteToken`

POST /api/v1/actions/invoke/users_DeleteToken

Delete a user token.

Request DeleteUserTokenAction

Fields (JSON object)

tokenId (from token_id) required
ID of the token.

UserTokenId string

Response Empty

No fields.

`users_TerminateSession`

POST /api/v1/actions/invoke/users_TerminateSession

Terminate a user session.

The acting user must own the session; sessions belonging to other users are not affected.

Request TerminateUserSessionAction

Fields (JSON object)

sessionId (from session_id) required
ID of the session.

UserSessionId string

Response Empty

No fields.

`users_CleanupExpiredSessions`

POST /api/v1/actions/invoke/users_CleanupExpiredSessions

Cleanup expired user sessions.

Request CleanupExpiredUserSessionsAction

No fields.

Response Empty

No fields.

`users_Register`

POST /api/v1/actions/invoke/users_Register

Request RegisterUserAction

Fields (JSON object)

displayName (from display_name) optional
Name of the user.

string
email required
Email address of the user.

string
password required
Password of the user.

string
consentedToTerms (from consented_to_terms) required
Indicates whether the user has consented to the terms and conditions.

This must be true to register a user.

boolean
consentedToMarketing (from consented_to_marketing) optional
Indicates whether the user has consented to marketing communications.

boolean

Response RegisterUserOutput

Cases internally — tag field result

Created
User registration has been created.

{ "result": "Created", ...<payload fields> } — or "content" for non-object payloads
UserRegistration
Fields (JSON object)
- status required
  Registration status.
  
  UserRegistrationStatus
  
  Cases internally — tag field tag
  Pending
  Registration is pending.
  
  { "tag": "Pending" }
  Waiting
  / Registration is waiting for approval.
  
  { "tag": "Waiting" }
  Completed
  Registration was successful.
  
  { "tag": "Completed" }
  Failed
  Registration failed.
  
  { "tag": "Failed" }
- message optional
  Optional message to show to the user.
  
  string
- createdAt (from created_at) required
  Timestamp when the registration was created.
  
  Timestamp string
Pending
User registration is already pending.

{ "result": "Pending", ...<payload fields> } — or "content" for non-object payloads
UserRegistration
Fields (JSON object)
- status required
  Registration status.
  
  UserRegistrationStatus
  
  Cases internally — tag field tag
  Pending
  Registration is pending.
  
  { "tag": "Pending" }
  Waiting
  / Registration is waiting for approval.
  
  { "tag": "Waiting" }
  Completed
  Registration was successful.
  
  { "tag": "Completed" }
  Failed
  Registration failed.
  
  { "tag": "Failed" }
- message optional
  Optional message to show to the user.
  
  string
- createdAt (from created_at) required
  Timestamp when the registration was created.
  
  Timestamp string
EmailAlreadyExists
User with the same email already exists.

{ "result": "EmailAlreadyExists" }

`users_ResendRegistrationEmail`

POST /api/v1/actions/invoke/users_ResendRegistrationEmail

Request ResendRegistrationEmailAction

Fields (JSON object)

email required
Email address of the user.

string

Response Empty

No fields.

`users_CompleteRegistration`

POST /api/v1/actions/invoke/users_CompleteRegistration

Complete the registration of a user.

Request CompleteRegistrationAction

Fields (JSON object)

activationToken (from activation_token) required
Token to use for account activation.

Jwt

Wraps

string

Response CompleteRegistrationOutput

Cases internally — tag field result

Completed
Registration was successful.

{ "result": "Completed" }
Failed
Registration failed.

{ "result": "Failed" }

`users_AcceptOrganizationInvitation`

POST /api/v1/actions/invoke/users_AcceptOrganizationInvitation

Accept a organization invitation.

Request AcceptOrganizationInvitationAction

Fields (JSON object)

invitationId (from invitation_id) required
ID of the invitation.

OrganizationInvitationId string

Response Empty

No fields.