Users
get
Endpoint to fetch a user for the organization.
Query parameters
idstring | nullOptional
emailstring | nullOptional
Responses
200Success
application/json
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
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
emailstringRequired
namestringRequired
Responses
201Success
application/json
400Error
application/json
500
An error occurred while handling the request.
application/json
post
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
403Error
application/json
404
User not found.
application/json
500
An error occurred while handling the request.
application/json
delete
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 | nullOptional
page_sizeinteger | nullOptional
Responses
200Success
application/json
500
An error occurred while handling the request.
application/json
get
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