NebulaECN API Docs
Search…
⌃K

Authenticating

This chapter describes the process of authentication by API.
You can see this process for UI using the link to the User Guide below:‌
​Authentication Guide​‌

Confirm code

/api/v2/auth/identity/users/password/confirm_code

POST
Description
Sets new account password‌
Parameters
Name
Located in
Description
Required
Schema
reset_password_token
formData
Token from email
Yes
string
password
formData
User password
Yes
string
confirm_password
formData
User password
Yes
string
Responses
Code
Description
201
Resets password
400
Required params are empty
404
Record is not found
422
Validation errors

/api/v2/auth/identity/users/password/generate_code

POST
Description
Send password reset instructions‌
Parameters
Name
Located in
Description
Required
Schema
email
formData
Account email
Yes
string
captcha_response
formData
Response from captcha widget
No
string
Responses
Code
Description
201
Generated password reset code
400
Required params are missing
404
User doesn't exist
422
Validation errors

/api/v2/auth/identity/users/email/confirm_code

POST
Description
Confirms an account‌
Parameters
Name
Located in
Description
Required
Schema
token
formData
Token from email
Yes
string
Responses
Code
Description
Schema
201
Confirms an account
API_V2_Entities_UserWithFullInfo
400
Required params are missing
​Content
422
Validation errors
​Content

/api/v2/auth/identity/users/email/generate_code

POST
Description
Send confirmations instructions‌
Parameters
Name
Located in
Description
Required
Schema
email
formData
Account email
Yes
string
captcha_response
formData
Response from captcha widget
No
string
Responses
Code
Description
201
Generated verification code
400
Required params are missing
422
Validation errors

/api/v2/auth/identity/users/register_geetest

GET
Description
Register Geetest captcha‌
Responses
Code
Description
200
Register Geetest captcha

/api/v2/auth/identity/users

POST
Description
Creates new user‌
Parameters
Name
Located in
Description
Required
Schema
email
formData
User Email
Yes
string
password
formData
User Password
Yes
string
username
formData
User Username
No
string
refid
formData
Referral uid
No
string
captcha_response
formData
Response from captcha widget
No
string
data
formData
Any additional key: value pairs in json string format
No
string
Responses
Code
Description
Schema
201
Creates new user
API_V2_Entities_UserWithFullInfo
400
Required params are missing
​Content
422
Validation errors
​Content

/api/v2/auth/identity/users/access

POST
Description
Creates new whitelist restriction‌
Parameters
Name
Located in
Description
Required
Schema
whitelink_token
formData
​Content
Yes
string
Responses
Code
Description
200
Whitelist restriction was created
400
Required params are missing
422
Validation errors

/api/v2/auth/identity/sessions/auth0

POST
Description
Auth0 authentication by id_token‌
Parameters
Name
Located in
Description
Required
Schema
id_token
formData
ID Token
Yes
string
Responses
Code
Description
200
User authenticated
400
Required params are empty
404
Record is not found

/api/v2/auth/identity/sessions

DELETE
Description
Destroy current session‌
Responses
Code
Description
204
Session was destroyed
400
Required params are empty
404
Record is not found

POST‌

Description
Start a new session‌
Parameters
Name
Located in
Description
Required
Schema
email
formData
​Content
Yes
string
password
formData
​Content
Yes
string
captcha_response
formData
Response from captcha widget
No
string
otp_code
formData
Code from Google Authenticator
No
string
Responses
Code
Description
201
Start a new session
400
Required params are empty
404
Record is not found

/api/v2/auth/identity/configs

GET
Description
Get auth configurations‌
Responses
Code
Description
200
Get auth configurations

/api/v2/auth/identity/version

GET
Description
Get auth version‌
Responses
Code
Description
200
Get auth version

/api/v2/auth/identity/time

GET
Description
Get server current unix timestamp.‌
Responses
Code
Description
200
Get server current unix timestamp.

/api/v2/auth/identity/ping

GET
Description
Test connectivity‌
Responses
Code
Description
200
Test connectivity

/api/v2/auth/identity/password/validate

POST
Description
Password strength testing‌
Parameters
Name
Located in
Description
Required
Schema
password
formData
User password
Yes
string
Responses
Code
Description
201
Password strength testing

/api/v2/auth/resource/swagger_doc/{name}

GET
Description
Swagger compatible API description for specific API‌
Parameters
Name
Located in
Description
Required
Schema
name
path
Resource name of mounted API
Yes
string
locale
query
Locale of API documentation
No
string
Responses
Code
Description
200
Swagger compatible API description for specific API

/api/v2/auth/resource/swagger_doc

GET
Description
Swagger compatible API description‌
Responses
Code
Description
200
Swagger compatible API description

/api/v2/auth/resource/service_accounts/api_keys/{kid}

PUT
Description
Updates an api key‌
Parameters
Name
Located in
Description
Required
Schema
service_account_uid
formData
​Content
Yes
string
kid
path
Service account kid
Yes
string
scope
formData
Comma separated scopes
No
string
state
formData
State of API Key. "active" state means key is active and can be used for auth
No
string
totp_code
formData
Code from Google Authenticator
Yes
string
Responses
Code
Description
Schema
200
Updates an api key
API_V2_Entities_APIKey
400
Required params are empty
​Content
401
Invalid bearer token
​Content
404
Record is not found
​Content
422
Validation errors
​Content
DELETE
Description
Delete an api key for specific service account‌
Parameters
Name
Located in
Description
Required
Schema
service_account_uid
query
​Content
Yes
string
kid
path
Service account kid
Yes
string
totp_code
query
Code from Google Authenticator
Yes
string
Responses
Code
Description
204
Succefully deleted
400
Required params are empty
401
Invalid bearer token
404
Record is not found

/api/v2/auth/resource/service_accounts/api_keys

POST
Description
Create api key for specific service account.‌
Parameters
Name
Located in
Description
Required
Schema
service_account_uid
formData
​Content
Yes
string
algorithm
formData
Service account algorithm
Yes
string
scope
formData
Comma separated scopes
No
string
totp_code
formData
Code from Google Authenticator
Yes
string
Responses
Code
Description
Schema
201
Create api key for specific service account.
API_V2_Entities_APIKey
400
Require 2FA and totp code
​Content
401
Invalid bearer token
​Content
GET
Description
List all api keys for specific service account.‌
Parameters
Name
Located in
Description
Required
Schema
ordering
query
If set, returned values will be sorted in specific order, defaults to 'asc'.
No
string
order_by
query
Name of the field, which result will be ordered by.
No
string
page
query
Page number (defaults to 1).
No
integer
limit
query
Number of users per page (defaults to 100, maximum is 100).
No
integer
service_account_uid
query
​Content
Yes
string
Responses
Code
Description
Schema
200
List all api keys for specific service account.
API_V2_Entities_APIKey
400
Require 2FA and totp code
​Content
401
Invalid bearer token
​Content

/api/v2/auth/resource/service_accounts

GET
Description
List all service accounts for current user.‌
Responses
Code
Description
200
List all service accounts for current user.
400
Require 2FA and totp code
401
Invalid bearer token
Security
Security Schema
Scopes
BearerToken
​Content

/api/v2/auth/resource/data_storage

POST
Description
Create data storage‌
Parameters
Name
Located in
Description
Required
Schema
title
formData
Storage title
Yes
string
data
formData
Storage data
Yes
string
Responses
Code
Description
201
Data Storage was created
401
Invalid bearer token
422
Validation errors

/api/v2/auth/resource/api_keys

GET
Description
List all api keys for current account.‌
Parameters
Name
Located in
Description
Required
Schema
ordering
query
If set, returned values will be sorted in specific order, defaults to 'asc'.
No
string
order_by