Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Qualio

Qualio User Management API

The User Management API from Qualio — 7 operation(s) for user management.

Documentation Provider Profile APIs.io OpenAPI GitHub

Qualio User Management API is one of 11 APIs that Qualio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 17 operations across 7 paths, and defines 19 schemas. It is described by OpenAPI 3.1.0, at version 0.1.

Requests are made against a single base URL, https://api.qualio.com.

17 operations 7 paths 19 schemas 2 DELETE5 GET7 OPTIONS1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1
Base URL
https://api.qualio.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Qualio User Management API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (api_key). By default, every request must be authenticated.

Paths & Operations 17

Across 7 paths, the API surfaces 17 operations — 2 DELETE, 5 GET, 7 OPTIONS, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

User Management 17
POST
/v1/user-management/invite
Invite a user
inviteUser body → 200400403429
OPTIONS
/v1/user-management/invite
Invites a user to your Qualio instance. This will generate an email for them to accept the invite, whereupon they will be asked to set their name and password, etc
inviteUserOptions → 200
GET
/v1/user-management/users
List users
listUsers → 200403429
OPTIONS
/v1/user-management/users
Retrieves all users in your Qualio instance, including each user's id, email, full name, role (quality, normal, or basic), admin flag, and invite status (pending, accepted, declined, canceled). Use t…
listUsersOptions → 200
GET
/v1/user-management/user/{userId}
Retrieve a user
getUser 1 param → 200400403404429
OPTIONS
/v1/user-management/user/{userId}
Retrieves a single user by id, including email, full name, role (quality, normal, or basic), admin flag, and invite status.
getUserOptions 1 param → 200
DELETE
/v1/user-management/user/{userId}
Remove a user
deleteUser 1 param → 200400403404429
PUT
/v1/user-management/user/{userId}/assignments
Reassign user's assignments
reassignUserAssignments 1 param body → 200400403404429
OPTIONS
/v1/user-management/user/{userId}/assignments
Reassigns all entities associated with a user to a new owner. Works for a variety of entities including documents, events, tasks, etc. Requires admin permissions
reassignUserAssignmentsOptions 1 param → 200
GET
/v1/user-management/user/{userId}/assignments
List user's assignments
listUserAssignments 1 param → 200400403404429
GET
/v1/user-management/groups
List groups
listGroups → 200403429
OPTIONS
/v1/user-management/groups
Lists the user groups defined in your Qualio instance, returning each group's id and name. Groups are named collections of users used to organise people (e.g. by team or function) and to assign or fi…
listGroupsOptions → 200
PUT
/v1/user-management/groups/{groupId}/user/{userId}
Add user to group
addUserToGroup 2 params → 200400403404429
OPTIONS
/v1/user-management/groups/{groupId}/user/{userId}
Adds a user to a group within your Qualio instance. Requires admin permissions
addUserToGroupOptions 2 params → 200
DELETE
/v1/user-management/groups/{groupId}/user/{userId}
Remove user from group
removeUserFromGroup 2 params → 200400403404429
GET
/v1/user-management/user/me
Retrieve the current user's id and name
getCurrentUser → 200403429
OPTIONS
/v1/user-management/user/me
Retrieves the currently logged in user's id and name.
getCurrentUserOptions → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are userAssignmentMapping (9 properties), user (6 properties), invite (4 properties), userHasAssignmentsError (3 properties). Each schema is shown below with its type and property counts.

generic404
A generic response when a resource can't be found
me
object
Retrieve the current user's id and name
2 properties 2 required
userHasAssignmentsError
object
A message indicating the user has assignments remaining that must be reassigned before removal
3 properties 3 required
reassignmentResponse
object
A response confirming the reassignment was successful
1 property 1 required
groupList
object
An array of groups within your Qualio instance
2 properties 2 required
userAssignmentMapping
object
A response containing all entity assignments for a specific user
9 properties
userGroupRemoveResp
object
A message confirming the user group removal was successful
1 property 1 required
userGroupResp
object
A message confirming the user group addition was successful
1 property 1 required
deleteUserResp
object
A message indicating the user has been removed
1 property 1 required
throttledResponse
object
1 property 1 required
userList
object
An array of Qualio users
2 properties 2 required
genericForbiddenResponse
object
1 property 1 required
genericBadRequest400PathResponse
object
2 properties 2 required
groupId
number
A unique identifier for a group in Qualio
reassignmentRequest
object
A request to reassign all entities from one user to another
2 properties 2 required
invite
object
An invite for a user to join your Qualio instance
4 properties 2 required
user
object
A Qualio user
6 properties 6 required
genericBadRequestResponse
object
2 properties 2 required
userId
number
A unique identifier for a user in Qualio

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qualio-user-management-api-openapi.yml Raw ↑

Other APIs Qualio publishes across the network.

Qualio Audit Trail API
AE Profile APIs.io
Qualio Change Management API
AE Profile APIs.io
Qualio Compliance Intelligence API
AE Profile APIs.io
Qualio Design Controls API
AE Profile APIs.io
Qualio Documents API
AE Profile APIs.io
Qualio Events API
AE Profile APIs.io
Qualio Resource Library API
AE Profile APIs.io
Qualio Suppliers API
AE Profile APIs.io
Qualio Tags API
AE Profile APIs.io
Qualio Training API
AE Profile APIs.io
#User Management
← Back to Q APIs
API Details
ID
qualio:qualio-user-management-api
Base URL
https://api.qualio.com
Docs
https://developer-portal.qualio.com/
Provider
Qualio
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network