User

CreateUserCartEntry

POST https://api.opentact.org/rest/user/cart

Create user cart entry

Headers

Name
Type
Description

X-Auth-Token

string

JWT

Content-Type

string

application/json

Request Body

Name
Type
Description

payload

object

any

ttl

integer

<int32> >= 60 Time to live (in seconds)

GetCartEntries

GET https://api.opentact.org/rest/user/cart

Get all user cart entry

Headers

Name
Type
Description

X-Auth-Token

string

JWT

Content-Type

string

application/json

ClearUserCart

DELETE https://api.opentact.org/rest/user/cart

Clear user cart

Headers

Name
Type
Description

X-Auth-Token

string

JWT

Content-Type

string

application/json

DeleteUserCartEntry

DELETE https://api.opentact.org/rest/user/cart/{uuid}

Delete user cart entry

Headers

Name
Type
Description

X-Auth-Token

string

JWT

Content-Type

string

application/json

Request Body

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

UpdateUserCartEntry

PATCH https://api.opentact.org/rest/user/cart/{uuid}

Change user cart entry

Headers

Name
Type
Description

X-Auth-Token

string

JWT

Content-Type

string

application/json

Request Body

Name
Type
Description

payload

object

any

ttl

string

<int32> >= 60 Time to live (in seconds)

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

CreateUser

POST https://api.opentact.org/rest/user

Create new user

Headers

Name
Type
Description

Content-Type

string

application/json

Request Body

Name
Type
Description

account

object

(IAccountNewParams)

role

string

(EUserRole) Enum: "Admin" "User" "Provider"

avatar

string

[ 10 .. 255 ] characters

dob

string

<date-time>

password

string

[ 3 .. 255 ] characters

first_name

string

[ 1 .. 24 ] characters

last_name

string

[ 1 .. 24 ] characters

email

string

[ 5 .. 80 ] characters

phone_number

number

[ 3 .. 16 ]

gender

string

Enum: "Agender" "Androgyne" "Androgynous" "Bigender" "Cis" "Cisgender" "Cis Female" "Cis Male" "Cis Man" "Cis Woman" "Cisgender Female" "Cisgender Male" "Cisgender Man" "Cisgender Woman" "Female to Male" "FTM" "Gender Fluid" "Gender Nonconforming" "Gender Questioning" "Gender Variant" "Genderqueer" "Intersex" "Male to Female" "MTF" "Neither" "Neutrois" "Non-binary" "Other" "Pangender" "Trans" "Trans Female" "Trans Male" "Trans Man" "Trans Person" "Trans Woman" "Transfeminine" "Transgender" "Transgender Female" "Transgender Male" "Transgender Man" "Transgender Person" "Transgender Woman" "Transmasculine" "Transsexual" "Transsexual Female" "Transsexual Male" "Transsexual Man" "Transsexual Person" "Transsexual Woman" "Two-Spirit"

GetCurrentUser

GET https://api.opentact.org/user

Get detail information of a user

Headers

Name
Type
Description

Authorization

string

JWT or Bearer

RequestUserPasswordResetEmail

GET https://api.opentact.org/user/password_reset

Request password request email

Request Body

Name
Type
Description

email

string

[ 5 .. 255 ] characters

callback

string

[ 10 .. 255 ] characters Example: callback=http://google.com/search?query={token} Password reset callback url. {token} string will be replaced with reset token. By default used api portal ui callback.

ChangeUserPasswordViaResetToken

POST https://api.opentact.org/rest/user/password_reset

Change password using reset token

Headers

Name
Type
Description

Content-Type

string

application

Request Body

Name
Type
Description

token

string

48 characters

password

string

[ 3 .. 255 ] characters

GetUserByUUID

GET https://api.opentact.org/rest/user/{uuid}

Get detail information of a user by UUID

Headers

Name
Type
Description

X-Auth-Token

string

JWT

Request Body

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

DeleteUserByUUID

DELETE https://api.opentact.org/rest/user/{uuid}

Get detail information of a user by UUID

Headers

Name
Type
Description

X-Auth-Token

string

JWT

Request Body

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

UpdateUserByUUID

PATCH https://api.opentact.org/rest/user/{uuid}

Change user information by UUID

Path Parameters

Name
Type
Description

uuid

string

uth^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Headers

Name
Type
Description

Content-Type

string

application/json

X-Auth-Token

string

JWT

Request Body

Name
Type
Description

account

object

(IAccountNewParams)

role

string

(EUserRole) Enum: "Admin" "User" "Provider"

avatar

string

[ 10 .. 255 ] characters

dob

string

<date-time>

password

string

[ 3 .. 255 ] characters

first_name

string

[ 1 .. 24 ] characters

last_name

string

[ 1 .. 24 ] characters

email

string

[ 5 .. 80 ] characters

phone_number

number

[ 3 .. 16 ]

gender

string

Enum: "Agender" "Androgyne" "Androgynous" "Bigender" "Cis" "Cisgender" "Cis Female" "Cis Male" "Cis Man" "Cis Woman" "Cisgender Female" "Cisgender Male" "Cisgender Man" "Cisgender Woman" "Female to Male" "FTM" "Gender Fluid" "Gender Nonconforming" "Gender Questioning" "Gender Variant" "Genderqueer" "Intersex" "Male to Female" "MTF" "Neither" "Neutrois" "Non-binary" "Other" "Pangender" "Trans" "Trans Female" "Trans Male" "Trans Man" "Trans Person" "Trans Woman" "Transfeminine" "Transgender" "Transgender Female" "Transgender Male" "Transgender Man" "Transgender Person" "Transgender Woman" "Transmasculine" "Transsexual" "Transsexual Female" "Transsexual Male" "Transsexual Man" "Transsexual Person" "Transsexual Woman" "Two-Spirit"

UploadAvatar

POST https://api.opentact.org/rest/user/{uuid}/avatar

Upload user avatar

Path Parameters

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Headers

Name
Type
Description

X-Auth-Token

string

JWT

RemoveAvatar

DELETE https://api.opentact.org/rest/user/{uuid}/avatar

Delete user avatar

Path Parameters

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Headers

Name
Type
Description

X-Auth-Token

string

JWT

PreviousAccountNextProfile

Last updated

Was this helpful?