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
Endpoint to fetch a user for the organization.
User not found.
Both the ID and the email are not set.
An error occurred while handling the request.
GET /api/v1/app/user HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*
{
"email": "[email protected]",
"id": "0000-USER1",
"name": "USER1",
"status": "active"
}Endpoint to create a user for the organization.
An error occurred while handling the request.
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"
}Endpoint to deactivate a user for the organization.
User account deactivated successfully.
User not found.
An error occurred while handling the request.
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."
}Endpoint to fetch users for the organization.
An error occurred while handling the request.
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"
}
]
}Last updated