Auth

post

Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.

Body

usernamestring · min: 1Write-onlyRequired

passwordstring · min: 1Write-onlyRequired

Responses

200Success

application/json

accessstringRead-onlyRequired

refreshstringRead-onlyRequired

post

/v1/auth/jwt/create/

POST /v1/auth/jwt/create/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "username": "text",
  "password": "text"
}

200Success

{
  "access": "text",
  "refresh": "text"
}

post

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Body

refreshstring · min: 1Write-onlyRequired

Responses

200Success

application/json

accessstringRead-onlyRequired

post

/v1/auth/jwt/refresh/

POST /v1/auth/jwt/refresh/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "refresh": "text"
}

200Success

{
  "access": "text"
}

post

Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.

Body

tokenstring · min: 1Write-onlyRequired

Responses

200

No response body

No content

post

/v1/auth/jwt/verify/

POST /v1/auth/jwt/verify/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "token": "text"
}

200

No response body

No content

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

pageintegerOptional

A page number within the paginated result set.

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

get

/v1/auth/users/

GET /v1/auth/users/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "email": "[email protected]",
      "id": 1,
      "username": "text",
      "first_name": "text",
      "last_name": "text",
      "company_name": "text",
      "distribution_algo": "priority",
      "base_currency": "AED",
      "permissions": "text"
    }
  ]
}

post

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Body

Custom UserCreatePasswordRetypeSerializer that extends our UserCreateSerializer and adds password retype validation from Djoser's base.

emailstring · email · max: 254Optional

usernamestring · min: 1Required

passwordstring · min: 1Write-onlyRequired

first_namestring · max: 150Optional

last_namestring · max: 150Optional

company_namestring · max: 64Optional

base_currencystring · min: 1Optional

distribution_algostring · enumOptional

priority - Priority
round_robin - Round Robin

Possible values:

re_passwordstring · min: 1Required

Responses

201Success

application/json

post

/v1/auth/users/

POST /v1/auth/users/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "email": "[email protected]",
  "username": "text",
  "password": "text",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "base_currency": "text",
  "distribution_algo": "priority",
  "re_password": "text"
}

201Success

{
  "email": "[email protected]",
  "username": "text",
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "base_currency": "text",
  "distribution_algo": "priority",
  "re_password": "text"
}

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this user.

Responses

200Success

application/json

emailstring · email · max: 254Optional

idintegerRead-onlyRequired

usernamestringRead-onlyRequired

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_namestring · max: 150Optional

last_namestring · max: 150Optional

company_namestringOptional

distribution_algostring · enumOptional

priority - Priority
round_robin - Round Robin

Possible values:

base_currencystring · enumOptional

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

permissionsstringRead-onlyRequired

get

/v1/auth/users/{id}/

GET /v1/auth/users/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "email": "[email protected]",
  "id": 1,
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "distribution_algo": "priority",
  "base_currency": "AED",
  "permissions": "text"
}

put

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this user.

Body

emailstring · email · max: 254Optional

first_namestring · max: 150Optional

last_namestring · max: 150Optional

company_namestring · min: 1Optional

distribution_algostring · enumOptional

priority - Priority
round_robin - Round Robin

Possible values:

base_currencystring · enumOptional

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

Responses

200Success

application/json

emailstring · email · max: 254Optional

idintegerRead-onlyRequired

usernamestringRead-onlyRequired

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_namestring · max: 150Optional

last_namestring · max: 150Optional

company_namestringOptional

distribution_algostring · enumOptional

priority - Priority
round_robin - Round Robin

Possible values:

base_currencystring · enumOptional

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

permissionsstringRead-onlyRequired

put

/v1/auth/users/{id}/

PUT /v1/auth/users/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "email": "[email protected]",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "distribution_algo": "priority",
  "base_currency": "AED"
}

200Success

{
  "email": "[email protected]",
  "id": 1,
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "distribution_algo": "priority",
  "base_currency": "AED",
  "permissions": "text"
}

delete

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this user.

Responses

204

No response body

delete

/v1/auth/users/{id}/

DELETE /v1/auth/users/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

patch

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this user.

Body

emailstring · email · max: 254Optional

first_namestring · max: 150Optional

last_namestring · max: 150Optional

company_namestring · min: 1Optional

distribution_algostring · enumOptional

priority - Priority
round_robin - Round Robin

Possible values:

base_currencystring · enumOptional

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

Responses

200Success

application/json

emailstring · email · max: 254Optional

idintegerRead-onlyRequired

usernamestringRead-onlyRequired

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_namestring · max: 150Optional

last_namestring · max: 150Optional

company_namestringOptional

distribution_algostring · enumOptional

priority - Priority
round_robin - Round Robin

Possible values:

base_currencystring · enumOptional

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

permissionsstringRead-onlyRequired

patch

/v1/auth/users/{id}/

PATCH /v1/auth/users/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "email": "[email protected]",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "distribution_algo": "priority",
  "base_currency": "AED"
}

200Success

{
  "email": "[email protected]",
  "id": 1,
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "distribution_algo": "priority",
  "base_currency": "AED",
  "permissions": "text"
}

post

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Body

uidstring · min: 1Required

tokenstring · min: 1Required

Responses

200Success

application/json

uidstringRequired

tokenstringRequired

post

/v1/auth/users/activation/

POST /v1/auth/users/activation/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "uid": "text",
  "token": "text"
}

200Success

{
  "uid": "text",
  "token": "text"
}

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Responses

200Success

application/json

emailstring · email · max: 254Optional

idintegerRead-onlyRequired

usernamestringRead-onlyRequired

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_namestring · max: 150Optional

last_namestring · max: 150Optional

company_namestringOptional

distribution_algostring · enumOptional

priority - Priority
round_robin - Round Robin

Possible values:

base_currencystring · enumOptional

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

permissionsstringRead-onlyRequired

get

/v1/auth/users/me/

GET /v1/auth/users/me/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "email": "[email protected]",
  "id": 1,
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "distribution_algo": "priority",
  "base_currency": "AED",
  "permissions": "text"
}

put

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

emailstring · email · max: 254Optional

first_namestring · max: 150Optional

last_namestring · max: 150Optional

company_namestring · min: 1Optional

distribution_algostring · enumOptional

priority - Priority
round_robin - Round Robin

Possible values:

base_currencystring · enumOptional

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

Responses

200Success

application/json

emailstring · email · max: 254Optional

idintegerRead-onlyRequired

usernamestringRead-onlyRequired

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_namestring · max: 150Optional

last_namestring · max: 150Optional

company_namestringOptional

distribution_algostring · enumOptional

priority - Priority
round_robin - Round Robin

Possible values:

base_currencystring · enumOptional

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

permissionsstringRead-onlyRequired

put

/v1/auth/users/me/

PUT /v1/auth/users/me/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "email": "[email protected]",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "distribution_algo": "priority",
  "base_currency": "AED"
}

200Success

{
  "email": "[email protected]",
  "id": 1,
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "distribution_algo": "priority",
  "base_currency": "AED",
  "permissions": "text"
}

delete

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Responses

204

No response body

delete

/v1/auth/users/me/

DELETE /v1/auth/users/me/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

patch

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

emailstring · email · max: 254Optional

first_namestring · max: 150Optional

last_namestring · max: 150Optional

company_namestring · min: 1Optional

distribution_algostring · enumOptional

priority - Priority
round_robin - Round Robin

Possible values:

base_currencystring · enumOptional

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

Responses

200Success

application/json

emailstring · email · max: 254Optional

idintegerRead-onlyRequired

usernamestringRead-onlyRequired

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_namestring · max: 150Optional

last_namestring · max: 150Optional

company_namestringOptional

distribution_algostring · enumOptional

priority - Priority
round_robin - Round Robin

Possible values:

base_currencystring · enumOptional

AED - AED د.إ
AUD - AUD $
BHD - BHD .د.ب
CAD - CAD $
CLP - CLP $
DKK - DKK kr.
EUR - EUR €
GBP - GBP £
HKD - HKD $
KWD - KWD د.ك
NOK - NOK kr
NZD - NZD $
OMR - OMR ﷼
PLN - PLN zł
QAR - QAR ﷼
SAR - SAR ﷼
SEK - SEK kr
USD - USD $

Possible values:

permissionsstringRead-onlyRequired

patch

/v1/auth/users/me/

PATCH /v1/auth/users/me/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "email": "[email protected]",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "distribution_algo": "priority",
  "base_currency": "AED"
}

200Success

{
  "email": "[email protected]",
  "id": 1,
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "company_name": "text",
  "distribution_algo": "priority",
  "base_currency": "AED",
  "permissions": "text"
}

post

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Body

emailstring · email · min: 1Required

Responses

200Success

application/json

emailstring · emailRequired

post

/v1/auth/users/resend_activation/

POST /v1/auth/users/resend_activation/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "email": "[email protected]"
}

200Success

{
  "email": "[email protected]"
}

post

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Body

emailstring · email · min: 1Required

Responses

200Success

application/json

emailstring · emailRequired

post

/v1/auth/users/reset_password/

POST /v1/auth/users/reset_password/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "email": "[email protected]"
}

200Success

{
  "email": "[email protected]"
}

post

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Body

uidstring · min: 1Required

tokenstring · min: 1Required

new_passwordstring · min: 1Required

re_new_passwordstring · min: 1Required

Responses

200Success

application/json

uidstringRequired

tokenstringRequired

new_passwordstringRequired

re_new_passwordstringRequired

post

/v1/auth/users/reset_password_confirm/

POST /v1/auth/users/reset_password_confirm/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "uid": "text",
  "token": "text",
  "new_password": "text",
  "re_new_password": "text"
}

200Success

{
  "uid": "text",
  "token": "text",
  "new_password": "text",
  "re_new_password": "text"
}

post

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Body

emailstring · email · min: 1Required

Responses

200Success

application/json

emailstring · emailRequired

post

/v1/auth/users/reset_username/

POST /v1/auth/users/reset_username/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "email": "[email protected]"
}

200Success

{
  "email": "[email protected]"
}

post

Authorizations

AuthorizationstringOptional

Token-based authentication with required prefix "Token"

Body

new_usernamestring · min: 1 · max: 150Required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Pattern: ^[\w.@+-]+$

Responses

200Success

application/json

new_usernamestring · max: 150Required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Pattern: ^[\w.@+-]+$

post

/v1/auth/users/reset_username_confirm/

POST /v1/auth/users/reset_username_confirm/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "new_username": "text"
}

200Success

{
  "new_username": "text"
}

post

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

new_passwordstring · min: 1Required

re_new_passwordstring · min: 1Required

current_passwordstring · min: 1Required

Responses

200Success

application/json

new_passwordstringRequired

re_new_passwordstringRequired

current_passwordstringRequired

post

/v1/auth/users/set_password/

POST /v1/auth/users/set_password/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "new_password": "text",
  "re_new_password": "text",
  "current_password": "text"
}

200Success

{
  "new_password": "text",
  "re_new_password": "text",
  "current_password": "text"
}

post

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

current_passwordstring · min: 1Required

new_usernamestring · min: 1 · max: 150Required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Pattern: ^[\w.@+-]+$

Responses

200Success

application/json

current_passwordstringRequired

new_usernamestring · max: 150Required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Pattern: ^[\w.@+-]+$

post

/v1/auth/users/set_username/

POST /v1/auth/users/set_username/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "current_password": "text",
  "new_username": "text"
}

200Success

{
  "current_password": "text",
  "new_username": "text"
}

PreviousIntroduction NextConfig

Last updated 37 minutes ago