mATRIC API (1.0.0)

mATRIC API for managing users, agents, and third-party apps.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License MIT
Languages
Servers
Mock server
https://matric-docs.redocly.app/_mock/openapi/
https://matric-docs.redocly.app/

token

Operations

users

Operations

Create First User

Request

Bodyapplication/jsonrequired
usernameany(email)(Username)required
passwordany(Password)required
rolesArray of any(Roles)required
curl -i -X POST \
  https://matric-docs.redocly.app/_mock/openapi/users/public \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "username": null,
    "password": null,
    "roles": [
      null
    ]
  }'

Responses

Successful Response

Bodyapplication/json
usernameUsername (any) or Username (any)(Username)
Any of:
any(Username)
rolesany(Roles)required
scopesArray of any(Scopes)
Default []
Response
application/json
{
  "username": {},
  "roles": null,
  "scopes": []
}

List Users

Request

curl -i -X GET \
  https://matric-docs.redocly.app/_mock/openapi/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/jsonArray [
usernameUsername (any) or Username (any)(Username)
Any of:
any(Username)
rolesany(Roles)required
scopesArray of any(Scopes)
Default []
]
Response
application/json
[
  {
    "username": {},
    "roles": null,
    "scopes": []
  }
]

Create User

Request

Bodyapplication/jsonrequired
usernameany(email)(Username)required
passwordany(Password)required
rolesArray of any(Roles)required
curl -i -X POST \
  https://matric-docs.redocly.app/_mock/openapi/users \
  -H 'Content-Type: application/json' \
  -d '{
    "username": null,
    "password": null,
    "roles": [
      null
    ]
  }'

Responses

Successful Response

Bodyapplication/json
usernameUsername (any) or Username (any)(Username)
Any of:
any(Username)
rolesany(Roles)required
scopesArray of any(Scopes)
Default []
Response
application/json
{
  "username": {},
  "roles": null,
  "scopes": []
}

Get User

Request

Path
usernameany(Username)required
curl -i -X GET \
  'https://matric-docs.redocly.app/_mock/openapi/users/{username}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
usernameUsername (any) or Username (any)(Username)
Any of:
any(Username)
rolesany(Roles)required
scopesArray of any(Scopes)
Default []
Response
application/json
{
  "username": {},
  "roles": null,
  "scopes": []
}

Update User

Request

Path
usernameany(Username)required
Bodyapplication/jsonrequired
passwordPassword (any) or Password (any)(Password)
Any of:
any(Password)
rolesArray of Roles (any) or Roles (any)(Roles)
Any of:
curl -i -X PUT \
  'https://matric-docs.redocly.app/_mock/openapi/users/{username}' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": {},
    "roles": [
      null
    ]
  }'

Responses

Successful Response

Bodyapplication/json
usernameUsername (any) or Username (any)(Username)
Any of:
any(Username)
rolesany(Roles)required
scopesArray of any(Scopes)
Default []
Response
application/json
{
  "username": {},
  "roles": null,
  "scopes": []
}

Delete User

Request

Path
usernameany(Username)required
curl -i -X DELETE \
  'https://matric-docs.redocly.app/_mock/openapi/users/{username}'

Responses

Successful Response

Bodyapplication/json
any(Response Delete User Users Username Delete)
Response
application/json
null

Read Users Me

Request

curl -i -X GET \
  https://matric-docs.redocly.app/_mock/openapi/users/me

Responses

Successful Response

Bodyapplication/json
usernameUsername (any) or Username (any)(Username)
Any of:
any(Username)
rolesany(Roles)required
scopesArray of any(Scopes)
Default []
Response
application/json
{
  "username": {},
  "roles": null,
  "scopes": []
}

agents

Operations

third_party_apps

Operations

agent_update

Operations

agent_details

Operations

agent_data

Operations

send_command

Operations

agent_data_callback

Operations

agent_details_callback

Operations