Skip to main content
Documentation

Organizations

Actions in the organizations namespace of the Nexigon Hub API.

Badges mark actions of the Device API and the Admin API, whose compatibility differs from other actions.

organizations_Query

POST/api/v1/actions/invoke/organizations_QueryAdmin API

Query the organizations of the instance.

Request QueryOrganizationsAction

No fields. Send an empty JSON object.

Response QueryOrganizationsOutput

  • organizationsarray<object>QueryOrganizationsItem

    List of organizations.

    3 fields
    • organizationIdstringOrganizationId

      ID of the organization.

    • namestring

      Name of the organization.

    • deactivationobjectOrganizationDeactivationoptional

      Deactivation of the organization, if it is deactivated.

      2 fields
      • deactivatedAtstring (date-time)Timestamp

        Timestamp when the organization was deactivated.

      • messagestringoptional

        Message shown to members, formatted as Markdown.

        A built-in message is shown when absent.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_Query
{
  "organizations": [
    {
      "organizationId": "<organization-id>",
      "name": "<name>"
    }
  ]
}

organizations_QueryMembers

POST/api/v1/actions/invoke/organizations_QueryMembers

Query the members of an organization.

Request QueryOrganizationMembersAction

  • organizationIdstringOrganizationId

    ID of the organization.

Response QueryOrganizationMembersOutput

  • membersarray<object>QueryOrganizationMembersItem

    List of members.

    4 fields
    • userIdstringUserId

      ID of the user.

    • displayNamestringoptional

      Name of the user.

    • emailstring

      Email of the user.

    • isAdminboolean

      Whether the user is an administrator of the organization.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"<organization-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_QueryMembers
{
  "members": [
    {
      "userId": "<user-id>",
      "email": "<email>",
      "isAdmin": true
    }
  ]
}

organizations_QueryProjects

POST/api/v1/actions/invoke/organizations_QueryProjects

Query the projects of an organization.

Request QueryOrganizationProjectsAction

  • organizationIdstringOrganizationId

    ID of the organization.

Response QueryOrganizationProjectsOutput

  • projectsarray<object>QueryOrganizationProjectsItem

    List of projects.

    2 fields
    • projectIdstringProjectId

      ID of the project.

    • namestring

      Name of the project.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"<organization-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_QueryProjects
{
  "projects": [
    {
      "projectId": "<project-id>",
      "name": "<name>"
    }
  ]
}

organizations_QueryRepositories

POST/api/v1/actions/invoke/organizations_QueryRepositories

Query the repositories of an organization.

Request QueryOrganizationRepositoriesAction

  • organizationIdstringOrganizationId

    ID of the organization.

Response QueryOrganizationRepositoriesOutput

  • repositoriesarray<object>QueryOrganizationRepositoriesItem

    List of repositories.

    5 fields
    • repositoryIdstringRepositoryId

      ID of the repository.

    • displayNamestring

      Display name of the repository.

    • pathNamestringoptional

      Path name of the repository, unique within its organization.

      Absent on older Hub versions.

    • slugstringoptional

      Slug of the repository, unique on the instance, if one has been set.

    • publicNamestring
      • Deprecated — removed in 2029.2 — Use slug, which is absent when no slug is set.

      Public name of the repository.

      Falls back to the repository ID when no slug is set.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"<organization-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_QueryRepositories
{
  "repositories": [
    {
      "repositoryId": "<repository-id>",
      "displayName": "<display-name>",
      "publicName": "<public-name>"
    }
  ]
}

organizations_QueryInvitations

POST/api/v1/actions/invoke/organizations_QueryInvitations

Query the invitations of an organization.

Request QueryOrganizationInvitationsAction

  • organizationIdstringOrganizationId

    ID of the organization.

Response QueryOrganizationInvitationsOutput

  • invitationsarray<object>QueryOrganizationInvitationsItem

    List of outstanding invitations.

    3 fields
    • invitationIdstringOrganizationInvitationId

      ID of the invitation.

    • emailstring

      Email address of the invited user.

    • invitingUserIdstringUserIdoptional

      ID of the inviting user.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"<organization-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_QueryInvitations
{
  "invitations": [
    {
      "invitationId": "<organization-invitation-id>",
      "email": "<email>"
    }
  ]
}

organizations_Create

POST/api/v1/actions/invoke/organizations_CreateAdmin API

Create an organization.

Request CreateOrganizationAction

  • namestring

    Name of the organization.

    • Organization name must be between 1 and 128 characters.
  • adminsarray<string>UserIdoptional

    Admins of the organization.

  • requiresSubscriptionboolean

    Whether the organization requires a subscription.

Response CreateOrganizationOutput

  • organizationIdstringOrganizationId

    ID of the organization.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>","requiresSubscription":true}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_Create
{
  "organizationId": "<organization-id>"
}

organizations_Delete

POST/api/v1/actions/invoke/organizations_DeleteAdmin API

Delete an organization.

Request DeleteOrganizationAction

  • organizationIdstringOrganizationId

    ID of the organization.

Response Empty

No fields. The response is an empty JSON object.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"<organization-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_Delete
{}

organizations_Deactivate

POST/api/v1/actions/invoke/organizations_DeactivateAdmin API

Deactivate an organization.

Admin-only operation. Members and API tokens hold no permissions in a deactivated organization, except that its administrators can manage its subscription. Its devices cannot connect, and its repositories are neither public nor available to devices of other organizations. Members, tokens, devices, data, and subscriptions are retained, and billing continues. Reactivation restores access. Deactivating a deactivated organization replaces its message, or selects the built-in message if message is absent.

Request DeactivateOrganizationAction

  • authorizationobjectActionAuthorization

    Authorization for this administrative action.

    2 variants

    One of the following, identified by kind:

    • kind: "Context"

      Evaluate the action's authenticated execution context.

    • kind: "Credentials"

      Re-verify the current user session with account credentials.

      • passwordstring

        Password of the user owning the current session.

      • codestringoptional

        Authenticator or recovery code when MFA is enabled.

  • organizationIdstringOrganizationId

    ID of the organization.

  • messagestringDeactivationMessageoptional

    Message shown to members.

    A built-in message is shown when absent.

    • Message must be between 1 and 2000 characters.
    • Message must not be blank.

Response Empty

No fields. The response is an empty JSON object.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "authorization": {
      "kind": "Context"
    },
    "organizationId": "<organization-id>"
  }' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_Deactivate
{}

organizations_Reactivate

POST/api/v1/actions/invoke/organizations_ReactivateAdmin API

Reactivate a deactivated organization.

Admin-only operation that restores access for members, API tokens, and devices.

Request ReactivateOrganizationAction

  • authorizationobjectActionAuthorization

    Authorization for this administrative action.

    2 variants

    One of the following, identified by kind:

    • kind: "Context"

      Evaluate the action's authenticated execution context.

    • kind: "Credentials"

      Re-verify the current user session with account credentials.

      • passwordstring

        Password of the user owning the current session.

      • codestringoptional

        Authenticator or recovery code when MFA is enabled.

  • organizationIdstringOrganizationId

    ID of the organization.

Response Empty

No fields. The response is an empty JSON object.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "authorization": {
      "kind": "Context"
    },
    "organizationId": "<organization-id>"
  }' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_Reactivate
{}

organizations_AddMember

POST/api/v1/actions/invoke/organizations_AddMemberAdmin API

Add a user to an organization.

Request AddOrganizationMemberAction

  • organizationIdstringOrganizationId

    ID of the organization.

  • userIdstringUserId

    ID of the user to add.

  • isAdminbooleanoptional

    Whether the user should be an administrator of the organization.

Response Empty

No fields. The response is an empty JSON object.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"<organization-id>","userId":"<user-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_AddMember
{}

organizations_RemoveMember

POST/api/v1/actions/invoke/organizations_RemoveMember

Remove a user from an organization.

Request RemoveOrganizationMemberAction

  • organizationIdstringOrganizationId

    ID of the organization.

  • userIdstringUserId

    ID of the user.

Response Empty

No fields. The response is an empty JSON object.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"<organization-id>","userId":"<user-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_RemoveMember
{}

organizations_SetMemberIsAdmin

POST/api/v1/actions/invoke/organizations_SetMemberIsAdmin

Set whether the user is an administrator of the organization.

Request SetOrganizationMemberIsAdminAction

  • organizationIdstringOrganizationId

    ID of the organization.

  • userIdstringUserId

    ID of the user.

  • isAdminboolean

    Whether the user should be an administrator of the organization.

Response Empty

No fields. The response is an empty JSON object.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "organizationId": "<organization-id>",
    "userId": "<user-id>",
    "isAdmin": true
  }' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_SetMemberIsAdmin
{}

organizations_InviteMember

POST/api/v1/actions/invoke/organizations_InviteMember

Invite a user to an organization.

Request InviteOrganizationMemberAction

  • organizationIdstringOrganizationId

    ID of the organization.

  • emailstring

    Email address of the user to invite.

    • Email must be between 3 and 254 characters.
    • Email must be a valid email address.

Response InviteOrganizationMemberOutput

  • invitationIdstringOrganizationInvitationId

    ID of the invitation.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"<organization-id>","email":"<email>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_InviteMember
{
  "invitationId": "<organization-invitation-id>"
}

organizations_DeleteInvitation

POST/api/v1/actions/invoke/organizations_DeleteInvitation

Delete an invitation to an organization.

Request DeleteOrganizationInvitationAction

  • invitationIdstringOrganizationInvitationId

    ID of the invitation.

Response Empty

No fields. The response is an empty JSON object.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"invitationId":"<organization-invitation-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_DeleteInvitation
{}

organizations_QueryAuditLog

POST/api/v1/actions/invoke/organizations_QueryAuditLog

Query the audit log of an organization.

Request QueryOrganizationAuditLogAction

  • pageobjectPageRequestoptional

    Opt into cursor pagination. Without this field, the existing limit applies.

    2 fields
    • limitintegeroptional

      Maximum number of items. The default depends on the endpoint and the ceiling is configured by the Hub operator (1000 by default).

      • Page limit must be positive.
    • cursorstringPageCursoroptional

      Continue the same endpoint, scope, filters, and ordering.

  • organizationIdstringOrganizationId

    ID of the organization.

  • filterobjectOrganizationAuditLogFilteroptional

    Only return the events matching this filter.

    Ignored by Nexigon Hub 2026.3 and earlier.

    3 variants

    One of the following, identified by kind:

    • kind: "Project"

      Only events of a project of the organization, including its devices.

      • projectIdstringProjectId

        ID of the project.

    • kind: "Repository"

      Only events of a repository of the organization.

      • repositoryIdstringRepositoryId

        ID of the repository.

    • kind: "User"

      Only events that a user performed or that concern them.

      • userIdstringUserId

        ID of the user.

  • sincestring (date-time)Timestampoptional

    Only return events recorded at or after this time.

    Ignored by Nexigon Hub 2026.3 and earlier.

  • untilstring (date-time)Timestampoptional

    Only return events recorded before this time.

    Ignored by Nexigon Hub 2026.3 and earlier.

Response QueryOrganizationAuditLogOutput

  • pageobjectPageInfooptional

    Present when cursor pagination was requested.

    1 field
    • nextCursorstringPageCursoroptional

      Cursor for the next page; absent when no more matching rows were visible.

  • eventsarray<object>AuditLogEvent

    List of audit log events.

    7 fields
    • eventIdstringAuditLogEventId

      ID of the audit log event.

    • actorobjectActor

      Actor causing the event.

      7 variants

      One of the following, identified by actor:

      • actor: "Anonymous"

        An anonymous, unauthenticated actor.

      • actor: "System"

        The system itself, typically used for internal actions.

      • actor: "Device"

        A device authenticated via a specific deployment token.

        • deviceIdstringDeviceId

          ID of the device.

        • tokenIdstringDeploymentTokenId

          ID of the deployment token used for authentication.

      • actor: "User"

        A user typically authenticated via a user session.

        • userIdstringUserId

          ID of the user.

      • actor: "UserToken"

        A user authenticated via a specific token.

        • userIdstringUserId

          ID of the user.

        • tokenIdstringUserTokenId

          ID of the user token used for authentication.

      • actor: "ClusterNode"

        A cluster node.

        • nodeIdstringClusterNodeId

          ID of the cluster node.

      • actor: "OrganizationApiToken"

        An organization API token.

        • organizationIdstringOrganizationId

          ID of the organization.

        • tokenIdstringOrganizationApiTokenId

          ID of the API token.

    • eventstring

      Type of the event that was recorded.

    • dataanyJsonValue

      Additional audit data associated with the event.

    • createdAtstring (date-time)Timestamp

      Timestamp indicating when the audit log event was recorded.

    • actionobjectAuditLogEventActionoptional

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

      1 field
      • actionIdstringAuditLogActionId

        ID of the action.

    • jobobjectAuditLogEventJoboptional

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

      1 field
      • jobIdstringJobId

        ID of the job.

  • referencesobjectAuditLogReferencesoptional

    Names of the actors of the returned events.

    Absent in responses of Nexigon Hub 2026.3 and earlier.

    3 fields
    • usersarray<object>AuditLogUserReference

      Users acting directly or through a user token.

      3 fields
      • userIdstringUserId

        ID of the user.

      • displayNamestringoptional

        Name of the user.

      • emailstring

        Email of the user.

    • devicesarray<object>AuditLogDeviceReference

      Devices.

      2 fields
      • deviceIdstringDeviceId

        ID of the device.

      • namestring

        Name of the device.

    • organizationApiTokensarray<object>AuditLogOrganizationApiTokenReference

      Organization API tokens.

      2 fields
      • tokenIdstringOrganizationApiTokenId

        ID of the API token.

      • namestring

        Name of the API token.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"<organization-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_QueryAuditLog
{
  "events": [
    {
      "eventId": "<audit-log-event-id>",
      "actor": {
        "actor": "Device",
        "deviceId": "<device-id>",
        "tokenId": "<deployment-token-id>"
      },
      "event": "<event>",
      "data": {},
      "createdAt": "2026-01-01T12:00:00Z"
    }
  ]
}

organizations_SetS3Config

POST/api/v1/actions/invoke/organizations_SetS3Config

Organization S3 defaults for repositories without their own configuration.

Request SetOrganizationS3ConfigAction

  • organizationIdstringOrganizationId
  • s3ConfigobjectRepositoryS3Config
    7 fields
    • endpointstring
      • S3 endpoint must be between 1 and 2048 characters.
      • S3 endpoint must be an HTTP(S) URL.
    • bucketstring

      S3 bucket name.

      • S3 bucket name must be between 3 and 63 characters.
      • S3 bucket name must use only lowercase letters, digits, dots, and hyphens, and start and end with a letter or digit.
    • regionstringoptional

      AWS region (required by AWS, may be NULL for MinIO/other providers).

      • AWS region must be between 1 and 64 characters.
    • prefixstringoptional

      Optional bucket prefix. Organization storage adds repositories/<repository-id>/.

      • Bucket prefix must be at most 1024 characters.
    • forcePathStylebooleanoptional

      Force path-style bucket addressing. By default, Nexigon uses virtual-hosted addressing.

    • accessKeyIdstring

      S3 access key ID (not sensitive, can be plain text).

      • Access key ID must be between 1 and 256 characters.
    • secretAccessKeystringoptional

      S3 secret access key (sensitive, will be stored encrypted).

      • Secret access key must be between 1 and 256 characters.

Response Empty

No fields. The response is an empty JSON object.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "organizationId": "<organization-id>",
    "s3Config": {
      "endpoint": "<endpoint>",
      "bucket": "<bucket>",
      "accessKeyId": "<access-key-id>"
    }
  }' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_SetS3Config
{}

organizations_GetS3Config

POST/api/v1/actions/invoke/organizations_GetS3Config

Get organization storage settings. Secret credentials are never returned.

Request GetOrganizationS3ConfigAction

  • organizationIdstringOrganizationId

Response GetOrganizationS3ConfigOutput

  • s3ConfigobjectRepositoryS3Configoptional
    7 fields
    • endpointstring
      • S3 endpoint must be between 1 and 2048 characters.
      • S3 endpoint must be an HTTP(S) URL.
    • bucketstring

      S3 bucket name.

      • S3 bucket name must be between 3 and 63 characters.
      • S3 bucket name must use only lowercase letters, digits, dots, and hyphens, and start and end with a letter or digit.
    • regionstringoptional

      AWS region (required by AWS, may be NULL for MinIO/other providers).

      • AWS region must be between 1 and 64 characters.
    • prefixstringoptional

      Optional bucket prefix. Organization storage adds repositories/<repository-id>/.

      • Bucket prefix must be at most 1024 characters.
    • forcePathStylebooleanoptional

      Force path-style bucket addressing. By default, Nexigon uses virtual-hosted addressing.

    • accessKeyIdstring

      S3 access key ID (not sensitive, can be plain text).

      • Access key ID must be between 1 and 256 characters.
    • secretAccessKeystringoptional

      S3 secret access key (sensitive, will be stored encrypted).

      • Secret access key must be between 1 and 256 characters.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"<organization-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_GetS3Config
{}

organizations_DeleteS3Config

POST/api/v1/actions/invoke/organizations_DeleteS3Config

Remove organization storage defaults without deleting stored objects.

Request DeleteOrganizationS3ConfigAction

  • organizationIdstringOrganizationId

Response Empty

No fields. The response is an empty JSON object.

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"<organization-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/organizations_DeleteS3Config
{}