User¶
All URIs are relative to https://api.ubiops.com/v2.1
| Method | HTTP request | Description |
|---|---|---|
| user_create | POST /user | Create a new user |
| user_delete | DELETE /user | Delete user |
user_create¶
UserPendingDetail user_create(data)
Create a new user
Description¶
Create a new user with the given details. After creation, an email is send to the email address to activate the account. The password needs to be at least 8 characters long.
Required Parameters¶
email: Email of the userpassword: Password of the user
Optional Parameters¶
name: Name of the usersurname: Surname of the user
Request Examples¶
{
"email": "[email protected]",
"password": "secret-password",
"name": "User name",
"surname": "User surname",
}
{
"email": "[email protected]",
"password": "secret-password"
}
Response Structure¶
Details of the created user
email: Email of the username: Name of the usersurname: Surname of the user
Response Examples¶
{
"email": "[email protected]",
"name": "User name",
"surname": "User surname",
}
Example¶
Initialize core_api using your credentials.
data = ubiops.UserPendingCreate() # UserPendingCreate
# Create a new user
api_response = core_api.user_create(data)
print(api_response)
Parameters¶
| Name | Type | Notes |
|---|---|---|
| data | UserPendingCreate |
Return type¶
Authorization¶
user_delete¶
user_delete()
Delete user
Description¶
Delete the user that makes the request
Example¶
Initialize core_api using your credentials.
# Delete user
core_api.user_delete()
Parameters¶
This endpoint does not need any parameter.
Return type¶
void (empty response body)