Skip to main content

User Registration and Validation API

Component Hierarchy / Directory

Study Buddies - User Registration (0.0.1)

Download OpenAPI specification:Download

User Registration, LogIn, and LogOut Endpoints

register

createCustomUser

Request Body schema:
any

Responses

Request samples

Content type
null

Response samples

Content type
application/json
null

api

createTokenObtainPair

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

Request Body schema:
email
required
string
password
required
string

Responses

Request samples

Content type
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "email": "string"
}

createCustomUser

Request Body schema:
any

Responses

Request samples

Content type
null

Response samples

Content type
application/json
null

createTokenRefresh

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

Request Body schema:
refresh
required
string

Responses

Request samples

Content type
{
  • "refresh": "string"
}

Response samples

Content type
application/json
{
  • "refresh": "string",
  • "access": "string"
}

createTokenVerify

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

Request Body schema:
token
required
string

Responses

Request samples

Content type
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}