Web integrations

A web integration is a resource representing a list of whitelisted origins that can make requests to a specified tenant. It is the implementation of the CORS mechanism within Qlik Cloud.

Download specification

Endpoints

GET

/v1/web-integrations
POST

/v1/web-integrations
GET

/v1/web-integrations/{id}
PATCH

/v1/web-integrations/{id}
DELETE

/v1/web-integrations/{id}

Retrieves web integrations matching the query.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalauthenticate

Query Parameters

endingBeforestring

The target web integration ID to start looking before for web integrations. Cannot be used in conjunction with startingAfter.
limitnumber

The number of web integration entries to retrieve.

minimum = 0, maximum = 100, default = 10, default = 10
sortstring

The field to sort by. Prefix with +/- to indicate ascending/descending order.

Can be one of: "name""+name""-name"

default = "+name"
startingAfterstring

The target web integration ID to start looking after for web integrations. Cannot be used in conjunction with endingBefore.
tenantIdstring

The tenant ID to filter by.

Responses

200

application/json

An array of web integration objects.

application/jsonobject

An array of web integration objects.
Show application/json properties
- dataarray of objects
  
  Properties of web integrations in a given tenant.
  
  Show data properties
  
  idstring
  
  The unique web integration identifier.
  
  format = "uid"
  
  namestring
  
  The name of the web integration.
  
  createdstring
  
  The time the web integration was created.
  
  format = "date-time"
  
  tenantIdstring
  
  The tenant that the web integration belongs to.
  
  format = "uid"
  
  createdBystring
  
  The user that created the web integration.
  
  format = "uid"
  
  lastUpdatedstring
  
  The time the web integration was last updated.
  
  format = "date-time"
  
  validOriginsarray of strings
  
  The origins that are allowed to make requests to the tenant.
- linksobject
  
  Pagination links
  
  Show links properties
  
  nextobject
  
  Link information for next page.
  
  Show next properties
  
  hrefstring
  Required
  
  URL to the next page of records.
  
  prevobject
  
  Link information for previous page.
  
  Show prev properties
  
  hrefstring
  Required
  
  URL to the previous page of records.
  
  selfobject
  Required
  
  Link information for current page.
  
  Show self properties
  
  hrefstring
  Required
  
  URL to the current page of records.

default

application/json

Unexpected error.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

GET /v1/web-integrations

curl "https://your-tenant.us.qlikcloud.com/api/v1/web-integrations" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/web-integrations',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik web-integration ls

Response

{
  "data": [
    {
      "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "name": "string",
      "created": "2018-10-30T07:06:22Z",
      "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "lastUpdated": "2018-10-30T07:06:22Z",
      "validOrigins": [
        "string"
      ]
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a web integration.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalauthenticate

Request Body

Required

application/json

Properties that the user wants to set for the web integration.

application/jsonobject
Show application/json properties
- namestring
  Required
  
  The name of the web integration to create.
- validOriginsarray of strings
  
  The origins that are allowed to make requests to the tenant.

Responses

201

application/json

Web integration created successfully.

The creation of a web integration response.

application/jsonobject

The creation of a web integration response.
Show application/json properties
- idstring
  
  The unique web integration identifier.
  
  format = "uid"
- namestring
  
  The name of the newly created web integration.
- linksobject
  
  Pagination links
  
  Show links properties
  
  selfobject
  Required
  
  Link information for current page.
  
  Show self properties
  
  hrefstring
  Required
  
  URL to the current page of records.
- createdstring
  
  The time the web integration was created.
  
  format = "date-time"
- tenantIdstring
  
  The tenant that the web integration belongs to.
  
  format = "uid"
- createdBystring
  
  The user that created the web integration.
  
  format = "uid"
- lastUpdatedstring
  
  The time the web integration was last updated.
  
  format = "date-time"
- validOriginsarray of strings
  
  The origins that are allowed to make requests to the tenant.

400

application/json

Invalid request was made.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

403

application/json

Requestor not allowed to create a web integration.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

POST /v1/web-integrations

curl "https://your-tenant.us.qlikcloud.com/api/v1/web-integrations" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"My Web Integration","validOrigins":["https://thirdPartyApp.com"]}'

const https = require('https')
  const data = JSON.stringify({"name":"My Web Integration","validOrigins":["https://thirdPartyApp.com"]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/web-integrations',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik web-integration create \
--name="My Web Integration" \
--validOrigins='"https://thirdPartyApp.com"'

Request

{
  "name": "My Web Integration",
  "validOrigins": [
    "https://thirdPartyApp.com"
  ]
}

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "name": "My Web Integration",
  "links": {
    "self": {
      "href": "http://mytenant.region.domain/api/v1/web-integrations/id"
    }
  },
  "created": "2018-10-30T07:06:22Z",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "lastUpdated": "2018-10-30T07:06:22Z",
  "validOrigins": [
    "https://thirdPartyApp.com"
  ]
}

Retrieves a single web integration by ID.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalauthenticate

Path Parameters

idstring
Required

The ID of the web integration to retrieve.

format = "uid"

Responses

200

application/json

Web integration found.

A web integration object.

application/jsonobject

A web integration object.
Show application/json properties
- idstring
  
  The unique web integration identifier.
  
  format = "uid"
- namestring
  
  The name of the web integration.
- createdstring
  
  The time the web integration was created.
  
  format = "date-time"
- tenantIdstring
  
  The tenant that the web integration belongs to.
  
  format = "uid"
- createdBystring
  
  The user that created the web integration.
  
  format = "uid"
- lastUpdatedstring
  
  The time the web integration was last updated.
  
  format = "date-time"
- validOriginsarray of strings
  
  The origins that are allowed to make requests to the tenant.

404

application/json

Web integration not found.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

GET /v1/web-integrations/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/web-integrations/{id}" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/web-integrations/{id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik web-integration get <web-integrationId>

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "name": "string",
  "created": "2018-10-30T07:06:22Z",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "lastUpdated": "2018-10-30T07:06:22Z",
  "validOrigins": [
    "string"
  ]
}

Updates a single web integration by ID.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalauthenticate

Path Parameters

idstring
Required

The ID of the web integration to update.

format = "uid"

Request Body

Required

application/json

Properties that the user wants to update for the web integration.

A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.

application/jsonarray of objects

A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
Show application/json properties
- opstring
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- pathstring
  Required
  
  A JSON Pointer.
  
  Can be one of: "/name""/validOrigins"
- valuestring
  Required
  
  New value to be used for this operation.

Responses

204

Web integration updated successfully.

400

application/json

Invalid request was made.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

404

application/json

Web integration not found.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

PATCH /v1/web-integrations/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/web-integrations/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '[{"op":"replace","path":"/name","value":"New name"}]'

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"/name","value":"New name"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/web-integrations/{id}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik web-integration patch <web-integrationId> \
--body='[{"op":"replace","path":"/name","value":"New name"}]'

Request

[
  {
    "op": "replace",
    "path": "/name",
    "value": "New name"
  }
]

Deletes a single web integration by ID.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalauthenticate

Path Parameters

idstring
Required

The ID of the web integration to delete.

format = "uid"

Responses

204

Web integration deleted successfully.

404

application/json

Web integration not found.

The error response object describing the error from the handling of an HTTP request.

application/jsonobject

The error response object describing the error from the handling of an HTTP request.
Show application/json properties
- errorsarray of objects
- traceIdstring
  
  A unique identifier for tracing the error.

DELETE /v1/web-integrations/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/web-integrations/{id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/web-integrations/{id}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik web-integration rm <web-integrationId>

Web integrations

Endpoints

List web integrations

Facts

Query Parameters

Responses

200

default

Response

Create web integration

Facts

Request Body

Responses

201

400

403

Request

Response

Get web integration by ID

Facts

Path Parameters

Responses

200

404

Response

Update web integration by ID

Facts

Path Parameters

Request Body

Responses

204

400

404

Request

Delete web integration by ID

Facts

Path Parameters

Responses

204

404