Users

List Users

get

List organization members and pending invitations with optional pagination and search.

Headers

Name	Type
Authorization*	HMAC {key}:{signature}:{nonce}:{timestamp}
Content-Type	application/json

Query Parameters

Parameter	Type	Default	Description
page	Integer	1	Page number
per_page	Integer	20	Record count per page
q	String	-	Search by user email or name

Success Response Example

{
    "users": [
        {
            "name": "Computer User",
            "email": "[email protected]",
            "status": "active",
            "machine_id": 100,
            "uid": "f1592625-edd0-48df-9bc0-de14910ec936"
        },
        {
            "name": null,
            "email": "[email protected]",
            "status": "invitation-pending",
            "machine_id": null,
            "uid": null
        }
    ],
    "count": 2,
    "page": 1,
    "next_page": null,
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-02-09T12:00:00Z"
}

Success Response Fields

Field	Type	Description
users	Array	Array of user or invitation objects
users[].name	String or null	User display name (null for invitation)
users[].email	String	User or invitee email
users[].status	String	"active" or "invitation-pending"
users[].machine_id	Integer or null	Assigned machine ID (null if none)
users[].uid	String or null	User UUID (null for pending invitation)
count	Integer	Total count for current page
page	Integer	Current page number
next_page	Integer or null	Next page number (null if no more pages)
client_code	Integer	Response code (200 for success)
message	String	Response message
timestamp	String	Response timestamp (ISO 8601)

Error Responses

Status	Description
400	Bad request
4710	Permission required

Query parameters

pageintegerOptional

(Optional) Page number. Default: 1

Example: 1

per_pageintegerOptional

(Optional) Records per page. Default: 20

Example: 20

qstringOptional

(Optional) Search by user email or name

Example: string

Responses

200

List of users and pending invitations

application/json

400

Bad request

application/json

4710

Permission required

application/json

get

/users

HTTPcURLJavaScriptPython

GET /organization-management/v1/users HTTP/1.1
Host: api.vagon.io
Accept: */*

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:10:22Z",
  "users": [
    {
      "name": "text",
      "email": "[email protected]",
      "status": "active",
      "machine_id": 1,
      "uid": "text"
    }
  ],
  "count": 1,
  "page": 1,
  "next_page": 1
}

Remove User or Cancel Invitation

delete

Remove a member from the organization or cancel a pending invitation.

Headers

Name	Type
Authorization*	HMAC {key}:{signature}:{nonce}:{timestamp}
Content-Type	application/json

Body Parameters

Parameter	Type	Required	Description
email*	String	Yes	User or invitee email to remove
keep_files	Boolean	No	Whether to keep user files. Default: true

Request Body Example

{
  "email": "[email protected]",
  "keep_files": true
}

Success Response Example

{
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-02-10T15:56:54Z"
}

Success Response Fields

Field	Type	Description
client_code	Integer	Response code (200 for success)
message	String	Response message
timestamp	String	Response timestamp (ISO 8601)

Error Responses

Status	Description
400	Bad request
404	Email not found in organization or pending invitations
4318	Not a valid email
4319	Email not found
4710	Permission required
4713	Organization owner cannot be removed

Body

application/json

emailstringRequired

User or invitee email to remove

keep_filesbooleanOptional

Whether to keep user files. Default true

Default: true

Responses

200

User removed or invitation cancelled

application/json

400

Bad request

application/json

404

Email not found in organization or pending invitations

application/json

4318

Not a valid email

application/json

4319

Email not found

application/json

4710

Permission required

application/json

4713

Organization owner cannot be removed

application/json

delete

/users

HTTPcURLJavaScriptPython

DELETE /organization-management/v1/users HTTP/1.1
Host: api.vagon.io
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "email": "[email protected]",
  "keep_files": true
}

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:10:22Z"
}

Assign User or Invitation to Machine

post

Assign a user or pending invitation to an unassigned machine. If the machine is already assigned, revoke first.

Headers

Name	Type
Authorization*	HMAC {key}:{signature}:{nonce}:{timestamp}
Content-Type	application/json

Body Parameters

Parameter	Type	Required	Description
machine_id*	Integer	Yes	Machine ID to assign
email*	String	Yes	User or invitee email

Request Body Example

{
  "machine_id": 100,
  "email": "[email protected]"
}

Success Response Example

{
    "name": "Computer User",
    "email": "[email protected]",
    "status": "active",
    "machine_id": 100,
    "uid": "683530d7-707a-aaaa-8d74-4ac8475e5051",
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-02-10T15:58:10Z"
}

Success Response Fields

Field	Type	Description
name	String or null	User display name (null for pending invitation)
email	String	User or invitee email
status	String	"active" or "invitation-pending"
machine_id	Integer	Assigned machine ID
uid	String or null	User UUID (null for pending invitation)
client_code	Integer	Response code (200 for success)
message	String	Response message
timestamp	String	Response timestamp (ISO 8601)

Error Responses

Status	Description
400	Bad request
404	Machine not found or email not in organization/invitations
4318	Not a valid email
4319	Email not found
4710	Permission required
4715	Machine already assigned. Revoke current assignment first.

Body

application/json

machine_idintegerRequired

Machine ID to assign

emailstringRequired

User or invitee email

Responses

200

User or invitation assigned successfully

application/json

400

Bad request

application/json

404

Machine or user/email not found

application/json

4318

Not a valid email

application/json

4319

Email not found

application/json

4710

Permission required

application/json

4715

Machine already assigned. Revoke current assignment first.

application/json

post

/users/assign

HTTPcURLJavaScriptPython

POST /organization-management/v1/users/assign HTTP/1.1
Host: api.vagon.io
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "machine_id": 100,
  "email": "[email protected]"
}

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:10:22Z",
  "name": "text",
  "email": "text",
  "status": "active",
  "machine_id": 1,
  "uid": "text"
}

Revoke User or Invitation from Machine

post

Revoke the user or invitation assigned to a machine (lookup by email).

Headers

Name	Type
Authorization*	HMAC {key}:{signature}:{nonce}:{timestamp}
Content-Type	application/json

Body Parameters

Parameter	Type	Required	Description
email*	String	Yes	User or invitee email to revoke from their assigned machine
keep_files	Boolean	No	Whether to keep user files. Default: true

Request Body Example

{
  "email": "[email protected]",
  "keep_files": true
}

Success Response Example

{
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-02-10T16:01:24Z"
}

Success Response Fields

Field	Type	Description
client_code	Integer	Response code (200 for success)
message	String	Response message
timestamp	String	Response timestamp (ISO 8601)

Error Responses

Status	Description
400	Bad request
404	Email does not match any user or invitation
4318	Not a valid email
4710	Permission required
4714	User or invitation not assigned to any machine

Body

application/json

emailstringRequired

User or invitee email to revoke from their assigned machine

keep_filesbooleanOptional

Whether to keep user files. Default true

Default: true

Responses

200

User or invitation revoked from machine

application/json

400

Bad request

application/json

404

Email does not match any user or invitation

application/json

4318

Not a valid email

application/json

4710

Permission required

application/json

4714

User or invitation not assigned to any machine

application/json

post

/users/revoke

HTTPcURLJavaScriptPython

POST /organization-management/v1/users/revoke HTTP/1.1
Host: api.vagon.io
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "email": "[email protected]",
  "keep_files": true
}

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:10:22Z"
}

Create Invitations

post

Create invitations for one or more emails. Requires invitations to be enabled for the organization.

Headers

Name	Type
Authorization*	HMAC {key}:{signature}:{nonce}:{timestamp}
Content-Type	application/json

Body Parameters

Parameter	Type	Required	Description
emails*	Array[String]	Yes	List of email addresses to invite

Request Body Example

{
  "emails": [
    "[email protected]", 
    "[email protected]"
  ]
}

Success Response Example

{
    "invitation_results": {
        "success": [
          "[email protected]"
        ],
        "failed": [
          "[email protected]"
        ]
    },
    "client_code": 200,
    "message": "OK",
    "timestamp": "2026-02-09T12:00:00Z"
}

Success Response Fields

Field	Type	Description
invitation_results	Object	Result of invitation requests
invitation_results.success	Array[String]	Emails invited successfully
invitation_results.failed	Array[String]	Emails that failed (invalid or not allowed)
client_code	Integer	Response code (200 for success)
message	String	Response message
timestamp	String	Response timestamp (ISO 8601)

Error Responses

Status	Description
400	Bad request
403	Invitations not enabled for organization
404	Not Found
4710	Permission required

Body

application/json

emailsstring[]Required

List of email addresses to invite

Responses

200

Invitation results (success and failed arrays)

application/json

400

Bad request

application/json

403

Invitations not enabled for organization

application/json

404

Not Found

application/json

4710

Permission required

application/json

post

/users/invite

HTTPcURLJavaScriptPython

POST /organization-management/v1/users/invite HTTP/1.1
Host: api.vagon.io
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "emails": [
    "[email protected]",
    "[email protected]"
  ]
}

{
  "client_code": 200,
  "message": "OK",
  "timestamp": "2026-02-05T10:10:22Z",
  "invitation_results": {
    "success": [
      "text"
    ],
    "failed": [
      "text"
    ]
  }
}