OAuth well-known configuration

Returns OAuth 2.0 metadata related to your tenant. Clients can use this information to programmatically configure their interactions with Qlik Cloud.

Download OpenAPI spec

Get authorization server metadata

Returns authorization server metadata.

Facts

Rate limit Tier 1 (1000 requests per minute)

Responses

200

Returns authorization server metadata.

  • application/json object
    Show application/json properties
    • issuer string

      The issuer of the tokens.

    • jwks_uri string

      The public keys endpoint.

      format = "uri"

    • token_endpoint string

      The token endpoint.

      format = "uri"

    • revocation_endpoint string

      The token endpoint.

      format = "uri"

    • grant_types_supported array

      List of supported grant types.

    • registration_endpoint string

      The dynamic client registration endpoint.

      format = "uri"

    • authorization_endpoint string

      The authorization endpoint.

      format = "uri"

    • response_types_supported array

      List of supported authorization code responses.

    • client_id_metadata_document_supported boolean

      Advertises CIMD authentication support.

    • token_endpoint_auth_methods_supported array of strings

      List of supported OAuth client authentication methods.
GET /.well-known/oauth-authorization-server 
// qlik-api has not implemented support for `GET /.well-known/oauth-authorization-server` yet.
// In the meantime, you can use fetch like this:


const response = await fetch(
  '/.well-known/oauth-authorization-server',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)
# qlik-cli has not implemented support for GET /.well-known/oauth-authorization-server yet.
curl "https://{tenant}.{region}.qlikcloud.com/.well-known/oauth-authorization-server"

Example Response

{
  "issuer": "https://your-tenant.us.qlikcloud.com",
  "jwks_uri": "https://your-tenant.us.qlikcloud.com/.well-known/jwks.json",
  "token_endpoint": "https://your-tenant.us.qlikcloud.com/oauth/token",
  "revocation_endpoint": "https://your-tenant.us.qlikcloud.com/oauth/revoke",
  "grant_types_supported": [],
  "registration_endpoint": "https://your-tenant.us.qlikcloud.com/api/v1/oauth-clients/register",
  "authorization_endpoint": "https://your-tenant.us.qlikcloud.com/oauth/authorize",
  "response_types_supported": [],
  "client_id_metadata_document_supported": true,
  "token_endpoint_auth_methods_supported": [
    "client_secret_basic",
    "client_secret_post",
    "private_key_jwt",
    "none"
  ]
}