auth0 3.4.0 → 4.0.0-beta.1

package/dist/typings/lib/runtime.d.ts

@@ -0,0 +1,69 @@
+import type { RequestInit, Blob as BlobType } from 'node-fetch';
+import { Response } from 'node-fetch';
+import { RequestOpts, InitOverrideFunction, Configuration } from './models.js';
+import FormData from 'form-data';
+export { FormData, BlobType as Blob };
+export * from './models.js';
+/**
+ * @private
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private middleware;
+    private fetchApi;
+    private parseError;
+    private timeoutDuration;
+    constructor(configuration: Configuration);
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchWithTimeout;
+    private fetch;
+}
+/**
+ * @private
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ * @private
+ */
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+/**
+ * @private
+ */
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+/**
+ * @private
+ */
+export interface Consume {
+    contentType: string;
+}
+/**
+ * @private
+ */
+export declare function validateRequiredRequestParams<TRequestParams extends {
+    [key: string]: any;
+}>(requestParameters: TRequestParams, keys: Array<Extract<keyof TRequestParams, string>>): void;
+type QueryParamConfig = {
+    isArray?: boolean;
+    isCollectionFormatMulti?: boolean;
+    collectionFormat?: keyof typeof COLLECTION_FORMATS;
+};
+/**
+ * @private
+ */
+export declare function applyQueryParams<TRequestParams extends {
+    [key: string]: any;
+}, Key extends Extract<keyof TRequestParams, string>>(requestParameters: TRequestParams, keys: Array<{
+    key: Key;
+    config: QueryParamConfig;
+}>): Pick<TRequestParams, Key>;
+/**
+ * @private
+ */
+export declare function parseFormParam(originalValue: unknown): unknown;

package/dist/typings/management/__generated/index.d.ts

@@ -0,0 +1,39 @@
+export * from './managers/index.js';
+export * from './models/index.js';
+import { ActionsManager, AnomalyManager, AttackProtectionManager, BlacklistsManager, BrandingManager, ClientGrantsManager, ClientsManager, ConnectionsManager, CustomDomainsManager, DeviceCredentialsManager, EmailTemplatesManager, EmailsManager, GrantsManager, GuardianManager, HooksManager, JobsManager, KeysManager, LogStreamsManager, LogsManager, OrganizationsManager, PromptsManager, ResourceServersManager, RolesManager, RulesManager, RulesConfigsManager, StatsManager, TenantsManager, TicketsManager, UserBlocksManager, UsersManager, UsersByEmailManager } from './managers/index.js';
+import { Configuration } from '../../lib/runtime.js';
+export declare abstract class ManagementClientBase {
+    protected configuration: Configuration;
+    readonly actions: ActionsManager;
+    readonly anomaly: AnomalyManager;
+    readonly attackProtection: AttackProtectionManager;
+    readonly blacklists: BlacklistsManager;
+    readonly branding: BrandingManager;
+    readonly clientGrants: ClientGrantsManager;
+    readonly clients: ClientsManager;
+    readonly connections: ConnectionsManager;
+    readonly customDomains: CustomDomainsManager;
+    readonly deviceCredentials: DeviceCredentialsManager;
+    readonly emailTemplates: EmailTemplatesManager;
+    readonly emails: EmailsManager;
+    readonly grants: GrantsManager;
+    readonly guardian: GuardianManager;
+    readonly hooks: HooksManager;
+    readonly jobs: JobsManager;
+    readonly keys: KeysManager;
+    readonly logStreams: LogStreamsManager;
+    readonly logs: LogsManager;
+    readonly organizations: OrganizationsManager;
+    readonly prompts: PromptsManager;
+    readonly resourceServers: ResourceServersManager;
+    readonly roles: RolesManager;
+    readonly rules: RulesManager;
+    readonly rulesConfigs: RulesConfigsManager;
+    readonly stats: StatsManager;
+    readonly tenants: TenantsManager;
+    readonly tickets: TicketsManager;
+    readonly userBlocks: UserBlocksManager;
+    readonly users: UsersManager;
+    readonly usersByEmail: UsersByEmailManager;
+    constructor(configuration: Configuration);
+}

package/dist/typings/management/__generated/managers/actions-manager.d.ts

@@ -0,0 +1,136 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { GetActionVersions200Response, GetActionVersions200ResponseVersionsInner, GetActions200Response, GetActions200ResponseActionsInner, GetBindings200Response, GetExecution200Response, GetTriggers200Response, PatchActionRequest, PatchBindings200Response, PatchBindingsRequest, PostActionRequest, PostDeployDraftVersionRequest, PostTestAction200Response, PostTestActionRequest, DeleteActionRequest, GetActionRequest, GetActionVersionRequest, GetActionVersionsRequest, GetActionsRequest, GetBindingsRequest, GetExecutionRequest, PatchActionOperationRequest, PatchBindingsOperationRequest, PostDeployActionRequest, PostDeployDraftVersionOperationRequest, PostTestActionOperationRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class ActionsManager extends BaseAPI {
+    /**
+     * Deletes an action and all of its associated versions. An action must be unbound from all triggers
+     * before it can be deleted.
+     *
+     * Delete an action
+     *
+     * @throws {RequiredError}
+     */
+    delete(requestParameters: DeleteActionRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Retrieve an action by its ID.
+     *
+     * Get an action
+     *
+     * @throws {RequiredError}
+     */
+    get(requestParameters: GetActionRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetActions200ResponseActionsInner>>;
+    /**
+     * Retrieve a specific version of an action. An action version is created whenever
+     * an action is deployed. An action version is immutable, once created.
+     *
+     * Get a specific version of an action
+     *
+     * @throws {RequiredError}
+     */
+    getVersion(requestParameters: GetActionVersionRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetActionVersions200ResponseVersionsInner>>;
+    /**
+     * Retrieve all of an action's versions. An action version is created whenever
+     * an action is deployed. An action version is immutable, once created.
+     *
+     * Get an action's versions
+     *
+     * @throws {RequiredError}
+     */
+    getVersions(requestParameters: GetActionVersionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetActionVersions200Response>>;
+    /**
+     * Retrieve all actions.
+     *
+     * Get actions
+     *
+     * @throws {RequiredError}
+     */
+    getAll(requestParameters?: GetActionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetActions200Response>>;
+    /**
+     * Retrieve the actions that are bound to a trigger. Once an action is created and deployed, it must be
+     * attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned
+     * reflects the order in which they will be executed during the appropriate flow.
+     *
+     * Get trigger bindings
+     *
+     * @throws {RequiredError}
+     */
+    getTriggerBindings(requestParameters: GetBindingsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetBindings200Response>>;
+    /**
+     * Retrieve information about a specific execution of a trigger. Relevant execution IDs will be included in tenant logs
+     * generated as part of that authentication flow. Executions will only be stored for 10 days after their creation.
+     *
+     * Get an execution
+     *
+     * @throws {RequiredError}
+     */
+    getExecution(requestParameters: GetExecutionRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetExecution200Response>>;
+    /**
+     * Retrieve the set of triggers currently available within actions. A trigger is an extensibility point to which actions
+     * can be bound.
+     *
+     * Get triggers
+     *
+     * @throws {RequiredError}
+     */
+    getAllTriggers(initOverrides?: InitOverride): Promise<ApiResponse<GetTriggers200Response>>;
+    /**
+     * Update an existing action. If this action is currently bound to a trigger, updating it will <strong>not</strong> affect
+     * any user flows until the action is deployed.
+     *
+     * Update an action
+     *
+     * @throws {RequiredError}
+     */
+    update(requestParameters: PatchActionOperationRequest, bodyParameters: PatchActionRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetActions200ResponseActionsInner>>;
+    /**
+     * Update the actions that are bound (i.e. attached) to a trigger. Once an action is created and deployed, it must be
+     * attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The order in which the actions are
+     * provided will determine the order in which they are executed.
+     *
+     * Update trigger bindings
+     *
+     * @throws {RequiredError}
+     */
+    updateTriggerBindings(requestParameters: PatchBindingsOperationRequest, bodyParameters: PatchBindingsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PatchBindings200Response>>;
+    /**
+     * Create an action. Once an action is created, it must be deployed, and then
+     * bound to a trigger before it will be executed as part of a flow.
+     *
+     * Create an action
+     *
+     * @throws {RequiredError}
+     */
+    create(bodyParameters: PostActionRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetActions200ResponseActionsInner>>;
+    /**
+     * Deploy an action. Deploying an action will create a new immutable version of the action. If the action is
+     * currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately. Otherwise, the action will only be executed as a part of a flow once it is bound to that flow.
+     *
+     * Deploy an action
+     *
+     * @throws {RequiredError}
+     */
+    deploy(requestParameters: PostDeployActionRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetActionVersions200ResponseVersionsInner>>;
+    /**
+     * Performs the equivalent of a roll-back of an action to an earlier, specified version. Creates a new, deployed
+     * action version that is identical to the specified version. If this action is currently bound to a trigger, the
+     * system will begin executing the newly-created version immediately.
+     *
+     * Roll back to a previous action version
+     *
+     * @throws {RequiredError}
+     */
+    deployVersion(requestParameters: PostDeployDraftVersionOperationRequest, bodyParameters: PostDeployDraftVersionRequest | null, initOverrides?: InitOverride): Promise<ApiResponse<GetActionVersions200ResponseVersionsInner>>;
+    /**
+     * Test an action. After updating an action, it can be tested prior to being deployed to ensure it behaves as expected.
+     *
+     * Test an Action
+     *
+     * @throws {RequiredError}
+     */
+    test(requestParameters: PostTestActionOperationRequest, bodyParameters: PostTestActionRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostTestAction200Response>>;
+}
+export {};

package/dist/typings/management/__generated/managers/anomaly-manager.d.ts

@@ -0,0 +1,24 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { DeleteIpsByIdRequest, GetIpsByIdRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class AnomalyManager extends BaseAPI {
+    /**
+     * Unblock an IP address currently blocked by the <a href="https://auth0.com/docs/configure/attack-protection/suspicious-ip-throttling">Suspicious IP Throttling</a> due to multiple suspicious attempts.
+     * Remove the blocked IP address
+     *
+     * @throws {RequiredError}
+     */
+    deleteBlockedIp(requestParameters: DeleteIpsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Check if a given IP address is blocked via the <a href="https://auth0.com/docs/configure/attack-protection/suspicious-ip-throttling">Suspicious IP Throttling</a> due to multiple suspicious attempts.
+     * Check if an IP address is blocked
+     *
+     * @throws {RequiredError}
+     */
+    checkIfIpIsBlocked(requestParameters: GetIpsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+}
+export {};

package/dist/typings/management/__generated/managers/attack-protection-manager.d.ts

@@ -0,0 +1,52 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { PatchBreachedPasswordDetectionRequest, PatchBruteForceProtectionRequest, PatchSuspiciousIpThrottlingRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class AttackProtectionManager extends BaseAPI {
+    /**
+     * Get breached password detection settings
+     *
+     * @throws {RequiredError}
+     */
+    getBreachedPasswordDetectionConfig(initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Get the brute force configuration
+     *
+     * @throws {RequiredError}
+     */
+    getBruteForceConfig(initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Get the brute force configuration defaults
+     *
+     * @throws {RequiredError}
+     */
+    getBruteForceDefaults(initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Get the suspicious IP throttling configuration
+     *
+     * @throws {RequiredError}
+     */
+    getSuspiciousIpThrottlingConfig(initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Update breached password detection settings
+     *
+     * @throws {RequiredError}
+     */
+    updateBreachedPasswordDetectionConfig(bodyParameters: PatchBreachedPasswordDetectionRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Update the brute force configuration
+     *
+     * @throws {RequiredError}
+     */
+    updateBruteForceConfig(bodyParameters: PatchBruteForceProtectionRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Update the suspicious IP throttling configuration
+     *
+     * @throws {RequiredError}
+     */
+    updateSuspiciousIpThrottlingConfig(bodyParameters: PatchSuspiciousIpThrottlingRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+}
+export {};

package/dist/typings/management/__generated/managers/blacklists-manager.d.ts

@@ -0,0 +1,28 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { Token, GetTokensRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class BlacklistsManager extends BaseAPI {
+    /**
+     * Retrieve the `jti` and `aud` of all tokens that are blacklisted.
+     *
+     * Note: The <a href="https://auth0.com/docs/jwt">JWT specification</a> states that the `jti` field can be used to prevent replay attacks. Though Auth0 tokens do not include a `jti`, you can nevertheless blacklist a `jti` to prevent a token being used more than a predetermined number of times. This behavior is similar to implementing a nonce (where the token's signature can be thought of as the nonce). If a token gets stolen, it (or the tokens issued after it) should be blacklisted and let expire.
+     *
+     * Get blacklisted tokens
+     *
+     * @throws {RequiredError}
+     */
+    getAll(requestParameters?: GetTokensRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Token>>>;
+    /**
+     * Add the token identified by the `jti` to a blacklist for the tenant.
+     *
+     * Blacklist a token
+     *
+     * @throws {RequiredError}
+     */
+    add(bodyParameters: Token, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+}
+export {};

package/dist/typings/management/__generated/managers/branding-manager.d.ts

@@ -0,0 +1,103 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { GetBranding200Response, GetUniversalLogin200Response, PatchBrandingRequest, PostBrandingTheme200Response, PostBrandingThemeRequest, PutUniversalLoginRequest, DeleteBrandingThemeRequest, GetBrandingThemeRequest, PatchBrandingThemeRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class BrandingManager extends BaseAPI {
+    /**
+     * Delete branding theme.
+     * Delete branding theme
+     *
+     * @throws {RequiredError}
+     */
+    deleteTheme(requestParameters: DeleteBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Delete template for New Universal Login Experience
+     *
+     * @throws {RequiredError}
+     */
+    deleteUniversalLoginTemplate(initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Retrieve branding settings.
+     * Get branding settings
+     *
+     * @throws {RequiredError}
+     */
+    getSettings(initOverrides?: InitOverride): Promise<ApiResponse<GetBranding200Response>>;
+    /**
+     * Retrieve branding theme.
+     * Get branding theme
+     *
+     * @throws {RequiredError}
+     */
+    getTheme(requestParameters: GetBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
+    /**
+     * Retrieve default branding theme.
+     * Get default branding theme
+     *
+     * @throws {RequiredError}
+     */
+    getDefaultTheme(initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
+    /**
+     * Get template for New Universal Login Experience
+     *
+     * @throws {RequiredError}
+     */
+    getUniversalLoginTemplate(initOverrides?: InitOverride): Promise<ApiResponse<GetUniversalLogin200Response>>;
+    /**
+     * Update branding settings.
+     * Update branding settings
+     *
+     * @throws {RequiredError}
+     */
+    updateSettings(bodyParameters: PatchBrandingRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetBranding200Response>>;
+    /**
+     * Update branding theme.
+     * Update branding theme
+     *
+     * @throws {RequiredError}
+     */
+    updateTheme(requestParameters: PatchBrandingThemeRequest, bodyParameters: PostBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
+    /**
+     * Create branding theme.
+     * Create branding theme
+     *
+     * @throws {RequiredError}
+     */
+    createTheme(bodyParameters: PostBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
+    /**
+     * Update the Universal Login branding template.
+     *
+     * <p>When <code>content-type</code> header is set to <code>application/json</code>, the expected body must be JSON:</p>
+     * <pre>
+     * {
+     *   "template": "&lt;!DOCTYPE html&gt;&lt;html&gt;&lt;head&gt;{%- auth0:head -%}&lt;/head&gt;&lt;body&gt;{%- auth0:widget -%}&lt;/body&gt;&lt;/html&gt;"
+     * }
+     * </pre>
+     *
+     * <p>
+     *   When <code>content-type</code> header is set to <code>text/html</code>, the expected body must be the HTML template:
+     * </p>
+     * <pre>
+     * &lt!DOCTYPE html&gt;
+     * &lt;code&gt;
+     *   &lt;html&gt;
+     *     &lt;head&gt;
+     *      {%- auth0:head -%}
+     *     &lt;/head&gt;
+     *     &lt;body&gt;
+     *       {%- auth0:widget -%}
+     *     &lt;/body&gt;
+     *   &lt;/html&gt;
+     * &lt;/code&gt;
+     * </pre>
+     *
+     * Set template for New Universal Login Experience
+     *
+     * @throws {RequiredError}
+     */
+    setUniversalLoginTemplate(bodyParameters: PutUniversalLoginRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+}
+export {};

package/dist/typings/management/__generated/managers/client-grants-manager.d.ts

@@ -0,0 +1,42 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { ClientGrant, ClientGrantCreate, PatchClientGrantsByIdRequest, GetClientGrants200ResponseOneOf, DeleteClientGrantsByIdRequest, GetClientGrantsRequest, PatchClientGrantsByIdOperationRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class ClientGrantsManager extends BaseAPI {
+    /**
+     * Delete a client grant.
+     * Delete client grant
+     *
+     * @throws {RequiredError}
+     */
+    delete(requestParameters: DeleteClientGrantsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Retrieve <a href="https://auth0.com/docs/api-auth/grant/client-credentials">client grants</a>.
+     *
+     * Get client grants
+     *
+     * @throws {RequiredError}
+     */
+    getAll(requestParameters: GetClientGrantsRequest & {
+        include_totals: true;
+    }, initOverrides?: InitOverride): Promise<ApiResponse<GetClientGrants200ResponseOneOf>>;
+    getAll(requestParameters?: GetClientGrantsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<ClientGrant>>>;
+    /**
+     * Update a client grant.
+     * Update client grant
+     *
+     * @throws {RequiredError}
+     */
+    update(requestParameters: PatchClientGrantsByIdOperationRequest, bodyParameters: PatchClientGrantsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<ClientGrant>>;
+    /**
+     * Create a client grant.
+     * Create client grant
+     *
+     * @throws {RequiredError}
+     */
+    create(bodyParameters: ClientGrantCreate, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+}
+export {};

package/dist/typings/management/__generated/managers/clients-manager.d.ts

@@ -0,0 +1,119 @@
+import * as runtime from '../../../lib/runtime.js';
+import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
+import type { Client, ClientCreate, ClientUpdate, DeleteClientsByIdRequest, GetClientsRequest, GetClientsByIdRequest, PatchClientsByIdRequest, PostRotateSecretRequest } from '../models/index.js';
+declare const BaseAPI: typeof runtime.BaseAPI;
+/**
+ *
+ */
+export declare class ClientsManager extends BaseAPI {
+    /**
+     * Delete a client and related configuration (rules, connections, etc).
+     * Delete a client
+     *
+     * @throws {RequiredError}
+     */
+    delete(requestParameters: DeleteClientsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
+    /**
+     * Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude
+     * may also be specified. Note:
+     * <ul>
+     *   <li>
+     *     <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code> can be retrieved with
+     *     any scope.
+     *   </li>
+     *   <li>
+     *     <code>callbacks</code>, <code>oidc_backchannel_logout</code>, <code>allowed_origins</code>,
+     *     <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
+     *     <code>callback_url_template</code>, <code>jwt_configuration</code>,
+     *     <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
+     *     <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
+     *     <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
+     *     <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
+     *     <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
+     *     <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
+     *     <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
+     *     <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
+     *     <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
+     *     <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>, and
+     *     <code>organization_require_behavior</code> properties can only be retrieved with the <code>read:clients</code> or
+     *     <code>read:client_keys</code> scope.
+     *   </li>
+     *   <li>
+     *     <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
+     *     <code>client_secret</code>, and <code>signing_key</code> properties can only be retrieved with the
+     *     <code>read:client_keys</code> scope.
+     *   </li>
+     * </ul>
+     *
+     * Get clients
+     *
+     * @throws {RequiredError}
+     */
+    getAll(requestParameters?: GetClientsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Client>>>;
+    /**
+     * Retrieve client details. A list of fields to include or exclude may also be specified. Note:
+     * <ul>
+     *   <li>
+     *     <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code> can be retrieved with
+     *     the any of the scopes.
+     *   </li>
+     *   <li>
+     *     <code>callbacks</code>, <code>oidc_backchannel_logout</code>, <code>allowed_origins</code>,
+     *     <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
+     *     <code>callback_url_template</code>, <code>jwt_configuration</code>,
+     *     <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
+     *     <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
+     *     <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
+     *     <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
+     *     <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
+     *     <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
+     *     <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
+     *     <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
+     *     <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
+     *     <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>, and
+     *     <code>organization_require_behavior</code> properties can only be retrieved with the <code>read:clients</code> or
+     *     <code>read:client_keys</code> scope.
+     *   </li>
+     *   <li>
+     *     <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
+     *     <code>client_secret</code>, and <code>signing_key</code> properties can only be retrieved with the
+     *     <code>read:client_keys</code> scope.
+     *   </li>
+     * </ul>
+     *
+     * Get a client
+     *
+     * @throws {RequiredError}
+     */
+    get(requestParameters: GetClientsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
+    /**
+     * Note: The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
+     * Update a client
+     *
+     * @throws {RequiredError}
+     */
+    update(requestParameters: PatchClientsByIdRequest, bodyParameters: ClientUpdate, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
+    /**
+     * Create a new client (application or SSO integration).
+     *
+     * Note: We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
+     *
+     * <div class="alert alert-warning">SSO Integrations created via this endpoint will accept login requests and share user profile information.</div>
+     *
+     * Create a client
+     *
+     * @throws {RequiredError}
+     */
+    create(bodyParameters: ClientCreate, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
+    /**
+     * Rotate a client secret.
+     *
+     * Note: The generated secret is NOT base64 encoded.
+     *
+     * Rotate a client secret
+     *
+     * @throws {RequiredError}
+     */
+    rotateClientSecret(requestParameters: PostRotateSecretRequest, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
+}
+export {};