Portal

Create, edit, and delete users.

You need to provide authentication parameters for all queries. To learn more, see API Introduction.

Get all users

Code samples

curl -X GET {server}/api/v1/users \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic {access-token}'

GET /api/v1/users

Get all users

Example responses

200 Response

{
  "value": [
    {
      "username": "string",
      "admin": true
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully received users	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» value	[object]	false	none	none
»» username	string	false	none	none
»» admin	boolean	false	none	none

Get an user

Code samples

curl -X GET {server}/api/v1/users/{user} \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic {access-token}'

GET /api/v1/users/{user}

Get an user specified by the user

Parameters

Name	In	Type	Required	Description
user	path	string	true	Username

Example responses

200 Response

{
  "username": "string",
  "admin": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully received an user	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» username	string	false	none	none
» admin	boolean	false	none	none

Create an user

Code samples

curl -X PUT {server}/api/v1/users/{user} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic {access-token}'

PUT /api/v1/users/{user}

Create an user specified by the user

Body parameter

{
  "value": {
    "password": "stringst"
  }
}

Parameters

Name	In	Type	Required	Description
user	path	string	true	Username
body	body	object	true	none
» value	body	object	false	none
»» password	body	string	false	none

Example responses

201 Response

{
  "value": {
    "username": "string",
    "admin": true
  }
}

400 Response

"Key: 'UserPasswordRequest.Value.Password' Error:Field validation for 'Password' failed on the 'required' tag"

Responses

Status	Meaning	Description	Schema
201	Created	Successfully created an user	Inline
400	Bad Request	Password issue	string
409	Conflict	Username already existed	string

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
» value	object	false	none	none
»» username	string	false	none	none
»» admin	boolean	false	none	none

Delete an user

Code samples

curl -X DELETE {server}/api/v1/users/{user} \
  -H 'Authorization: Basic {access-token}'

DELETE /api/v1/users/{user}

Delete an user specified by the user

Parameters

Name	In	Type	Required	Description
user	path	string	true	Username

Responses

Status	Meaning	Description	Schema
204	No Content	Successfully deleted an user	None

Update a password user

Code samples

curl -X PATCH {server}/api/v1/users/{user} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic {access-token}'

PATCH /api/v1/users/{user}

Update a password user specified by the user

Body parameter

{
  "value": {
    "current_password": "string",
    "password": "stringst"
  }
}

Parameters

Name	In	Type	Required	Description
user	path	string	true	Username
body	body	object	false	none
» value	body	object	false	none
»» current_password	body	string	false	none
»» password	body	string	false	none

Example responses

200 Response

{
  "value": {
    "username": "string",
    "admin": true
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Password updated	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» value	object	false	none	none
»» username	string	false	none	none
»» admin	boolean	false	none	none