Interface OauthClientsAPI

interface OauthClientsAPI {
    clearCache: () => void;
    createOAuthClient: (
        body: OAuthClientCreateRequest,
        options?: ApiCallOptions,
    ) => Promise<CreateOAuthClientHttpResponse>;
    createOAuthClientSecret: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<CreateOAuthClientSecretHttpResponse>;
    deleteOAuthClient: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteOAuthClientHttpResponse>;
    deleteOAuthClientConnectionConfig: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteOAuthClientConnectionConfigHttpResponse>;
    deleteOAuthClientSecret: (
        id: string,
        hint: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteOAuthClientSecretHttpResponse>;
    getOAuthClient: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetOAuthClientHttpResponse>;
    getOAuthClientConnectionConfig: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetOAuthClientConnectionConfigHttpResponse>;
    getOAuthClients: (
        query: {
            filter?: string;
            limit?: number;
            next?: string;
            prev?: string;
            sort?: string;
            totalResults?: boolean;
        },
        options?: ApiCallOptions,
    ) => Promise<GetOAuthClientsHttpResponse>;
    patchOAuthClient: (
        id: string,
        body: OAuthClientUpdate[],
        options?: ApiCallOptions,
    ) => Promise<PatchOAuthClientHttpResponse>;
    patchOAuthClientConnectionConfig: (
        id: string,
        body: OAuthConnectionConfigUpdate[],
        options?: ApiCallOptions,
    ) => Promise<PatchOAuthClientConnectionConfigHttpResponse>;
    publishOAuthClient: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<PublishOAuthClientHttpResponse>;
}
Index

Properties

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

Properties

clearCache: () => void

Clears the cache for oauth-clients api requests.

Type declaration

    • (): void

    • Clears the cache for oauth-clients api requests.

      Returns void

createOAuthClient: (
    body: OAuthClientCreateRequest,
    options?: ApiCallOptions,
) => Promise<CreateOAuthClientHttpResponse>

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.

Type declaration

    • (
          body: OAuthClientCreateRequest,
          options?: ApiCallOptions,
      ): Promise<CreateOAuthClientHttpResponse>

    • 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.

      Parameters

      Returns Promise<CreateOAuthClientHttpResponse>

      CreateOAuthClientHttpError

Param: body

an object with the body content

CreateOAuthClientHttpError

createOAuthClientSecret: (
    id: string,
    options?: ApiCallOptions,
) => Promise<CreateOAuthClientSecretHttpResponse>

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

Type declaration

The unique identifier for the OAuth client

CreateOAuthClientSecretHttpError

deleteOAuthClient: (
    id: string,
    options?: ApiCallOptions,
) => Promise<DeleteOAuthClientHttpResponse>

Delete the specified OAuth client.

Type declaration

The unique identifier for the OAuth client

DeleteOAuthClientHttpError

deleteOAuthClientConnectionConfig: (
    id: string,
    options?: ApiCallOptions,
) => Promise<DeleteOAuthClientConnectionConfigHttpResponse>

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

Type declaration

The unique identifier for the OAuth client

DeleteOAuthClientConnectionConfigHttpError

deleteOAuthClientSecret: (
    id: string,
    hint: string,
    options?: ApiCallOptions,
) => Promise<DeleteOAuthClientSecretHttpResponse>

Deletes a specific client secret for an OAuth client.

Type declaration

The unique identifier for the OAuth client

The unique identifier for the OAuth secret

DeleteOAuthClientSecretHttpError

getOAuthClient: (
    id: string,
    options?: ApiCallOptions,
) => Promise<GetOAuthClientHttpResponse>

Retrieves the specified OAuth client.

Type declaration

The unique identifier for the OAuth client

GetOAuthClientHttpError

getOAuthClientConnectionConfig: (
    id: string,
    options?: ApiCallOptions,
) => Promise<GetOAuthClientConnectionConfigHttpResponse>

Get configuration for consent method and status.

Type declaration

The unique identifier for an OAuth client

GetOAuthClientConnectionConfigHttpError

getOAuthClients: (
    query: {
        filter?: string;
        limit?: number;
        next?: string;
        prev?: string;
        sort?: string;
        totalResults?: boolean;
    },
    options?: ApiCallOptions,
) => Promise<GetOAuthClientsHttpResponse>

Retrieve all OAuth clients.

Type declaration

    • (
          query: {
              filter?: string;
              limit?: number;
              next?: string;
              prev?: string;
              sort?: string;
              totalResults?: boolean;
          },
          options?: ApiCallOptions,
      ): Promise<GetOAuthClientsHttpResponse>

    • Retrieve all OAuth clients.

      Parameters

      • query: {
            filter?: string;
            limit?: number;
            next?: string;
            prev?: string;
            sort?: string;
            totalResults?: boolean;
        }

        an object with query parameters

        • Optionalfilter?: string

          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.

        • Optionallimit?: number

          The number of OAuth client entries to retrieve.

        • Optionalnext?: string

          The next page cursor

        • Optionalprev?: string

          The previous page cursor

        • Optionalsort?: string

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

        • OptionaltotalResults?: boolean

          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.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetOAuthClientsHttpResponse>

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

      GetOAuthClientsHttpError

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

an object with query parameters

GetOAuthClientsHttpError

patchOAuthClient: (
    id: string,
    body: OAuthClientUpdate[],
    options?: ApiCallOptions,
) => Promise<PatchOAuthClientHttpResponse>

Updates the specified OAuth client.

Type declaration

The unique identifier for the OAuth client

Param: body

an object with the body content

PatchOAuthClientHttpError

patchOAuthClientConnectionConfig: (
    id: string,
    body: OAuthConnectionConfigUpdate[],
    options?: ApiCallOptions,
) => Promise<PatchOAuthClientConnectionConfigHttpResponse>

Updates the consent method for the specified OAuth client.

Type declaration

The unique identifier for the OAuth client

Param: body

an object with the body content

PatchOAuthClientConnectionConfigHttpError

publishOAuthClient: (
    id: string,
    options?: ApiCallOptions,
) => Promise<PublishOAuthClientHttpResponse>

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.

Type declaration

    • (id: string, options?: ApiCallOptions): Promise<PublishOAuthClientHttpResponse>

    • 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.

      Parameters

      • id: string

        The unique identifier for the OAuth client

      • Optionaloptions: ApiCallOptions

      Returns Promise<PublishOAuthClientHttpResponse>

      PublishOAuthClientHttpError

The unique identifier for the OAuth client

PublishOAuthClientHttpError

Settings

Member Visibility

On This Page

Properties