OAuth clients

Create and manage the configuration of OAuth clients in your tenant.

Endpoints

GET

/v1/oauth-clients
POST

/v1/oauth-clients
GET

/v1/oauth-clients/{id}
PATCH

/v1/oauth-clients/{id}
DELETE

/v1/oauth-clients/{id}
POST

/v1/oauth-clients/{id}/actions/publish
POST

/v1/oauth-clients/{id}/client-secrets
DELETE

/v1/oauth-clients/{id}/client-secrets/{hint}
GET

/v1/oauth-clients/{id}/connection-configs/me
PATCH

/v1/oauth-clients/{id}/connection-configs/me
DELETE

/v1/oauth-clients/{id}/connection-configs/me

Retrieve all OAuth clients.

Facts

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

Query Parameters

filterstring

The filter query that should be used to filter the list of oauth clients. The filter syntax is defined in RFC 7644. Valid attributes for filtering are clientId, clientName, appType, and tenantId.
limitnumber

The number of OAuth client entries to retrieve.

minimum = 1, maximum = 100, default = 20, default = 20
nextstring

The next page cursor
prevstring

The previous page cursor
sortstring

The attribute to sort by, beginning with + for ascending and - for descending. Valid attributes for sorting are clientId, clientName, appType, tenantId.
totalResultsboolean

Boolean query parameter that determines if the total count of results should be included in the response. If true, the response includes the total number of results in the totalResults field. If false or not included in the query, totalResults will be excluded from the response.

default = false

Responses

200

application/json

application/jsonobject
One of:
- OAuthClientAdminListResponseobject
  
  Response schema for listing OAuth clients as an admin user
  Show OAuthClientAdminListResponse properties
  
  dataarray of objects
  Required
  
  Schema for a OAuth client when listing as an admin user
  
  Show data properties
  
  appTypestring
  Required
  
  Application type
  
  Can be one of: "web""native""spa""anonymous-embed"
  
  maxLength = 64
  
  logoUristring
  
  URI for logo of client
  
  maxLength = 2048
  
  clientUristring
  
  URI for homepage of client
  
  maxLength = 2048
  
  createdAtstring
  Required
  
  The timestamp for when the oauth-clients record was created.
  
  format = "date-time"
  
  deletedAtstring
  
  The timestamp for when the oauth-clients record was deleted.
  
  format = "date-time"
  
  updatedAtstring
  
  The timestamp for when the oauth-clients record was updated.
  
  format = "date-time"
  
  clientNamestring
  Required
  
  Client application name
  
  maxLength = 512
  
  disableTagstring
  
  Is set if client disabled
  
  descriptionstring
  
  Client description
  
  maxLength = 4096
  
  publishedAtstring
  
  The timestamp which is set, if the client is published.
  
  format = "date-time"
  
  allowedScopesarray of strings
  
  List of allowed scopes for this client. For a full list of scopes see qlik.dev/authenticate/oauth/scopes/.
  
  allowedGrantTypesarray of strings
  
  Allowed grant types, only for use with appType: 'web'
  
  Values may be any of: "client_credentials""urn:qlik:oauth:user-impersonation"
  
  linksobject
  Required
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  URL that defines the resource
  
  format = "uri"
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  URL that defines the resource
  
  format = "uri"
  
  selfobject
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource
  
  format = "uri"
  
  totalResultsinteger
  
  Total number of oauth clients, included only if totalResults query parameter is set to true.
- OAuthClientListResponseobject
  
  Response schema for listing OAuth clients
  Show OAuthClientListResponse properties
  
  dataarray of objects
  Required
  
  Response schema for reading an OAuth client
  
  Show data properties
  
  appTypestring
  Required
  
  Application type
  
  Can be one of: "web""native""spa""anonymous-embed"
  
  maxLength = 64
  
  logoUristring
  
  URI for logo of client
  
  maxLength = 2048
  
  clientUristring
  
  URI for homepage of client
  
  maxLength = 2048
  
  createdAtstring
  Required
  
  The timestamp for when the oauth-clients record was created.
  
  format = "date-time"
  
  deletedAtstring
  
  The timestamp for when the oauth-clients record was deleted.
  
  format = "date-time"
  
  updatedAtstring
  
  The timestamp for when the oauth-clients record was updated.
  
  format = "date-time"
  
  clientNamestring
  Required
  
  Client application name
  
  maxLength = 512
  
  disableTagstring
  
  Is set if client disabled
  
  descriptionstring
  
  Client description
  
  maxLength = 4096
  
  publishedAtstring
  
  The timestamp which is set, if the client is published.
  
  format = "date-time"
  
  allowedScopesarray of strings
  
  List of allowed scopes for this client. For a full list of scopes see qlik.dev/authenticate/oauth/scopes/.
  
  allowedGrantTypesarray of strings
  
  Allowed grant types, only for use with appType: 'web'
  
  Values may be any of: "client_credentials""urn:qlik:oauth:user-impersonation"
  
  linksobject
  Required
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  URL that defines the resource
  
  format = "uri"
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  URL that defines the resource
  
  format = "uri"
  
  selfobject
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource
  
  format = "uri"

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

GET /v1/oauth-clients

curl "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients" \
-H "Authorization: Bearer <access_token>"

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

This API is not included yet in qlik-cli

Response

{
  "data": [
    {
      "appType": "web",
      "logoUri": "string",
      "clientUri": "string",
      "createdAt": "2018-10-30T07:06:22Z",
      "deletedAt": "2018-10-30T07:06:22Z",
      "updatedAt": "2018-10-30T07:06:22Z",
      "clientName": "string",
      "disableTag": "string",
      "description": "string",
      "publishedAt": "2018-10-30T07:06:22Z",
      "allowedScopes": [
        "string"
      ],
      "allowedGrantTypes": [
        "client_credentials"
      ]
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  },
  "totalResults": 42
}

Create a new OAuth client. Requires TenantAdmin role when created in-tenant. appType cannot be changed after creation. Consent method and published state can be changed after creation. For supported appType, use PATCH /oauth-clients/{id}/connection-configs/me to change consent method, and POST /oauth-clients/{id}/actions/publish to change the client to published after creation.

Facts

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

Request Body

Required

application/json

Request schema for OAuth client creation

application/jsonobject

Request schema for OAuth client creation
Show application/json properties
- appTypestring
  Required
  
  Application type
  
  Can be one of: "web""native""spa""anonymous-embed"
  
  maxLength = 64
- logoUristring
  
  URI for logo of client
  
  maxLength = 2048
- clientUristring
  
  URI for homepage of client
  
  maxLength = 2048
- clientNamestring
  Required
  
  Client application name
  
  maxLength = 512
- descriptionstring
  
  Client description
  
  maxLength = 4096
- redirectUrisarray of strings
  
  List of allowed redirect URIs for login
- allowedScopesarray of strings
  
  List of allowed scopes for this client. For a full list of scopes see qlik.dev/authenticate/oauth/scopes/.
- allowedOriginsarray of strings
  
  List of allowed origins for this client, only available with SPA application type
- allowedGrantTypesarray of strings
  
  Allowed grant types, only for use with appType: 'web'
  
  Values may be any of: "client_credentials""urn:qlik:oauth:user-impersonation"

Responses

201

application/json

Created

Response schema for OAuth client creation

application/jsonobject

Response schema for OAuth client creation
Show application/json properties
- appTypestring
  Required
  
  Application type
  
  Can be one of: "web""native""spa""anonymous-embed"
  
  maxLength = 64
- logoUristring
  
  URI for logo of client
  
  maxLength = 2048
- clientUristring
  
  URI for homepage of client
  
  maxLength = 2048
- createdAtstring
  Required
  
  The timestamp for when the oauth-clients record was created.
  
  format = "date-time"
- deletedAtstring
  
  The timestamp for when the oauth-clients record was deleted.
  
  format = "date-time"
- updatedAtstring
  
  The timestamp for when the oauth-clients record was updated.
  
  format = "date-time"
- clientNamestring
  Required
  
  Client application name
  
  maxLength = 512
- disableTagstring
  
  Is set if client disabled
- descriptionstring
  
  Client description
  
  maxLength = 4096
- publishedAtstring
  
  The timestamp which is set, if the client is published.
  
  format = "date-time"
- allowedScopesarray of strings
  
  List of allowed scopes for this client. For a full list of scopes see qlik.dev/authenticate/oauth/scopes/.
- allowedGrantTypesarray of strings
  
  Allowed grant types, only for use with appType: 'web'
  
  Values may be any of: "client_credentials""urn:qlik:oauth:user-impersonation"

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

POST /v1/oauth-clients

curl "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"appType":"web","logoUri":"string","clientUri":"string","clientName":"string","description":"string","redirectUris":["string"],"allowedScopes":["string"],"allowedOrigins":["string"],"allowedGrantTypes":["client_credentials"]}'

const https = require('https')
  const data = JSON.stringify({"appType":"web","logoUri":"string","clientUri":"string","clientName":"string","description":"string","redirectUris":["string"],"allowedScopes":["string"],"allowedOrigins":["string"],"allowedGrantTypes":["client_credentials"]})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/oauth-clients',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "appType": "web",
  "logoUri": "string",
  "clientUri": "string",
  "clientName": "string",
  "description": "string",
  "redirectUris": [
    "string"
  ],
  "allowedScopes": [
    "string"
  ],
  "allowedOrigins": [
    "string"
  ],
  "allowedGrantTypes": [
    "client_credentials"
  ]
}

Response

{
  "appType": "web",
  "logoUri": "string",
  "clientUri": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "deletedAt": "2018-10-30T07:06:22Z",
  "updatedAt": "2018-10-30T07:06:22Z",
  "clientName": "string",
  "disableTag": "string",
  "description": "string",
  "publishedAt": "2018-10-30T07:06:22Z",
  "allowedScopes": [
    "string"
  ],
  "allowedGrantTypes": [
    "client_credentials"
  ]
}

Retrieves the specified OAuth client.

Facts

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

Path Parameters

idstring
Required

The unique identifier for the OAuth client

Responses

200

application/json

application/jsonobject
One of:
- OAuthClientBaseobject
  
  Response schema for reading an OAuth client as an admin user
  Show OAuthClientBase properties
  
  appTypestring
  Required
  
  Application type
  
  Can be one of: "web""native""spa""anonymous-embed"
  
  maxLength = 64
  
  logoUristring
  
  URI for logo of client
  
  maxLength = 2048
  
  clientUristring
  
  URI for homepage of client
  
  maxLength = 2048
  
  createdAtstring
  Required
  
  The timestamp for when the oauth-clients record was created.
  
  format = "date-time"
  
  deletedAtstring
  
  The timestamp for when the oauth-clients record was deleted.
  
  format = "date-time"
  
  updatedAtstring
  
  The timestamp for when the oauth-clients record was updated.
  
  format = "date-time"
  
  clientNamestring
  Required
  
  Client application name
  
  maxLength = 512
  
  disableTagstring
  
  Is set if client disabled
  
  descriptionstring
  
  Client description
  
  maxLength = 4096
  
  publishedAtstring
  
  The timestamp which is set, if the client is published.
  
  format = "date-time"
  
  allowedScopesarray of strings
  
  List of allowed scopes for this client. For a full list of scopes see qlik.dev/authenticate/oauth/scopes/.
  
  allowedGrantTypesarray of strings
  
  Allowed grant types, only for use with appType: 'web'
  
  Values may be any of: "client_credentials""urn:qlik:oauth:user-impersonation"
- OAuthClientBaseobject
  
  Response schema for reading an OAuth client
  Show OAuthClientBase properties
  
  appTypestring
  Required
  
  Application type
  
  Can be one of: "web""native""spa""anonymous-embed"
  
  maxLength = 64
  
  logoUristring
  
  URI for logo of client
  
  maxLength = 2048
  
  clientUristring
  
  URI for homepage of client
  
  maxLength = 2048
  
  createdAtstring
  Required
  
  The timestamp for when the oauth-clients record was created.
  
  format = "date-time"
  
  deletedAtstring
  
  The timestamp for when the oauth-clients record was deleted.
  
  format = "date-time"
  
  updatedAtstring
  
  The timestamp for when the oauth-clients record was updated.
  
  format = "date-time"
  
  clientNamestring
  Required
  
  Client application name
  
  maxLength = 512
  
  disableTagstring
  
  Is set if client disabled
  
  descriptionstring
  
  Client description
  
  maxLength = 4096
  
  publishedAtstring
  
  The timestamp which is set, if the client is published.
  
  format = "date-time"
  
  allowedScopesarray of strings
  
  List of allowed scopes for this client. For a full list of scopes see qlik.dev/authenticate/oauth/scopes/.
  
  allowedGrantTypesarray of strings
  
  Allowed grant types, only for use with appType: 'web'
  
  Values may be any of: "client_credentials""urn:qlik:oauth:user-impersonation"

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

GET /v1/oauth-clients/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients/{id}" \
-H "Authorization: Bearer <access_token>"

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

This API is not included yet in qlik-cli

Response

{
  "appType": "web",
  "logoUri": "string",
  "clientUri": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "deletedAt": "2018-10-30T07:06:22Z",
  "updatedAt": "2018-10-30T07:06:22Z",
  "clientName": "string",
  "disableTag": "string",
  "description": "string",
  "publishedAt": "2018-10-30T07:06:22Z",
  "allowedScopes": [
    "string"
  ],
  "allowedGrantTypes": [
    "client_credentials"
  ]
}

Updates the specified OAuth client.

Facts

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

Path Parameters

idstring
Required

The unique identifier for the OAuth client

Request Body

Required

application/json

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: "add""remove""replace"
- pathstring
  Required
  
  The path for the given resource field to patch
  
  Can be one of: "/allowedOrigins""/clientName""/clientUri""/description""/logoUri""/redirectUris""/allowedScopes""/allowedGrantTypes"
- valuestring|array
  
  The value to be used for this operation.
  
  One of:
  
  string
  
  array of strings

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

PATCH /v1/oauth-clients/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"add","path":"/allowedOrigins","value":"string"}]'

const https = require('https')
  const data = JSON.stringify([{"op":"add","path":"/allowedOrigins","value":"string"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/oauth-clients/{id}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

[
  {
    "op": "add",
    "path": "/allowedOrigins",
    "value": "string"
  }
]

Delete the specified OAuth client.

Facts

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

Header Parameters

qlik-confirm-deletestring
Required

A confirmation string that should match the id of the oauth-client resource to be deleted

Path Parameters

idstring
Required

The unique identifier for the OAuth client

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

DELETE /v1/oauth-clients/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients/{id}" \
-X DELETE \
-H "qlik-confirm-delete: string" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/oauth-clients/{id}',
    'method': 'DELETE',
    'headers': {
      'qlik-confirm-delete': 'string',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Publishes the specified OAuth client. By default, OAuth clients are bound to the tenant that created it. Publishing shares the client and makes it available to all other tenants within a region. Third-party applications connecting to Qlik Cloud can then have the same client ID for all Qlik Cloud tenants.

Facts

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

Path Parameters

idstring
Required

The unique identifier for the OAuth client

Responses

201

application/json

Created

Response schema for successfully publishing an OAuth client

application/jsonobject

Response schema for successfully publishing an OAuth client
Show application/json properties
- publishedAtstring
  Required
  
  The timestamp which is set, if the client is published.
  
  format = "date-time"

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

POST /v1/oauth-clients/{id}/actions/publish

curl "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients/{id}/actions/publish" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/oauth-clients/{id}/actions/publish',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "publishedAt": "2018-10-30T07:06:22Z"
}

Create a new client secret for the specified OAuth client. An OAuth client can have a maximum of 5 client secrets at one time.

Facts

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

Path Parameters

idstring
Required

The unique identifier for the OAuth client

Responses

201

application/json

Created

Response schema for creating an OAuth client application secret

application/jsonobject

Response schema for creating an OAuth client application secret
Show application/json properties
- hintstring
  Required
  
  Client application hint
- clientIdstring
  Required
  
  Client application id
- createdAtstring
  
  The timestamp for when the client-secret record was created.
  
  format = "date-time"
- createdBystring
  
  The identifier for the user that created the client-secret record.
- clientSecretstring
  Required
  
  Client application secret

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

409

application/json

The max number of client secrets is 5

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

POST /v1/oauth-clients/{id}/client-secrets

curl "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients/{id}/client-secrets" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/oauth-clients/{id}/client-secrets',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "hint": "string",
  "clientId": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "string",
  "clientSecret": "string"
}

Deletes a specific client secret for an OAuth client.

Facts

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

Path Parameters

hintstring
Required

The unique identifier for the OAuth secret
idstring
Required

The unique identifier for the OAuth client

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

DELETE /v1/oauth-clients/{id}/client-secrets/{hint}

curl "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients/{id}/client-secrets/{hint}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

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

This API is not included yet in qlik-cli

Get configuration for consent method and status.

Facts

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

Path Parameters

idstring
Required

The unique identifier for an OAuth client

Responses

200

application/json

Response schema for reading a connection config

application/jsonobject

Response schema for reading a connection config
Show application/json properties
- statusstring
  
  Status
- consentMethodstring
  Required
  
  Consent method
- deletedByOwnerboolean
  
  OAuth client has been deleted by owning tenant, only applies for published clients.

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

GET /v1/oauth-clients/{id}/connection-configs/me

curl "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients/{id}/connection-configs/me" \
-H "Authorization: Bearer <access_token>"

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

This API is not included yet in qlik-cli

Response

{
  "status": "string",
  "consentMethod": "string",
  "deletedByOwner": true
}

Updates the consent method for the specified OAuth client.

Facts

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

Path Parameters

idstring
Required

The unique identifier for the OAuth client

Request Body

Required

application/json

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
  
  The path for the given resource field to patch
  
  Can be one of: "/consentMethod"
- valuestring
  Required
  
  The value to be used for this operation.
  
  Can be one of: "required""trusted"

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

PATCH /v1/oauth-clients/{id}/connection-configs/me

curl "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients/{id}/connection-configs/me" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/consentMethod","value":"required"}]'

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"/consentMethod","value":"required"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/oauth-clients/{id}/connection-configs/me',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

[
  {
    "op": "replace",
    "path": "/consentMethod",
    "value": "required"
  }
]

Deletes the connection config for the calling tenant, related to the supplied client id.

Facts

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

Path Parameters

idstring
Required

The unique identifier for the OAuth client

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of the error
  
  detailstring
  
  Additional details about the error

DELETE /v1/oauth-clients/{id}/connection-configs/me

curl "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients/{id}/connection-configs/me" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

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

This API is not included yet in qlik-cli

OAuth clients

Endpoints

List OAuth clients

Facts

Query Parameters

Responses

200

401

403

500

503

Response

Create an OAuth client

Facts

Request Body

Responses

201

400

401

403

500

503

Request

Response

Get an OAuth client

Facts

Path Parameters

Responses

200

400

401

403

404

500

503

Response

Update an OAuth client

Facts

Path Parameters

Request Body

Responses

204

400

401

403

404

500

503

Request

Delete an OAuth client

Facts

Header Parameters

Path Parameters

Responses

204

400

401

403

404

500

503

Publish an OAuth client

Facts

Path Parameters

Responses

201

400

401

403

404

500

503

Response

Create an OAuth client secret

Facts

Path Parameters

Responses

201

400

401