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 user is required to accept the terms and conditions. The password needs to be at least 8 characters long.
Required Parameters¶
email
: Email of the userpassword
: Password of the userterms_conditions
: A boolean indicating whether the user accepts terms and conditions
Optional Parameters¶
name
: Name of the usersurname
: Surname of the usernewsletter
: A boolean indicating whether to subscribe to the newsletters
Request Examples¶
{
"email": "[email protected]",
"password": "secret-password",
"name": "User name",
"surname": "User surname",
"terms_conditions": true,
"newsletter": false
}
{
"email": "[email protected]",
"password": "secret-password",
"terms_conditions": true,
"newsletter": false
}
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¶
import ubiops
configuration = ubiops.Configuration()
# Configure API token authorization
configuration.api_key['Authorization'] = 'Token <YOUR_API_TOKEN>'
# Defining host is optional and default to https://api.ubiops.com/v2.1
configuration.host = "https://api.ubiops.com/v2.1"
# Enter a context with an instance of the API client
api_client = ubiops.ApiClient(configuration)
# Create an instance of the API class
api = ubiops.CoreApi(api_client)
data = ubiops.UserPendingCreate() # UserPendingCreate
# Create a new user
api_response = api.user_create(data)
print(api_response)
# Close the connection
api_client.close()
Parameters¶
Name | Type | Notes |
---|---|---|
data | UserPendingCreate |
Return type¶
Authorization¶
user_delete¶
user_delete()
Delete user
Description¶
Delete the user that makes the request
Example¶
import ubiops
configuration = ubiops.Configuration()
# Configure API token authorization
configuration.api_key['Authorization'] = 'Token <YOUR_API_TOKEN>'
# Defining host is optional and default to https://api.ubiops.com/v2.1
configuration.host = "https://api.ubiops.com/v2.1"
# Enter a context with an instance of the API client
api_client = ubiops.ApiClient(configuration)
# Create an instance of the API class
api = ubiops.CoreApi(api_client)
# Delete user
api.user_delete()
# Close the connection
api_client.close()
Parameters¶
This endpoint does not need any parameter.
Return type¶
void (empty response body)