Users

The Users API allows you to programmatically manage users within your Decube organization. You can create new users, fetch user details, deactivate users, and list all users in your account. These endpoints are useful for automating user onboarding and offboarding, auditing user status, and integrating user management into your internal workflows.

Use the endpoints below to:

• Add new users to your organization

• Retrieve user information by ID or email

• Deactivate (remove) users

• List all users and their statuses

get

Endpoint to fetch a user for the organization.

Query parameters

idstring · nullableOptional

emailstring · nullableOptional

Responses

200Success

application/json

emailstringRequired

idstringRequired

namestringRequired

statusstring · enumRequiredPossible values:

404

User not found.

application/json

422

Both the ID and the email are not set.

application/json

500

An error occurred while handling the request.

application/json

get

/user

HTTPcURLJavaScriptPython

GET /api/v1/app/user HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*

{
  "email": "[email protected]",
  "id": "0000-USER1",
  "name": "USER1",
  "status": "active"
}

post

Endpoint to create a user for the organization.

Body

application/json

emailstringRequired

namestringRequired

Responses

201Success

application/json

400Error

application/json

500

An error occurred while handling the request.

application/json

post

/user

HTTPcURLJavaScriptPython

POST /api/v1/app/user HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "email": "text",
  "name": "text"
}

{
  "email": "[email protected]",
  "id": "0000-USER1",
  "name": "USER1"
}

delete

Endpoint to deactivate a user for the organization.

Query parameters

emailstringRequired

Responses

200

User account deactivated successfully.

application/json

codestringRequired

messagestringRequired

403Error

application/json

404

User not found.

application/json

500

An error occurred while handling the request.

application/json

delete

/user

HTTPcURLJavaScriptPython

DELETE /api/v1/app/user?email=text HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*

{
  "code": "user_account_deactivated_successfully",
  "message": "User account deactivated successfully."
}

get

Endpoint to fetch users for the organization.

Query parameters

pageinteger · nullableOptional

page_sizeinteger · nullableOptional

Responses

200Success

application/json

countinteger · int64Required

500

An error occurred while handling the request.

application/json

get

/users

HTTPcURLJavaScriptPython

GET /api/v1/app/users HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*

{
  "count": 3,
  "users": [
    {
      "email": "[email protected]",
      "id": "0000-USER1",
      "name": "USER1",
      "status": "active"
    },
    {
      "email": "[email protected]",
      "id": "0000-USER3",
      "name": "USER3",
      "status": "deactivated"
    },
    {
      "email": "[email protected]",
      "id": "0000-USER2",
      "name": "USER2",
      "status": "pending_sign_up"
    }
  ]
}