IXON MyCompany API
The MyCompany API from IXON — 1 operation(s) for mycompany.
OpenAPI Specification
openapi: 3.0.2
info:
contact:
name: IXON B.V.
url: https://www.ixon.cloud/
email: support@ixon.cloud
description: API for the IXON Cloud Platform
license:
name: All Rights Reserved
url: https://www.ixon.cloud/
title: IXON AccessRecoverList MyCompany API
version: 0.1.294
servers:
- description: IXON Cloud platform server
url: https://portal.ixon.cloud:443/api/
tags:
- name: MyCompany
paths:
/companies/me:
get:
tags:
- MyCompany
summary: MyCompany
responses:
'200':
description: Success response
content:
application/json:
schema:
type: object
required:
- status
- type
- data
properties:
status:
type: string
default: success
nullable: false
type:
type: string
nullable: false
data:
nullable: false
type: object
properties:
publicId:
maxLength: 24
minLength: 24
nullable: false
pattern: (\d{4}-){4}\d{4}
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
country:
maxLength: 2
minLength: 2
nullable: false
type: string
defaultUserInviteLanguage:
maxLength: 2
minLength: 2
nullable: false
type: string
supportAccessExpiresOn:
nullable: true
type: string
format: date-time
appOwnerName:
maxLength: 255
minLength: 0
nullable: true
type: string
custom:
nullable: false
type: object
branding:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 0
nullable: true
type: string
fqdn:
maxLength: 253
minLength: 4
nullable: true
pattern: .+(\..[^.]+)
type: string
theme:
nullable: true
type: object
properties:
primaryColor:
maxLength: 7
minLength: 6
nullable: false
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
primaryTextColor:
maxLength: 7
minLength: 6
nullable: false
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
accentColor:
maxLength: 7
minLength: 6
nullable: true
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
accentTextColor:
maxLength: 7
minLength: 6
nullable: true
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
headerColor:
maxLength: 7
minLength: 6
nullable: true
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
headerLineColor:
maxLength: 7
minLength: 6
nullable: true
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
menuColor:
maxLength: 7
minLength: 6
nullable: true
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
menuTextColor:
maxLength: 7
minLength: 6
nullable: true
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
pageColor:
maxLength: 7
minLength: 6
nullable: true
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
pageTextColor:
maxLength: 7
minLength: 6
nullable: true
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
cardColor:
maxLength: 7
minLength: 6
nullable: true
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
cardTextColor:
maxLength: 7
minLength: 6
nullable: true
pattern: '#?[a-fA-F0-9]{6,6}'
type: string
logoHasBackgroundColor:
nullable: false
type: boolean
logoOnHeaderColorSpec:
maxLength: 255
minLength: 1
nullable: true
type: string
appleTouchIcon:
maxLength: 255
minLength: 0
nullable: true
type: string
favicon:
maxLength: 255
minLength: 0
nullable: true
type: string
logo:
maxLength: 255
minLength: 0
nullable: true
type: string
logoDark:
maxLength: 255
minLength: 0
nullable: true
type: string
appleAppStoreLink:
maxLength: 255
minLength: 0
nullable: true
type: string
googlePlayStoreLink:
maxLength: 255
minLength: 0
nullable: true
type: string
landingPageComponentTemplate:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
company:
nullable: true
type: object
properties:
publicId:
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
description:
maxLength: 255
minLength: 1
nullable: true
type: string
version:
maxLength: 255
minLength: 1
nullable: true
type: string
author:
maxLength: 255
minLength: 1
nullable: true
type: string
licence:
maxLength: 255
minLength: 1
nullable: true
type: string
url:
maxLength: 255
minLength: 0
nullable: true
type: string
sheetSettings:
nullable: true
type: object
properties:
minCols:
maximum: 11
minimum: 1
nullable: false
type: integer
format: int32
defaultCols:
maximum: 11
minimum: 1
nullable: true
type: integer
format: int32
maxCols:
maximum: 11
minimum: 1
nullable: true
type: integer
format: int32
minRows:
maximum: 11
minimum: 1
nullable: false
type: integer
format: int32
defaultRows:
maximum: 11
minimum: 1
nullable: true
type: integer
format: int32
maxRows:
maximum: 11
minimum: 1
nullable: true
type: integer
format: int32
cardSettings:
nullable: true
type: object
properties:
minHeight:
maximum: 65535
minimum: 1
nullable: false
type: integer
format: int32
defaultHeight:
maximum: 65535
minimum: 1
nullable: true
type: integer
format: int32
maxHeight:
maximum: 65535
minimum: 1
nullable: true
type: integer
format: int32
inputs:
maxLength: 65535
minLength: 0
nullable: true
type: string
draft:
nullable: true
type: object
properties:
publicId:
nullable: false
type: string
published:
nullable: true
type: object
properties:
publicId:
nullable: false
type: string
category:
nullable: false
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
order:
maximum: 65535
nullable: false
type: integer
format: int32
configuredVersion:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
number:
maxLength: 64
minLength: 1
nullable: false
pattern: \d+
type: string
mainPath:
maxLength: 255
minLength: 4
nullable: false
type: string
backendComponent:
nullable: true
type: object
properties:
publicId:
nullable: false
type: string
static:
nullable: false
type: boolean
intent:
type: array
items:
enum:
- asset-configuration
- landing-page
- main-page
nullable: false
type: string
private:
nullable: false
type: boolean
custom:
nullable: false
type: object
screensaver:
nullable: true
type: object
properties:
publicId:
nullable: false
type: string
requireDedicatedRscServer:
nullable: false
type: boolean
requireDedicatedMdrServer:
nullable: false
type: boolean
loggingTrialUsed:
nullable: false
type: boolean
alarmingTrialUsed:
nullable: false
type: boolean
premiumLicence:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
type:
nullable: false
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
usageType:
enum:
- advanced-user-management
- agent-registration-profile
- agent-templates
- alarming
- api-integrations
- app-engine-level-1
- app-engine-level-2
- app-engine-level-3
- asset-management
- card-view
- connection-monitoring
- controlled-devices
- custom-branding
- custom-domain
- custom-fields
- custom-legal
- custom-legal-legacy
- custom-sso
- edge-app-management
- ixagent
- landing-page
- live-data
- logging
- m2m-cloud-cluster
- main-pages
- mobile-app
- mqtt-device
- object-storage
- premium-branding
- rdp
- remote-access
- reporting
- request-access
- rtsp
- scim
- session-recording
- sla
- ssh
- subgroups
- temporary-access
- vpn-access-rule
- vpn-usage
nullable: false
type: string
companyLimit:
maximum: 4294967295
nullable: true
type: integer
format: int32
scope:
enum:
- agent
- company
nullable: false
type: string
serialNumber:
maxLength: 255
minLength: 1
nullable: false
type: string
expiresOn:
nullable: true
type: string
format: date-time
activated:
nullable: false
type: boolean
trial:
nullable: false
type: boolean
value:
maxLength: 255
minLength: 1
nullable: true
type: string
locked:
nullable: true
type: boolean
maxRetentionPolicy:
maxLength: 255
minLength: 2
nullable: true
type: string
bundle:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
premiumLicenceStatus:
enum:
- not-configured
- pending
- activated
nullable: true
type: string
reportingLicence:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
type:
nullable: false
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
usageType:
enum:
- advanced-user-management
- agent-registration-profile
- agent-templates
- alarming
- api-integrations
- app-engine-level-1
- app-engine-level-2
- app-engine-level-3
- asset-management
- card-view
- connection-monitoring
- controlled-devices
- custom-branding
- custom-domain
- custom-fields
- custom-legal
- custom-legal-legacy
- custom-sso
- edge-app-management
- ixagent
- landing-page
- live-data
- logging
- m2m-cloud-cluster
- main-pages
- mobile-app
- mqtt-device
- object-storage
- premium-branding
- rdp
- remote-access
- reporting
- request-access
- rtsp
- scim
- session-recording
- sla
- ssh
- subgroups
- temporary-access
- vpn-access-rule
- vpn-usage
nullable: false
type: string
companyLimit:
maximum: 4294967295
nullable: true
type: integer
format: int32
scope:
enum:
- agent
- company
nullable: false
type: string
serialNumber:
maxLength: 255
minLength: 1
nullable: false
type: string
expiresOn:
nullable: true
type: string
format: date-time
activated:
nullable: false
type: boolean
trial:
nullable: false
type: boolean
value:
maxLength: 255
minLength: 1
nullable: true
type: string
locked:
nullable: true
type: boolean
maxRetentionPolicy:
maxLength: 255
minLength: 2
nullable: true
type: string
bundle:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
name:
maxLength: 255
minLength: 1
nullable: false
type: string
slaLicence:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
type:
nullable: false
type: object
serialNumber:
maxLength: 255
minLength: 1
nullable: false
type: string
expiresOn:
nullable: true
type: string
format: date-time
activated:
nullable: false
type: boolean
trial:
nullable: false
type: boolean
value:
maxLength: 255
minLength: 1
nullable: true
type: string
locked:
nullable: true
type: boolean
maxRetentionPolicy:
maxLength: 255
minLength: 2
nullable: true
type: string
bundle:
nullable: true
type: object
vpnUsageLicence:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
type:
nullable: false
type: object
serialNumber:
maxLength: 255
minLength: 1
nullable: false
type: string
expiresOn:
nullable: true
type: string
format: date-time
activated:
nullable: false
type: boolean
trial:
nullable: false
type: boolean
value:
maxLength: 255
minLength: 1
nullable: true
type: string
locked:
nullable: true
type: boolean
maxRetentionPolicy:
maxLength: 255
minLength: 2
nullable: true
type: string
bundle:
nullable: true
type: object
vpnAccessRuleLicence:
nullable: true
type: object
properties:
publicId:
maxLength: 12
minLength: 12
nullable: false
type: string
type:
nullable: false
type: object
serialNumber:
maxLength: 255
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ixon/refs/heads/main/openapi/ixon-mycompany-api-openapi.yml