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 user
password: Password of the user

Optional Parameters¶

name: Name of the user
surname: Surname of the user
phone: Phone number of the user

Request Examples¶

{
  "email": "[email protected]",
  "password": "secret-password",
  "name": "User name",
  "surname": "User surname",
  "phone": "+999999999"
}

{
  "email": "[email protected]",
  "password": "secret-password"
}

Response Structure¶

Details of the created user

email: Email of the user
name: Name of the user
surname: Surname of the user
phone: Phone number of the user

Response Examples¶

{
  "email": "[email protected]",
  "name": "User name",
  "surname": "User surname",
  "phone": "+999999999"
}

Example¶

Use system environment variables

import ubiops

# Set environment variables
# - UBIOPS_API_TOKEN: "Token <YOUR_API_TOKEN>"
# - UBIOPS_API_HOST: optional - default to "https://api.ubiops.com/v2.1"
core_api = ubiops.CoreApi()

data = ubiops.UserPendingCreate() # UserPendingCreate

# Create a new user
api_response = core_api.user_create(data)
print(api_response)

# Close the connection
core_api.api_client.close()

Use authorization parameters

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"

api_client = ubiops.ApiClient(configuration)
core_api = ubiops.CoreApi(api_client)

data = ubiops.UserPendingCreate() # UserPendingCreate

# Create a new user
api_response = core_api.user_create(data)
print(api_response)

# Close the connection
api_client.close()

Parameters¶

Name	Type	Notes
data	UserPendingCreate

Return type¶

UserPendingDetail

Authorization¶

API token

[Back to top]

user_delete¶

user_delete()

Delete user