HoxtonAi
Powered by Redocly

Users

APIs to manage an Organisation's users.

Create/Update user

Create/Update an user.

Securityo_auth
Request
Request Body schema: application/json
required

A user to update.

email
required
string <email>
firstName
required
string
id
string or null
lastName
required
string
name
string
organisationId
required
string <uuid>
organisationName
string or null
roles
Array of strings
Items Enum: "member" "admin" "support"
siteIds
Array of strings <uuid>

A list of IDs of the sites to user visibility.

Responses
201

OK.

204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

404

Not found.

422

Unprocessable entity.

500

Failed.

put/users
Request samples
application/json
{
  • "email": "user@example.com",
  • "firstName": "string",
  • "id": "string",
  • "lastName": "string",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "organisationName": "string",
  • "roles": [
    ],
  • "siteIds": [
    ]
}
Response samples
application/json
{
  • "email": "user@example.com",
  • "firstName": "string",
  • "id": "string",
  • "lastName": "string",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "organisationName": "string",
  • "roles": [
    ],
  • "siteIds": [
    ]
}

Delete user

Remove an user.

Securityo_auth
Request
path Parameters
userId
required
string

The ID of the user to be deleted.

Responses
204

OK.

401

Authentication failed.

403

Not allowed.

404

Not found.

500

Failed.

delete/users/{userId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get my profile
Returns the profile data of the caller.


Securityo_auth 
Responses 
200
OK.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


get/users/me
Request samples 
Response samples 
application/json
{
  • "email": "user@example.com",
  • "firstName": "string",
  • "id": "string",
  • "lastName": "string",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "organisationName": "string",
  • "roles": [
    ],
  • "siteIds": [
    ]
}
Get user
Get details of the user given by the ID.


Securityo_auth 
Request 
path Parameters
userId
required
string
The ID of the user to be returned.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


500
Failed.


get/users/{userId}
Request samples 
Response samples 
application/json
{
  • "email": "user@example.com",
  • "firstName": "string",
  • "id": "string",
  • "lastName": "string",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "organisationName": "string",
  • "roles": [
    ],
  • "siteIds": [
    ]
}
List users
Fetch the list of users associated with an organisation or site.


Securityo_auth 
Request 
query Parameters
organisationId
string <uuid> 
The ID of an organisation.


 
siteId
string <uuid> 
The ID of a site.


 
Responses 
200
OK.


400
Bad request.


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


get/users
Request samples 
Response samples 
application/json
[
  • {
    }
]