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

Quinyx Role Assignment API

The Role Assignment API from Quinyx — 2 operation(s) for role assignment.

Quinyx Role Assignment API is one of 35 APIs that Quinyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Role Assignment. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 2 base URLs: https://api.quinyx.com, https://api-rc.quinyx.com.

4 operations 2 paths 8 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.eu.quinyx.com
Authentication
OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Quinyx Role Assignment API declares 7 security schemes for authenticating requests. It supports OAuth 2.0 (employee_OAuth2ClientCredentials) using the clientCredentials flow, exposing 4 scopes. It supports OAuth 2.0 (opening-hours_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (organisation_OAuth2ClientCredentials) using the clientCredentials flow, exposing 4 scopes. It supports OAuth 2.0 (rest-api-uaa_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (schedule-availability_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (schedule_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (statistics_OAuth2ClientCredentials) using the clientCredentials flow.

  • employee_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • opening-hours_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • organisation_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • rest-api-uaa_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • schedule-availability_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • schedule_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • statistics_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Role Assignment 4
GET
/hr/v3/role-assignments
List role assignments
listRoleAssignments 10 params → 200400401403500
POST
/hr/v3/role-assignments
Create a role assignment
createRoleAssignment body → 201400401403404500
DELETE
/hr/v3/role-assignments/{id}
Delete a role assignment
deleteRoleAssignment 1 param → 204401403404500
PATCH
/hr/v3/role-assignments/{id}
Update a role assignment
updateRoleAssignment 1 param body → 200400401403404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are security_RoleAssignmentResponse (8 properties), security_ProblemDetail (5 properties), security_RoleAssignmentRequest (5 properties), security_ValidationError (5 properties). Each schema is shown below with its type and property counts.

security_RoleAssignmentUpdateRequest
object
Request to update a role assignment
2 properties
security_ValidationErrorDetail
object
A single validation error.
2 properties
security_CursorPageRoleAssignmentResponse
object
A page of data along with pagination information for cursor-based pagination.
2 properties
security_RoleAssignmentResponse
object
Represents a role assignment
8 properties
security_RoleAssignmentRequest
object
Request body for creating a role assignment
5 properties 3 required
security_ProblemDetail
object
RFC 9457 Problem Details for HTTP APIs
5 properties 3 required
security_CursorPaginationInfo
object
Pagination information for cursor-based pagination.
2 properties
security_ValidationError
object
Validation errors, conforming to RFC 9457.
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quinyx-role-assignment-api-openapi.yml Raw ↑

Other APIs Quinyx publishes across the network.

Quinyx Absence Schedules API
Quinyx Absence Types API
Quinyx Absences API
Quinyx Access Token API
Quinyx Agreements API
Quinyx AI Scheduled Headcount API
Quinyx Authentication API
Quinyx Collaboration Groups API
Quinyx Collaboration Groups Labels API
Quinyx Employee API
Quinyx Employees API
Quinyx Forecast Data API