Type Alias OauthClientsAPI

type OauthClientsAPI = {
    clearCache: typeof clearCache;
    createOAuthClient: typeof createOAuthClient;
    createOAuthClientSecret: typeof createOAuthClientSecret;
    deleteOAuthClient: typeof deleteOAuthClient;
    deleteOAuthClientConnectionConfig: typeof deleteOAuthClientConnectionConfig;
    deleteOAuthClientSecret: typeof deleteOAuthClientSecret;
    getOAuthClient: typeof getOAuthClient;
    getOAuthClientConnectionConfig: typeof getOAuthClientConnectionConfig;
    getOAuthClients: typeof getOAuthClients;
    patchOAuthClient: typeof patchOAuthClient;
    patchOAuthClientConnectionConfig: typeof patchOAuthClientConnectionConfig;
    publishOAuthClient: typeof publishOAuthClient;
}
Index

Properties

clearCache createOAuthClient createOAuthClientSecret deleteOAuthClient deleteOAuthClientConnectionConfig deleteOAuthClientSecret getOAuthClient getOAuthClientConnectionConfig getOAuthClients patchOAuthClient patchOAuthClientConnectionConfig publishOAuthClient

Properties

clearCache: typeof clearCache

Clears the cache for oauth-clients api requests.

createOAuthClient: typeof createOAuthClient

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.

Param: body

an object with the body content

CreateOAuthClientHttpError

createOAuthClientSecret: typeof createOAuthClientSecret

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

The unique identifier for the OAuth client

CreateOAuthClientSecretHttpError

deleteOAuthClient: typeof deleteOAuthClient

Delete the specified OAuth client.

The unique identifier for the OAuth client

DeleteOAuthClientHttpError

deleteOAuthClientConnectionConfig: typeof deleteOAuthClientConnectionConfig

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

The unique identifier for the OAuth client

DeleteOAuthClientConnectionConfigHttpError

deleteOAuthClientSecret: typeof deleteOAuthClientSecret

Deletes a specific client secret for an OAuth client.

The unique identifier for the OAuth client

The unique identifier for the OAuth secret

DeleteOAuthClientSecretHttpError

getOAuthClient: typeof getOAuthClient

Retrieves the specified OAuth client.

The unique identifier for the OAuth client

GetOAuthClientHttpError

getOAuthClientConnectionConfig: typeof getOAuthClientConnectionConfig

Get configuration for consent method and status.

The unique identifier for an OAuth client

GetOAuthClientConnectionConfigHttpError

getOAuthClients: typeof getOAuthClients

Retrieve all OAuth clients.

getOAuthClients(
  {
    filter: "appType eq \"spa\" and clientId eq \"b3ee66d6f21d1611efa89a425f656f6f\"",
    totalResults: true
  }
)

an object with query parameters

GetOAuthClientsHttpError

patchOAuthClient: typeof patchOAuthClient

Updates the specified OAuth client.

The unique identifier for the OAuth client

Param: body

an object with the body content

PatchOAuthClientHttpError

patchOAuthClientConnectionConfig: typeof patchOAuthClientConnectionConfig

Updates the consent method for the specified OAuth client.

The unique identifier for the OAuth client

Param: body

an object with the body content

PatchOAuthClientConnectionConfigHttpError

publishOAuthClient: typeof publishOAuthClient

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.

The unique identifier for the OAuth client

PublishOAuthClientHttpError

Settings

Member Visibility

On This Page

Properties