Organizations API

Actions in the organizations namespace of the Nexigon Hub API.

`organizations_Query`

POST /api/v1/actions/invoke/organizations_Query

Query the organizations of the instance.

Request QueryOrganizationsAction

No fields.

Response QueryOrganizationsOutput

Fields (JSON object)

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

OrganizationId string

name required
Name of the organization.

string

`organizations_QueryMembers`

POST /api/v1/actions/invoke/organizations_QueryMembers

Query the members of an organization.

Request QueryOrganizationMembersAction

Fields (JSON object)

organizationId (from organization_id) required
ID of the organization.

OrganizationId string

Response QueryOrganizationMembersOutput

Fields (JSON object)

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

UserId string

displayName (from display_name) optional
Name of the user.

string

email required
Email of the user.

string

isAdmin (from is_admin) required
Whether the user is an administrator of the organization.

boolean

`organizations_QueryProjects`

POST /api/v1/actions/invoke/organizations_QueryProjects

Query the projects of an organization.

Request QueryOrganizationProjectsAction

Fields (JSON object)

organizationId (from organization_id) required
ID of the organization.

OrganizationId string

Response QueryOrganizationProjectsOutput

Fields (JSON object)

projects required
List of projects.
array<QueryOrganizationProjectsItem>
Items
QueryOrganizationProjectsItem
Fields (JSON object)
projectId (from project_id) required
ID of the project.

ProjectId string

name required
Name of the project.

string

`organizations_QueryRepositories`

POST /api/v1/actions/invoke/organizations_QueryRepositories

Query the repositories of an organization.

Request QueryOrganizationRepositoriesAction

Fields (JSON object)

organizationId (from organization_id) required
ID of the organization.

OrganizationId string

Response QueryOrganizationRepositoriesOutput

Fields (JSON object)

repositories required
List of repositories.
array<QueryOrganizationRepositoriesItem>
Items
QueryOrganizationRepositoriesItem
Fields (JSON object)
repositoryId (from repository_id) required
ID of the repository.

RepositoryId string

publicName (from public_name) required
Public name of the repository.

string

displayName (from display_name) optional
Display name of the repository (if any).

string

`organizations_QueryInvitations`

POST /api/v1/actions/invoke/organizations_QueryInvitations

Query the invitations of an organization.

Request QueryOrganizationInvitationsAction

Fields (JSON object)

organizationId (from organization_id) required
ID of the organization.

OrganizationId string

Response QueryOrganizationInvitationsOutput

Fields (JSON object)

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

OrganizationInvitationId string

email required
Email address of the invited user.

string

invitingUserId (from inviting_user_id) optional
ID of the inviting user.

UserId string

`organizations_Create`

POST /api/v1/actions/invoke/organizations_Create

Create an organization.

Request CreateOrganizationAction

Fields (JSON object)

name required
Name of the organization.

string
admins optional
Admins of the organization.

array<UserId>

Items

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

boolean

Response CreateOrganizationOutput

Fields (JSON object)

organizationId (from organization_id) required
ID of the organization.

OrganizationId string

`organizations_Delete`

POST /api/v1/actions/invoke/organizations_Delete

Delete an organization.

Request DeleteOrganizationAction

Fields (JSON object)

organizationId (from organization_id) required
ID of the organization.

OrganizationId string

Response Empty

No fields.

`organizations_AddMember`

POST /api/v1/actions/invoke/organizations_AddMember

Add a user to an organization.

Request AddOrganizationMemberAction

Fields (JSON object)

organizationId (from organization_id) required
ID of the organization.

OrganizationId string
userId (from user_id) required
ID of the user to add.

UserId string
isAdmin (from is_admin) optional
Whether the user should be an administrator of the organization.

boolean

Response Empty

No fields.

`organizations_RemoveMember`

POST /api/v1/actions/invoke/organizations_RemoveMember

Remove a user from an organization.

Request RemoveOrganizationMemberAction

Fields (JSON object)

organizationId (from organization_id) required
ID of the organization.

OrganizationId string
userId (from user_id) required
ID of the user.

UserId string

Response Empty

No fields.

`organizations_SetMemberIsAdmin`

POST /api/v1/actions/invoke/organizations_SetMemberIsAdmin

Set whether the user is an administrator of the organization.

Request SetOrganizationMemberIsAdminAction

Fields (JSON object)

organizationId (from organization_id) required
ID of the organization.

OrganizationId string
userId (from user_id) required
ID of the user.

UserId string
isAdmin (from is_admin) required
Whether the user should be an administrator of the organization.

boolean

Response Empty

No fields.

`organizations_InviteMember`

POST /api/v1/actions/invoke/organizations_InviteMember

Invite a user to an organization.

Request InviteOrganizationMemberAction

Fields (JSON object)

organizationId (from organization_id) required
ID of the organization.

OrganizationId string
email required
Email address of the user to invite.

string

Response InviteOrganizationMemberOutput

Fields (JSON object)

invitationId (from invitation_id) required
ID of the invitation.

OrganizationInvitationId string

`organizations_DeleteInvitation`

POST /api/v1/actions/invoke/organizations_DeleteInvitation

Delete an invitation to an organization.

Request DeleteOrganizationInvitationAction

Fields (JSON object)

invitationId (from invitation_id) required
ID of the invitation.

OrganizationInvitationId string

Response Empty

No fields.

`organizations_QueryAuditLog`

POST /api/v1/actions/invoke/organizations_QueryAuditLog

Query the audit log of an organization.

Request QueryOrganizationAuditLogAction

Fields (JSON object)

organizationId (from organization_id) required
ID of the organization.

OrganizationId string

Response QueryOrganizationAuditLogOutput

Fields (JSON object)

events required
List of audit log events.
array<AuditLogEvent>
Items
AuditLogEvent
Fields (JSON object)
eventId (from event_id) required
ID of the audit log event.

AuditLogEventId string

actor required
Actor causing the event.

Actor

Cases internally — tag field actor
Anonymous
An anonymous, unauthenticated actor.

{ "actor": "Anonymous", ...<payload fields> } — or "content" for non-object payloads

AnonymousActor

No fields.

System
The system itself, typically used for internal actions.

{ "actor": "System", ...<payload fields> } — or "content" for non-object payloads

SystemActor

No fields.

Device
A device authenticated via a specific deployment token.

{ "actor": "Device", ...<payload fields> } — or "content" for non-object payloads

DeviceActor

Fields (JSON object)
deviceId (from device_id) required
ID of the device.

DeviceId string

tokenId (from token_id) required
ID of the deployment token used for authentication.

DeploymentTokenId string

User
A user typically authenticated via a user session.

{ "actor": "User", ...<payload fields> } — or "content" for non-object payloads

UserActor

Fields (JSON object)
userId (from user_id) required
ID of the user.

UserId string

UserToken
A user authenticated via a specific token.

{ "actor": "UserToken", ...<payload fields> } — or "content" for non-object payloads

UserTokenActor

Fields (JSON object)
userId (from user_id) required
ID of the user.

UserId string

tokenId (from token_id) required
ID of the user token used for authentication.

UserTokenId string

ClusterNode
A cluster node.

{ "actor": "ClusterNode", ...<payload fields> } — or "content" for non-object payloads

ClusterNodeActor

Fields (JSON object)
nodeId (from node_id) required
ID of the cluster node.

ClusterNodeId string

OrganizationApiToken
An organization API token.

{ "actor": "OrganizationApiToken", ...<payload fields> } — or "content" for non-object payloads

OrganizationApiTokenActor

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

OrganizationId string

tokenId (from token_id) required
ID of the API token.

OrganizationApiTokenId string

event required
Type of the event that was recorded.

string

data required
Additional audit data associated with the event.

JsonValue any

createdAt (from created_at) required
Timestamp indicating when the audit log event was recorded.

Timestamp string

action optional
Action the event has been caused by (if any).

AuditLogEventAction

Fields (JSON object)
actionId (from action_id) required
ID of the action.

AuditLogActionId string

job optional
Job the event has been caused by (if any).

AuditLogEventJob

Fields (JSON object)
jobId (from job_id) required
ID of the job.

JobId string