https://docs.au.xarios.cloud/enterprise-portal/en-gb/ Recent content in ~.Dimensions.~ Enterprise Portal on Enterprise Hugo -- gohugo.io https://docs.au.xarios.cloud/enterprise-portal/en-gb/billing/billinghistory/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/billing/billinghistory/ Billing History # Invoices and billing data for each month are available in this section of the enterprise portal. Billing entries for each period are listed with the following details: Item Description Period The date that the billing period relates to. Invoice Number The unique invoice number. Type The type of invoice; Periodic or Ad hoc Downloads Links to download the Invoice PDF and Invoice Data Example Invoice Types # There are two types of invoice that will appear in the billing history section: https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/workspaces/reports/reportsgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/workspaces/reports/reportsgetall/ Get All Reports # Gets a list of all reports configured in a specific workspace. Once a list of all reports has been retrieved, it can be execute and data retrieved using a specific reportId. GET /v1.0/workspaces/{WORKSPACE_ID}/reports Example # This request will get a list of all reports configured within the specified workspace. Request # GET <https://api.au.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports> HTTP/1.1 Authorisation: Bearer {TOKEN} tenant-id: {TENANT_ID} Response # HTTP/1. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/workspaces/workspacesgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/workspaces/workspacesgetall/ Get All Workspaces # Gets a list of all workspaces configured on your account. Once a list of all workspaces has been retrieved, report queries can be made against a specific workspace using its unique identifier. GET /v1.0/workspaces Example # This request will get a list of all workspaces configured on your ~.Dimensions.~ account. Request # GET <https://api.au.myreports.cloud/api/v1.0/workspaces> HTTP/1.1 Authorisation: Bearer {TOKEN} tenant-id: {TENANT_ID} Response # HTTP/1. https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/provisioning/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/provisioning/ Provisioning # There are 2 ways to provision reseller accounts or manage existing ones, through the 'Reseller' interface of the enterprise portal or through the REST API. This section of the documentation outlines how to provision resellers through the enterprise portal. For more information on using the API for provisioning, please refer to the dedicated API documentation. Creating a New Reseller # A new reseller account can be created by clicking the '+ Create New Reseller' button in the top right of the page. https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes/ Release Notes # The following sections outline the release history of the solution and provides information on new features as they are added to the product. Information Circle info Documentation version - 1.107.1 Releases # 1.107.0 - February 17th, 2026 # Features Area Description Conversational Intelligence New 'Custom Dictionary' support'Transcription/Summary Only' option added https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/requirements/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/requirements/ Requirements # Browsers # The website is designed to work on most modern browsers. This includes: Chrome Firefox Edge (New Chromium version) Safari Ensure you are running the latest version of your chosen browser to avoid compatibility issues. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/gettingstarted/accountonboarding/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/gettingstarted/accountonboarding/ Reseller Account Onboarding Process # The onboarding process is the process of creating a new reseller account on ~.Dimensions.~ along with any user accounts which will require access to the Reseller Portal. Document note At this stage you should have completed the Authentication Process and should have the required Access/Refresh tokens. The steps below outline the recommended process for onboarding a new reseller account. 1. Create a Reseller Account # The first step of the process is to create the reseller account record. https://docs.au.xarios.cloud/enterprise-portal/en-gb/users/usersettings/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/users/usersettings/ User Settings # For each user who access to the system there are some basic setting that apply only to them. The user based settings can be accessed by selecting the user name from the context menu in the top right corner of the portal: The settings outlined below can be updated as required by the logged in user. Your Details # This section contains basic user information. https://docs.au.xarios.cloud/enterprise-portal/en-gb/branding/whitelabel/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/branding/whitelabel/ White Labeling # The ability to change branding of the portal is included as a standard feature. To change the URL of the Enterprise and sub portals a full 'White Label' option must be enabled. Changing the portal URLs (with the exception of the login portal) is possible if using CloudFlare for your DNS provision. For more information, please contact your ~.Dimensions.~ sales representative. https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/pbxtemplates/kazoo/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/pbxtemplates/kazoo/ ~.pbx.kazoo.name.~ Connection # The ~.pbx.kazoo.name.~ PBX connection provides a data collection service for the ~.pbx.kazoo.name.~ UCaaS/CPaaS platform. The table below outlines the settings required when configuring a ~.pbx.kazoo.name.~ PBX connection: Setting Description Name A unique name to be able to easily identify the use of the connection. API Key The API key to allow ~.Dimensions.~ to connect to ~.pbx.kazoo.name.~ and monitor the customer's communications. https://docs.au.xarios.cloud/enterprise-portal/en-gb/billing/billingdatajson/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/billing/billingdatajson/ Billing Data JSON # The information below provides details of the JSON data provided when downloading the data for a specific invoice. The JSON data provides the most granular level of information, including entries for each user licence used and summary entries providing information on invoice totals and applicable taxes. Invoice Details Schema # The main JSON entry provides details about the invoice number, period and date. It also contains an array of the individual invoice items which relate to each licence being invoiced for. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/charges/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/charges/ Charges (Enterprise) # When a request is made via the API that may incur any additional charges, this will return with a HTTP status response of: 402 Payment Required The request will not have been actioned. In order to action this an identical request should be made with an additional header value of: accept-charges: true Example # This request will attempt to create a new Customer with the following details without accepting charges: https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/usersgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/usersgetall/ Get All # Gets all Users for a Customer tenant. GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users Example # This request will get all the Users of the given Customer tenant. Request # GET <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 2, "data": [{ "id": "{USER_ID_1}", "displayName": "User 1", "email": "user1@example.com", "primaryTenant": "{CUSTOMER_TENANT_ID}", "isParent": false }, { "id": "{USER_ID_2}", "displayName": "User 2", "email": "user2@example. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/billing/billinggetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/billing/billinggetall/ Get All (Billing Data) # Gets a list of all invoices. Once a list of all invoices has been retrieved, specific details about invoices can be retrieved using Get Invoice, Get Invoice Detail or Get Invoice Summary. GET /v1.0/billingdata Example # This request will get a list of all invoices. Request # GET <https://api.au.myreports.cloud/api/v1.0/billingdata> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 4, "data": [ { "tenantId":"{RESELLER_TENANT_ID}", "invoiceid":"{INVOICE_ID}", "invoiceNumber":"{INVOICE_NUMBER}", "customerName":"Reseller 1", "billingPeriodStart":"2020-01-01T00:00:00. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/customersgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/customersgetall/ Get All (Customers of Reseller) # Gets all Customers for a Reseller GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers?pageIndex={pageIndex}&pageSize={pageSize}&filter={filter} Parameters Description pageIndex 0 based index to allow querying of pages pageSize Page size to be returned by the request. Max 1,000 filter Optional filter parameter to search for customers by 'name' and 'reference' fields. A 'Contains' search is performed on any string provided. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxgetall/ Get All (PBX) # Gets all PbxConnectionProfiles for a Customer tenant. GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs Example # This request will get all the PbxConnectionProfile of the given Customer tenant. Request # GET <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 2, "data": [{ "id": "{PBX_ID_1}", "name": "Pbx 1", "\_type": "{PBX_TYPE}", "tenantId": "{CUSTOMER_TENANT_ID}" }, { "id": "{PBX_ID_2}", "name": "Pbx 2", "\_type": "{PBX_TYPE}", "tenantId": "{CUSTOMER_TENANT_ID}" } ][{ "id": "{PBX_ID_1}", "name": "Pbx 1", "_type": "{PBX_TYPE}", "tenantId": "{CUSTOMER_TENANT_ID}" }, { "id": "{PBX_ID_2}", "name": "Pbx 2", "_type": "{PBX_TYPE}", "tenantId": "{CUSTOMER_TENANT_ID}" } ], "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountusersgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountusersgetall/ Get All (Reseller ) # Gets all Users for a Reseller Account tenant. GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/users Example # This request will get all the Account Users of the given Account tenant. Request # GET <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/users> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 2, "data": [{ "id": "{USER_ID_1}", "displayName": "User 1", "email": "user1@example.com", "primaryTenant": "{ACCOUNT_TENANT_ID}" }, { "id": "{USER_ID_2}", "displayName": "User 2", "email": "user2@example. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountsgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountsgetall/ Get All (Reseller) # Gets all Reseller Accounts for an Enterprise GET /v1.0/accounts?pageIndex=0&pageSize=20 Information Circle info This request supports paging, the default page size is 1,000. Page index is 0. Example # This request will get all the child Reseller Account tenants for this Enterprise. Request # GET <https://api.au.myreports.cloud/api/v1.0/accounts?pageIndex=0&pageSize=20> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 4, "page_index": 0, "data": [{ "id": "{ACCOUNT_TENANT_ID_1}", "name": "Account 1", "description": "This is Account 1", "enabled": true, "parentTenantId": "{ENTERPRISE_TENANT_ID}", "reference": "account reference 1", "dateCreated": "2019-01-01T09:00:00. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/profiles/profilesgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/profiles/profilesgetall/ Get All (Tenant Profile) # Gets all Tenant Profiles available on your Reseller Account. GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/tenantprofiles Example # This request will get all the tenant profiles. Request # GET <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/tenantprofiles> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 4, "data": [ { "id": "TenantProfileType_clientonly", "name": "ClientOnly", "description": "This is the Client Only profile" }, { "id": "TenantProfileType_insights", "name": "Insights", "description": "This is the Insights profile" }, { "id": "TenantProfileType_analytics", "name": "Analytics", "description": "This is the Analytics profile" } ][ { "id": "TenantProfileType_clientonly", "name": "ClientOnly", "description": "This is the Client Only profile" }, { "id": "TenantProfileType_insights", "name": "Insights", "description": "This is the Insights profile" }, { "id": "TenantProfileType_analytics", "name": "Analytics", "description": "This is the Analytics profile" } ], "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/workspaces/reports/reportrequest/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/workspaces/reports/reportrequest/ Post Report Request # Post a request to run a report for a specific time period (dateFilter). POST /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/requests Example using a Preset Date Filter # This request will run a report for the current quarter. The return body contains as 'requestId' which can be used to query the status of the report and retrieve the dataset. Request # POST <https://api.au.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/requests> HTTP/1.1 Content-Type: application/json Authorisation: Bearer {TOKEN} tenant-id: {TENANT_ID} Connection: keep-alive { "reportId": "00000000-0000-0000-0000-000000000001", "dateFilter": { "presetName": "ThisQuarter" } } Information Circle info https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/settings/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/settings/ Reseller Settings # The settings displayed here are reseller specific settings which control some of the features of the solution. Setting Description Default Country The country that the reseller is located in. This will be used to default localisation and number formatting settings. The country setting for the service provider account will be inherited. Time Zone Select the default timezone for the reseller. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/gettingstarted/authentication/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/gettingstarted/authentication/ Authentication Process # Requests to the API are secured via a JWT access token. This token needs to be generated using the OAuth v2 Authorisation Code grant flow. The image below provides an outline of the process involved in generating the required tokens and keeping them alive: Please refer to the links below for detailed technical information and code examples of the Authorisation Code grant flow: Authorisation Code Grant Example Flow To progress with the steps below, you will need: https://docs.au.xarios.cloud/enterprise-portal/en-gb/billing/billingdatacsv/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/billing/billingdatacsv/ Billing Data CSV # The information below provides details of the CSV data provided when downloading the data for a specific invoice. The CSV data provides information on each user licence used but does not provide any invoice summary information. CSV Invoice Item Schema # Each entry in the CSV billing data provides the parameters listed below. Key Description Type id A unique id for the individual purchase string quantity1 The quantity used double value The monetary cost of the item double fromdate The date from which the item is being billed for string todate The date from which the item is being billed to string productname The name of the feature/product the Invoice Item is for. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/customersgetcustomer/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/customersgetcustomer/ Get Customer # Gets an existing Customer GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID} Example # This request will get the specific Customer tenant. Request # GET <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "id": "{CUSTOMER_TENANT_ID_1}", "name": "Customer 1", "description": "This is Customer 1", "enabled": true, "parentTenantId": "{ACCOUNT_TENANT_ID}", "reference": "customer reference 1", "dateCreated": "2019-01-01T09:00:00.000" }, "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/billing/billinggetinvoice/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/billing/billinggetinvoice/ Get Invoice # Gets a specific invoice. GET /v1.0/billingdata/{INVOICE_ID} Example # This request will get all the child Customer tenants for this Reseller Account. Request # GET <https://api.au.myreports.cloud/api/v1.0/billingdata/{INVOICE_ID}> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "tenantId":"{RESELLER_TENANT_ID}" ,"invoiceid":"{INVOICE_ID}" ,"invoiceNumber":"{INVOICE_NUMBER}" ,"customerName":"Reseller 1" ,"billingPeriodStart":"2020-01-01T00:00:00.000+00:00" ,"billingPeriodEnd":"2020-01-31T23:59:59.999+00:00" ,"invoiceValue":0.0 }, "status": "success", "timestamp": "2019-01-01T10:00:00.2890319Z" } Errors # Unauthorised # When the token is not provided, invalid or expired HTTP/1. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxgetpbx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxgetpbx/ Get PBX # Gets an existing PbxConnectionProfile from a Customer tenant. GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID} Example # This request will get the specific PbxConnectionProfiles within the Customer tenant. Request # GET <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "id": "{PBX_ID_1}", "name": "Pbx 1", "\_type": "{PBX_TYPE}", "tenantId": "{CUSTOMER_TENANT_ID}" }, "status": "success", "timestamp": "2019-01-01T10:00:00.2890319Z" } Errors # Unauthorised # When the token is not provided, invalid or expired HTTP/1. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxgetinstance/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxgetinstance/ Get PBX PBX Instance # This endpoint is used to check if the target PBX is already associated with a customer tenant somewhere on the system. GET /v1.0/pbxs?instanceId={PBX_INSTANCE_ID} Depending on the Pbx type, the following values need to be passed as the {PBX_Instance_ID}: ~.pbx.kazoo.name.~ => ~.pbx.kazoo.name.~ Account Id Teams => Microsoft Tenant Id 3CX => 3CX Licence Key Example # This request will get the specific PbxConnectionProfiles within the Customer tenant. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountsgetaccount/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountsgetaccount/ Get Reseller Account # Gets an existing Account GET /v1.0/accounts/{ACCOUNT_TENANT_ID} Example # This request will get the specific Account tenant. Request # GET <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "id": "{Account_TENANT_ID_1}", "name": "Account 1", "description": "This is Account 1", "enabled": true, "parentTenantId": "{ENTERPRISE_TENANT_ID}", "reference": "account reference 1", "dateCreated": "2019-01-01T09:00:00.000" }, "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/workspaces/reports/reportstatusget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/workspaces/reports/reportstatusget/ Get Status # This request accepts a report 'requestId' and returns the status of the request. GET /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/results/{REQUEST_ID} Example - In Progress Request # This request returns the status of a report request that is still running. Request # GET <https://api.au.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/requests/00000000-0000-0000-0000-000000000005> HTTP/1.1 Authorisation: Bearer {TOKEN} tenant-id: {TENANT_ID} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "dateCreated": "2025-09-22T15:27:40.1946146Z", "tenantId": "f8322e65-ddac-4f5c-1f6c-08db2fa7b464", "requestId": "65224fa5-f4c6-4796-b3c8-c4f67d504971", "reportId": "2aafb829-91aa-4d17-a5d3-bb6fde34ca10", "status": "Complete", "statusMessage": "Report processing complete", "reportTemplateName": "CallListByUserSegmented" }, "status": "success", "timestamp": "2019-05-01T10:00:00. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/usersgetuser/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/usersgetuser/ Get User # Gets an existing User from a Customer tenant. GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID} Example # This request will get the specific User within the Customer tenant. Request # GET <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "id": "{USER_ID}", "displayName": "Customer 1", "email": "[user1@example.com](mailto:user1@example.com)", "primaryTenant": "{CUSTOMER_TENANT_ID}", "isParent": false, "roles": [ "customer.user", "customer.user.supervisorl3" ][ "customer.user", "customer. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountusersgetuser/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountusersgetuser/ Get User (Reseller) # Gets an existing Reseller Account User from a Reseller Account tenant. GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/users/{USER_ID} Example # This request will get the specific User within the Account tenant. Request # GET <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/users/{USER_ID}> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "id": "{USER_ID}", "displayName": "Customer 1", "email": "[user1@example.com](mailto:user1@example.com)", "primaryTenant": "{ACCOUNT_TENANT_ID}", "roles": ["account.user"][ "account.user" ] }, "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/users/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/users/ Reseller Users # The users associated with a reseller's account can be managed by the reseller on the Reseller Portal itself or by a service provider in the Enterprise Portal. User Permissions # The following permissions can be applied to users to allow them access to various areas of the portal: Role Description Automatic Assignment Reseller Website Access1 Grants the user access to the reseller web portal. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/customerspost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/customerspost/ Create Customer # Creates a new Customer tenant POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers Example # This request will create a new Customer with the following details: Name: "New customer" Description: "This is my new customer" Reference: "ABC00001" Enabled: false TimeZone : "America/Los_Angeles", CountryCode: "US" PbxConnectionProfile Crossbar Rest Api: "https://hostrest" Blackhole Websocket Api: "wss//:hostwebsocket" ~.pbx.kazoo.name.~ AccountId: "accountid" ~.pbx.kazoo.name.~ Api Key: "apikey" monitorSubAccounts: False sendNewUserEmail: False sendConnectWelcomeEmail: False TrialDuration: "0" Request # POST <https://api. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxpost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxpost/ Create PBX # Creates a new PbxConnectionProfile assigned to a Customer tenant. POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs Example # This request will create a new ~.pbx.kazoo.name.~ PbxConnectionProfile with the following details: Customer: Within the Customer tenant with id of {CUSTOMER_TENANT_ID} Name: "Customers ~.pbx.kazoo.name.~ Pbx" Host Rest: "https://rest.example.com" Host Websocket: "wss://ws.example.com" Account Id: "12345" API Key: "ABCDEF" Request # POST <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1 Content-Type: application/json accept-charges: true Authorisation: Bearer {TOKEN} Connection: keep-alive { "name": "Customers ~. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountspost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountspost/ Create Reseller Account # Creates a new Account tenant POST /v1.0/accounts Example # This request will create a new Account with the following details: Name: "New account" Description: "This is my new account" Reference: "XYZ00001" Enabled: false TimeZone : "America/Los_Angeles", CountryCode: "US" Request # POST <https://api.au.myreports.cloud/api/v1.0/accounts> HTTP/1.1 Content-Type: application/json accept-charges: true Authorisation: Bearer {TOKEN} Connection: keep-alive { "name": "New account", "description": "XYZ00001 is my new account", "reference" : "ABC00001", "enabled": false, "timezone": "America/Los_Angeles", "countryCode": "US", } Response # HTTP/1. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/userspost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/userspost/ Create User # Creates a new User assigned to a Customer tenant. POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users Remarks # Whenever a new User is created they will be given the "customer.user" role that allows them to login to the Customer portal. This will also send out an activation email to the address provided as soon as the User is created. Example # This request will create a new User with the following details: https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountuserspost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountuserspost/ Create User (Reseller) # Creates a new Reseller Account User assigned to a Reseller Account tenant. POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/users Remarks # Whenever a new User is created they will be given the "account.user" role that allows them to login to the Reseller Portal. This will also send out an activation email to the address provided as soon as the User is created. Example # This request will create a new User with the following details: https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/gettingstarted/customeronboarding/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/gettingstarted/customeronboarding/ Customer Onboarding Process # The onboarding process is the process of creating a new customer account on ~.Dimensions.~ along with any user accounts which will require access to the customer portal. Document note At this stage you should have completed the Reseller Account Onboarding Process. Customer accounts cannot be added to the Enterprise portal directly, only through a Reseller Portal. The steps below outline the recommended process for onboarding a new customer. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/billing/billinggetinvoicedetail/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/billing/billinggetinvoicedetail/ Get Invoice Detail # Get a detailed breakdown of all items being invoiced for a specific invoice. A ZIP file is returned from this query which contains a detailed JSON file and a simplified CSV file. Each file contains a record of every transaction in the invoice. GET /v1.0/billingdata/{INVOICE_ID}/detail Example # This request will retrieve a breakdown of items for a specific invoice id. Request # GET <https://api. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/workspaces/reports/reportresultget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/workspaces/reports/reportresultget/ Get Results # This request accepts a report 'requestId' and returns the results of the report if complete. GET /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/results/{REQUEST_ID}/data Example # This request returns the result data of a report request that is complete. Request # GET <https://api.au.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/requests/00000000-0000-0000-0000-000000000005/data> HTTP/1.1 Authorisation: Bearer {TOKEN} tenant-id: {TENANT_ID} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "requestId": "00000000-0000-0000-0000-000000000005", "tenantId": "00000000-0000-0000-0000-000000000000", "request": { "requestId": "00000000-0000-0000-0000-000000000005", "dateCreated": "2025-09-22T15:27:40. https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/metrics/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/metrics/ Licence Metrics # This section provides information on the licences that a reseller is currently consuming. As users are provisioned or their roles are changed, the licence values will be updated accordingly. Metric Description Customers The total number of customer accounts the reseller has configured Essential User The number of users that have been assigned a Essential User licence Agent User Add-On The number of users that have been assigned an Agent User licence Reports Supervisor The number of users with access to run historical reports Real-Time Supervisor The number of users that have been assigned a Real-time Supervisor licence Real-Time Wallboard (FireTV) The number of FireTV Wallboards licences in use Document note https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/customerspatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/customerspatch/ Patch Customer # Updates a specific set of properties of a Customer. This uses the JSON Patch format for any changes. PATCH /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID} Example # This request will update the Api Key of the PBX connection and enable it. Request # PATCH <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/> HTTP/1.1 Content-Type: application/json accept-charges: true Authorisation: Bearer {TOKEN} Connection: keep-alive [{ "op": "replace", "path": "/enabled", "value": false }, { "op": "replace", "path": "/pbxConnectionProfile/apiKey", "value": "newapikey" } ][{ "op": "replace", "path": "/enabled", "value": false }, { "op": "replace", "path": "/pbxConnectionProfile/apiKey", "value": "newapikey" } ] Response # HTTP/1. https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes2020/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes2020/ Archived Release Notes # 2020 Releases # 1.56.0 - Dec 21st, 2020 # Tech Bulletin 20201218 released - see Tech Bulletin section Reports Call Direction now a filter on Calls by User reports. Modelling now able to identify calls to fax machine. Wallboard Wallboard will dynamically refresh on configuration changes in another browser. Issue resolved where config updates could cause inconsistent agent numbers. https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes2021/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes2021/ Archived Release Notes # 2021 Releases # 1.72.0 - Dec 7th, 2021 # ~.UcClient.~ Desktop Presence Profiles -> Profiles can now be overridden by users giving control of DND, Forwarding and Personal Call Routing ~.UcClient.~ Mobile Android -> Initial Android version released Voicemail Access -> Users can see voicemail quantity and dial in to play them Presence Profile Selection -> Users can now control their presence through the mobile application 1. https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes2022/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes2022/ Archived Release Notes # 2022 Releases # 1.81.0 - Nov 8th, 2022 # Reporting Features Allow ring duration interval to be configured for 'Calls By Ring Time' report Fixes Call tagging reports failed to run within a schedule (Ticket #49817) ~.UcClient.~ Clients (Desktop/Mobile/CRM) Features Group calls will no longer show as missed if answered at another location Fixes Fixed issue with clients being intermittently logged out (Ticket #49724) ~. https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes2023/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes2023/ Archived Release Notes # 2023 Releases # 1.89.0 - December 12th, 2023 # Features Area Description Customer Portal Improved filtering - Pick lists added for users, groups etcLocalisation Update - French & Spanish Dashboard Click through support from tiles to reportsAway state control, supervisor support for non-PBX usersSupervisor agent control now requires the new 'Supervisor Agent Control' roleAlarms - Native browser notification supportActive call stats and primary user groups now available on User/agent grids Reporting Number of ring duration thresholds increased from 6 to 12CRM linked tag data now shows as URLs in the Call Session view ~. https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes2024/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/releasenotes2024/ Archived Release Notes # 2024 Releases # 1.96.0 - November 26th, 2024 # Features Area Description Portal New 'Dispositions' feature Reporting Call Tags - Post call tagging now availableCall Tags - Disable tag instance now available API Expanded reseller metricsCustomer trial status now included ~.UcClient.~ Clients New welcome emails per client type ~. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/customersdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/customersdelete/ Delete Customer # Deactivates an existing Customer tenant and flags it for deletion. Request # DELETE /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID} Errors # Unauthorised # When the token is not provided, invalid or expired HTTP/1.1 401 Unauthorised Bad Request # When the provided account tenant or customer tenant id is not in the correct format HTTP/1.1 400 Bad Request Date: Thu, 06 Feb 2020 12:45:27 GMT Content-Type: application/json; charset=utf-8 Content-Length: 149 { "error": 400, "message": "The value '<tenant id>' is not valid. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/billing/billinggetinvoicesummary/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/billing/billinggetinvoicesummary/ Get Invoice Summary # Get a PDF copy of a specific ~.Dimensions.~ invoice. GET /v1.0/billingdata/{INVOICE_ID}/summary Example # This request will provide a stream of a specific PDF invoice. Request # GET <https://api.au.myreports.cloud/api/v1.0/billingdata/{INVOICE_ID}/summary> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/octet-stream; charset=utf-8 Content-Length: xx { "status": "success", "timestamp": "2019-01-01T10:00:00.2890319Z" } Errors # Unauthorised # When the token is not provided, invalid or expired HTTP/1. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxpatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxpatch/ Patch PBX # Updates a specific set of properties of a PbxConnectionProfile. This uses the JSON Patch format for any changes. PATCH /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID} Example 1 # This request will update the Name of the PbxConnectionProfile. Request # PATCH <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}> HTTP/1.1 Content-Type: application/json accept-charges: true Authorisation: Bearer {TOKEN} Connection: keep-alive [ { "op": "replace", "path": "/name", "value": "My New Name" } ][ { "op": "replace", "path": "/name", "value": "My New Name" } ] Response # HTTP/1. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountspatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountspatch/ Patch Reseller Account # Updates a specific set of properties of an Account. This uses the JSON Patch format for any changes. PATCH /v1.0/accounts/{ACCOUNT_TENANT_ID} Example # This example will disable a reseller account's access to the system.' Request # PATCH <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/> HTTP/1.1 Content-Type: application/json accept-charges: true Authorisation: Bearer {TOKEN} Connection: keep-alive [{ "op": "replace", "path": "/enabled", "value": false } ][{ "op": "replace", "path": "/enabled", "value": false } ] Response # HTTP/1. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/userspatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/userspatch/ Patch User # Updates a specific set of properties of a User. This uses the JSON Patch format for any changes. PATCH /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID} Hand Left warning When patching the roles against a user, be careful if using the REPLACE operation. With the replace operation, the user's current roles will be replaced with the values provided in the patch request. Any role not provided in the patch request will be removed from the user (with the exception of the PBX user role which is synchronised from the PBX). https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountuserspatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountuserspatch/ Patch User (Reseller) # Updates a specific set of properties of an Reseller Account User. This uses the JSON Patch format for any changes. PATCH /v1.0/accounts/{ACCOUNT_TENANT_ID}/users/{USER_ID} Hand Left warning When patching the roles against a user, be careful if using the REPLACE operation. With the replace operation, the user's current roles will be replaced with the values provided in the patch request. Any role not provided in the patch request will be removed from the user). https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/techbulletin/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/about/techbulletin/ Tech Bulletins # The following technical bulletins have been released: TB20201218 - ~.pbx.kazoo.name.~ update available for loss of WebSocket events https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/userdevices/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/userdevices/ Update User Device # This endpoint allows existing devices to be assigned (or removed) as softphone devices for a user for ~.UcClient.~ Desktop, Mobile & WebRTC. Assign a Device PUT /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign Unassign a Device PUT /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign The Body of the request needs to contain a single JSON property to indicate which type of client the device is being assigned to: { "clientType": "desktop" } Valid clientType values: https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/pbxprofiles/pbxdelete/ Delete PBX # Deletes an existing PbxConnectionProfile from the Customer tenant. Hand Left warning This will disconnect the Pbx connection and stop collecting any events. Request # DELETE /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID} Example # This request will delete the specific PbxConnectionProfile within the Customer tenant. Request # DELETE <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountsdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountsdelete/ Delete Reseller Account # Deactivates an existing Reseller Account tenant and flags it for deletion. Request # DELETE /v1.0/accounts/{ACCOUNT_TENANT_ID} Errors # Unauthorised # When the token is not provided, invalid or expired HTTP/1.1 401 Unauthorised Bad Request # When the provided tenant id is not in the correct format HTTP/1.1 400 Bad Request Date: Thu, 06 Feb 2020 12:45:27 GMT Content-Type: application/json; charset=utf-8 Content-Length: 149 { "error": 400, "message": "The value '<tenant id>' is not valid. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/usersdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/usersdelete/ Delete User # Deletes an existing User from the Customer tenant. If this is a user's non primary tenant, it will remove them only from this tenant. They will still have access to any other Customer they are assigned. If this is the user's primary tenant, it will remove them from ALL other Customer tenants and delete the User account. Request # DELETE /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID} Example # This request will delete the specific User within the Customer tenant. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountusersdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountusersdelete/ Delete User (Reseller) # Deletes an existing User from the Reseller Account tenant. If this is a user's non primary tenant, it will remove them only from this tenant. They will still have access to any other Customer they are assigned. If this is the user's primary tenant, it will remove them from ALL other Account tenants and delete the User account. Request # DELETE /v1.0/accounts/{ACCOUNT_TENANT_ID}/users/{USER_ID} Example # This request will delete the specific User within the Account tenant. https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/termination/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/accounts/termination/ Disabling Reseller Accounts # ~.Dimensions.~ provides the ability to restrict a resellers's access to the system. The disable option is designed for use with resellers who may have missed payments on the service and as a service provider you wish to restrict their access to the system temporarily. To disable a reseller's access to their account, click the 'Edit' button on the account grid then press the 'More' button and select 'Disabled'. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountsmetrics/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/accountsmetrics/ Reseller Metrics # Returns licence usage metrics for each customer from a Reseller Account. For details on the customer metrics that can be returned, refer to the Customers section. Request # GET /v1.0/accounts/{ACCOUNT_TENANT_ID}/metrics Example # This request will return the licence usage metrics for the specified reseller. Request # GET <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/metrics> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "accountTenantId": "00000000-0000-0000-0000-000000000000", "accountName" : "Example Account 1", "enabled" : true, "dateCreated" : "2021-03-02T15:15:46. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountuserssendactivationlink/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/users/accountuserssendactivationlink/ Send Activation Email (Reseller) # Send Activation Email Sends an activation email link to an existing User. POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/users/{USER_ID}/sendActivationEmail Example # This request will get send an activations link to this User within the Customer tenant. Hand Left warning Activation emails can only be sent from the User's primary tenant. Request # POST <https://api.au.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/users/{USER_ID}/sendActivationEmail> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 204 No Content Errors # Unauthorised # When the token is not provided, invalid or expired HTTP/1. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/userssendactivationlink/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/userssendactivationlink/ Send New User Email # Sends a Welcome email link to an existing User. POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/sendActivationEmail Document note This will be done automatically if the sendNewUserEmail property is enabled on the customer account. Example # This request will get send an activations link to this User within the Customer tenant. Hand Left warning Activation emails can only be sent from the User's primary tenant. https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/userssenducemail/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.au.xarios.cloud/enterprise-portal/en-gb/api/reference/accounts/customers/users/userssenducemail/ Send Unified Communications Welcome Email # Sends a welcome email to a user when they are enabled to use a unified communications client. POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/sendUConnectActivationEmail Document note This will be done automatically if the sendConnectWelcomeEmail property is enabled on the customer account. Example # This request will get send an activations link to this User within the Customer tenant. Hand Left warning