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)

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

UserIdstring
emailrequired
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.

Timestampstring

`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.

UserIdstring

Response GetUserDetailsOutput

Fields (JSON object)

userId(from user_id)required
ID of the user.

UserIdstring
emailrequired
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)

emailrequired
Email of the user.

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

string
passwordoptional
Password of the user.

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

boolean

Response CreateUserOutput

Casesinternally — 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.
  
  UserIdstring
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.

UserIdstring

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.

UserIdstring
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.

UserIdstring
passwordrequired
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.

UserIdstring
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)

emailrequired
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
passwordrequired
New password of the user.

string

Response CompleteUserPasswordResetOutput

Casesinternally — 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.

UserIdstring

Response QueryUserTokensOutput

Fields (JSON object)

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

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

Timestampstring
nameoptional
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.

UserIdstring

Response QueryUserOrganizationsOutput

Fields (JSON object)

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

OrganizationIdstring
namerequired
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.

UserIdstring

Response QueryUserOrganizationInvitationsOutput

Fields (JSON object)

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

OrganizationInvitationIdstring
organizationrequired
Information about the organization.

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

OrganizationIdstring
namerequired
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.

UserIdstring

Response QueryUserSessionsOutput

Fields (JSON object)

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

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

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

Timestampstring
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.

UserIdstring
deviceId(from device_id)required
ID of the device.

DeviceIdstring

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.

UserIdstring
nameoptional
Name of the token.

string

Response CreateUserTokenOutput

Fields (JSON object)

tokenId(from token_id)required
ID of the token.

UserTokenIdstring
tokenrequired
Token.

UserTokenstring

`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.

UserTokenIdstring

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.

UserSessionIdstring

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
emailrequired
Email address of the user.

string
passwordrequired
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

Casesinternally — tag field result

Created
User registration has been created.

{ "result": "Created", ...<payload fields> } — or "content" for non-object payloads
UserRegistration
Fields (JSON object)
- statusrequired
  Registration status.
  
  UserRegistrationStatus
  Casesinternally — 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" }
- messageoptional
  Optional message to show to the user.
  
  string
- createdAt(from created_at)required
  Timestamp when the registration was created.
  
  Timestampstring
Pending
User registration is already pending.

{ "result": "Pending", ...<payload fields> } — or "content" for non-object payloads
UserRegistration
Fields (JSON object)
- statusrequired
  Registration status.
  
  UserRegistrationStatus
  Casesinternally — 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" }
- messageoptional
  Optional message to show to the user.
  
  string
- createdAt(from created_at)required
  Timestamp when the registration was created.
  
  Timestampstring
EmailAlreadyExists
User with the same email already exists.

{ "result": "EmailAlreadyExists" }

`users_ResendRegistrationEmail`

POST/api/v1/actions/invoke/users_ResendRegistrationEmail

Request ResendRegistrationEmailAction

Fields (JSON object)

emailrequired
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

Casesinternally — 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.

OrganizationInvitationIdstring

Response Empty

No fields.