CyberQP

CyberQP Public API Documentation

The CyberQP Public API provides endpoints for managing customers, authentication (including login, token refresh, and revocation), tenant data, identity verification via self-serve notifications, event processing, and Just-In-Time (JIT) account management such as retrieving accounts, checking existence, and accessing passwords or OTPs, with an OpenAPI JSON available for integration.

CyberQP Public API Documentation

You can download the OpenAPI document and use it in your API client to interact with the API:

Customer Endpoints

  • GET /api/v1/customers

    • Get a list of customers

  • GET /api/v1/customers/{id}/accounts/count

    • Get counts of different account types for a customer by their ID

  • GET /api/v1/customers/installer

    • Download the agent installer

Auth Endpoints

  • GET /api/v1/auth/login

    • Consuming this endpoint from swagger has no effect. To generate and access an accessToken and refreshToken, add the path /api/v1/auth/login in your browser and you will be prompted to login from the CyberQP Dashboard.

  • GET /api/v1/auth/status

    • Get user status

  • POST /api/v1/auth/refresh-token

    • Refresh an OAuth2 token using a refresh token

  • POST /api/v1/auth/revoke-token

    • Revoke all tokens for a specific technician by ID

  • POST /api/v1/auth/notification-engine-token

Tenant Endpoints

  • GET /api/v1/tenants/install-token

    • Get the agent installation token

  • GET /api/v1/tenants/company-data

    • Get tenant company data

Identity Verification Endpoints

  • POST /api/v1/identity-verification/self-serve-notification
    • Trigger identity verification process through self-serve push notification (without code)

Events Endpoints

  • POST /api/v1/event
    • Process generic event

JIT (Just-In-Time) Endpoints

  • GET /api/v1/jit/customer/{customerId}

    • Get JIT accounts for a specific customer

  • GET /api/v1/jit/tenant

    • Get JIT accounts for entire tenant

  • GET /api/v1/jit/customer/{customerId}/account/check

    • Check if a JIT account exists for a given customer and directory type

  • GET /api/v1/jit/customer/{customerId}/account/{accountId}/password

    • Get password for a specific JIT account

  • GET /api/v1/jit/customer/{customerId}/account/{accountId}/otp

    • Get OTP codes for a specific JIT account

  • POST /api/v1/jit/customer/{customerId}/account/{accountId}/otp

    • Save OTP for a specific JIT account

  • DELETE /api/v1/jit/customer/{customerId}/account/{accountId}/otp

    • Delete OTP for a specific JIT account

  • PATCH /api/v1/jit/customer/{customerId}/account/{accountId}/enable

    • Enable a specific JIT account

  • PATCH /api/v1/jit/customer/{customerId}/account/{accountId}/disable

    • Disable a specific JIT account

  • DELETE /api/v1/jit/customer/{customerId}/account/{accountId}

    • Delete a specific JIT account

  • POST /api/v1/jit/customer/{customerId}/account

    • Create a JIT account for a specific customer

JIT Policies Endpoints

  • GET /api/v1/jit-policies/account
    • Get JIT policies for a specific account type

Schemas

  • CustomersList
  • TenantCustomersResponse
  • BadRequestErrorDto
  • ErrorUnauthorized
  • CustomerAccountsCountResponseContent
  • CustomerAccountsCountResponse
  • NotFoundErrorDto
  • ObjectId
  • AvailableRoles
  • TechnicianDto
  • StatusResponseDto
  • RefreshTokenRequestDto
  • RefreshTokenResponseDto
  • RevokeTokenResponseDto
  • InstallTokenRequestDto
  • InstallTokenResponseInternal
  • InstallTokenResponse
  • TenantCompanyData
  • GetTenantCompanyDataResponse
  • IdentityVerificationRequest
  • HTTPExcemptionError
  • EventRequestDto
  • GenericEventResponse
  • ForbiddenErrorDto
  • JitPolicyItem
  • JitAccountItem
  • GetJitAccountsResponse
  • CheckJitAccountResponse
  • GetJitAccountPasswordResponse
  • OtpItem
  • GetJitAccountOtpResponse
  • SaveJitAccountOtpSecretRequest
  • SaveJitAccountOtpSecretResponse
  • EnableJitAccountRequest
  • EnableJitAccountResponse
  • DisableJitAccountMetadata
  • DisableJitAccountRequest
  • DisableJitAccountResponse
  • DeleteJitAccountOtpSecretResponse
  • DeleteJitAccountResponse
  • CreateJitAccountRequest
  • CreateJitAccountResponse
  • GetJitPoliciesResponse