user

POST file

POST /user/{id}/file

Body Parameters

avatar: string

Params

Name	Location	Type	Required	Description
id	path	string	yes	none
Content-Type	header	string	yes	none
body	body	object	no	none
» avatar	body	string(binary)	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET show

GET /user/{id}

Params

Name	Location	Type	Required	Description
id	path	string	yes	none

Response Examples

200 Response

{
  "avatar": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "2019-08-24T14:15:22Z",
  "email": "string",
  "emailVisibility": true,
  "id": "string",
  "token": "string",
  "updated": "2019-08-24T14:15:22Z",
  "username": "string",
  "verified": true
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	OK	Inline
404	Not Found	Record Not Found	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	description
» avatar	string	true	none	none
» collectionId	string	true	none	none
» collectionName	string	true	none	none
» created	string(date-time)	true	none	none
» email	string	true	none	none
» emailVisibility	boolean	true	none	none
» id	string	true	none	none
» token	string	true	none	none
» updated	string(date-time)	true	none	none
» username	string	true	none	none
» verified	boolean	true	none	none

HTTP Status Code 404

Name	Type	Required	Restrictions	description
» url	string	true	none	none
» status	integer	true	none	none
» response	object	true	none	none
»» code	integer	true	none	none
»» message	string	true	none	none
»» data	object	true	none	none
» isAbort	boolean	true	none	none
» originalError	object	true	none	none
»» url	string	true	none	none
»» status	integer	true	none	none
»» data	object	true	none	none
»»» code	integer	true	none	none
»»» message	string	true	none	none
»»» data	object	true	none	none
» name	string	true	none	none

POST update

POST /user/{id}

Body Parameters

{}

Params

Name	Location	Type	Required	Description
id	path	string	yes	none
Content-Type	header	string	yes	none
body	body	object	no	none

Response Examples

200 Response

{
  "avatar": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "2019-08-24T14:15:22Z",
  "email": "string",
  "emailVisibility": true,
  "id": "string",
  "token": "string",
  "updated": "2019-08-24T14:15:22Z",
  "username": "string",
  "verified": true
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	OK	Inline
404	Not Found	Record Not Found	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	description
» avatar	string	true	none	none
» collectionId	string	true	none	none
» collectionName	string	true	none	none
» created	string(date-time)	true	none	none
» email	string	true	none	none
» emailVisibility	boolean	true	none	none
» id	string	true	none	none
» token	string	true	none	none
» updated	string(date-time)	true	none	none
» username	string	true	none	none
» verified	boolean	true	none	none

HTTP Status Code 404

Name	Type	Required	Restrictions	description
» url	string	true	none	none
» status	integer	true	none	none
» response	object	true	none	none
»» code	integer	true	none	none
»» message	string	true	none	none
»» data	object	true	none	none
» isAbort	boolean	true	none	none
» originalError	object	true	none	none
»» url	string	true	none	none
»» status	integer	true	none	none
»» data	object	true	none	none
»»» code	integer	true	none	none
»»» message	string	true	none	none
»»» data	object	true	none	none
» name	string	true	none	none

DELETE delete

DELETE /user/{id}

Params

Name	Location	Type	Required	Description
id	path	string	yes	none

Response Examples

200 Response

{
  "acknowledged": true
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	OK	Inline
404	Not Found	Record Not Found	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» acknowledged	boolean	true	none		none

HTTP Status Code 404

Name	Type	Required	Restrictions	description
» url	string	true	none	none
» status	integer	true	none	none
» response	object	true	none	none
»» code	integer	true	none	none
»» message	string	true	none	none
»» data	object	true	none	none
» isAbort	boolean	true	none	none
» originalError	object	true	none	none
»» url	string	true	none	none
»» status	integer	true	none	none
»» data	object	true	none	none
»»» code	integer	true	none	none
»»» message	string	true	none	none
»»» data	object	true	none	none
» name	string	true	none	none

PUT create

PUT /user

Body Parameters

{
  "username": "string",
  "password": "string",
  "passwordConfirm": "string",
  "email": "string"
}

Params

Name	Location	Type	Required	Description
body	body	object	no	none
» username	body	string	yes	none
» password	body	string	yes	none
» passwordConfirm	body	string	yes	none
» email	body	string	yes	none

Response Examples

200 Response

{
  "avatar": "string",
  "collectionId": "string",
  "collectionName": "string",
  "created": "2019-08-24T14:15:22Z",
  "emailVisibility": true,
  "id": "string",
  "token": "string",
  "updated": "2019-08-24T14:15:22Z",
  "username": "string",
  "verified": true
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	description
» avatar	string	true	none	none
» collectionId	string	true	none	none
» collectionName	string	true	none	none
» created	string(date-time)	true	none	none
» emailVisibility	boolean	true	none	none
» id	string	true	none	none
» token	string	true	none	none
» updated	string(date-time)	true	none	none
» username	string	true	none	none
» verified	boolean	true	none	none

HTTP Status Code 400

Name	Type	Required	Restrictions	description
» url	string	true	none	none
» status	integer	true	none	none
» response	object	true	none	none
»» code	integer	true	none	none
»» message	string	true	none	none
»» data	object	true	none	none
»»» passwordConfirm	object	true	none	none
»»»» code	string	true	none	none
»»»» message	string	true	none	none
»»» username	object	true	none	none
»»»» code	string	true	none	none
»»»» message	string	true	none	none
» isAbort	boolean	true	none	none
» originalError	object	true	none	none
»» url	string	true	none	none
»» status	integer	true	none	none
»» data	object	true	none	none
»»» code	integer	true	none	none
»»» message	string	true	none	none
»»» data	object	true	none	none
»»»» passwordConfirm	object	true	none	none
»»»»» code	string	true	none	none
»»»»» message	string	true	none	none
»»»» username	object	true	none	none
»»»»» code	string	true	none	none
»»»»» message	string	true	none	none
» name	string	true	none	none