Skip to content

OAuth tokens

This API is used to interact with Edge Auth resources in Qlik elastic environments.

Endpoints

Skip to section
GET/v1/oauth-tokens
DELETE/v1/oauth-tokens/{tokenId}

List OAuth tokens

authenticate

Facts GET /v1/oauth-tokens

Rate limit
required
Tier 1 (1000 requests per minute)

Query Parameters GET /v1/oauth-tokens

limit
minimum=1, maximum=100
number

The maximum number of tokens to return.

page
string

The target page.

sort
default='userId'
string

The field to sort by.

Enum:

userId

userId
string

The ID of the user to limit results to.

Responses GET /v1/oauth-tokens

200
application/json

The page result.

400
application/json

Invalid request parameter for querying tokens.

401
application/json

Authentication failed.

GET/v1/oauth-tokens

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

Response GET /v1/oauth-tokens

{
  "data": [
    {
      "id": "string",
      "userId": "string",
      "lastUsed": "2023-11-29T00:09:22.925Z",
      "tenantId": "string",
      "deviceType": "string",
      "description": "string"
    }
  ],
  "links": {
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    },
    "self": {
      "href": "http://example.com"
    }
  }
}

Revoke an OAuth token by ID

authenticate

Facts DELETE /v1/oauth-tokens/{tokenId}

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/oauth-tokens/{tokenId}

tokenId
required
string<uid>

The ID of the token to revoke.

Responses DELETE /v1/oauth-tokens/{tokenId}

204
application/json
object

Token deleted successfully.

401
application/json

Authentication failed.

default
application/json

Unexpected error.

DELETE/v1/oauth-tokens/{tokenId}

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

Error

object

An error object.

Properties

code
required
string

The error code.

meta
object

Non-standard information about the error.

title
required
string

The error title.

detail
string

The detailed error message.

status
string

The http status code.

Errors

object

A representation of the errors encountered from the HTTP request.

Properties

errors

List of errors and their properties.

Properties

href
required
string<uri>

The URL for the link.

oauth-token

Properties

id
required
string

The token ID.

userId
required
string

The ID of the owning user.

lastUsed
string<date-time>

The last time the token was used.

tenantId
required
string

The ID of the owning tenant.

deviceType
string

The type of the user device the authorization token is generated for (Tablet, Phone etc.).

description
string

The description of the token.

oauth-token-page

object

Properties

data
required

No description

links
required

No description

v0.879.8
Was this page helpful?