@extrahorizon/javascript-sdk 8.2.0 → 8.2.1-dev-49-61b4511

package/build/types/services/auth/oauth2/types.d.ts

@@ -1,52 +1,52 @@
-import { AffectedRecords, OptionsBase, OptionsWithRql, PagedResult } from '../../types';
-export interface AuthOauth2Service {
-    /**
-     * Create an OAuth2 authorization
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Everyone can use this endpoint
-     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/OAuth2/post_oauth2_authorizations
-     * @throws {ApplicationUnknownError}
-     * @throws {CallbackNotValidError}
-     * @throws {UnsupportedResponseTypeError}
-     */
-    createAuthorization(data: OAuth2AuthorizationCreation, options?: OptionsBase): Promise<OAuth2Authorization>;
-    /**
-     * Get a list of OAuth2 Authorizations
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * VIEW_AUTHORIZATIONS | global | **Required** for this endpoint
-     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/OAuth2/get_oauth2_authorizations
-     */
-    getAuthorizations(options?: OptionsWithRql): Promise<PagedResult<OAuth2Authorization>>;
-    /**
-     * Delete an OAuth2 Authorization
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * DELETE_AUTHORIZATIONS | global | **Required** for this endpoint
-     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/OAuth2/delete_oauth2_authorizations__authorizationId_
-     * @throws {ResourceUnknownError}
-     */
-    deleteAuthorization(authorizationId: string, options?: OptionsWithRql): Promise<AffectedRecords>;
-}
-export interface OAuth2AuthorizationCreation {
-    responseType: string;
-    clientId: string;
-    redirectUri: string;
-    state: string;
-    scope: string;
-}
-export interface OAuth2Authorization {
-    id: string;
-    userId: string;
-    clientId: string;
-    authorizationCode: string;
-    state: string;
-    /** The timestamp when the authorization was last updated */
-    updateTimestamp?: Date;
-    /** The timestamp when the authorization was created */
-    creationTimestamp?: Date;
-}
+import { AffectedRecords, OptionsBase, OptionsWithRql, PagedResult } from '../../types';
+export interface AuthOauth2Service {
+    /**
+     * Create an OAuth2 authorization
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | | Everyone can use this endpoint
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/OAuth2/post_oauth2_authorizations
+     * @throws {ApplicationUnknownError}
+     * @throws {CallbackNotValidError}
+     * @throws {UnsupportedResponseTypeError}
+     */
+    createAuthorization(data: OAuth2AuthorizationCreation, options?: OptionsBase): Promise<OAuth2Authorization>;
+    /**
+     * Get a list of OAuth2 Authorizations
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * VIEW_AUTHORIZATIONS | global | **Required** for this endpoint
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/OAuth2/get_oauth2_authorizations
+     */
+    getAuthorizations(options?: OptionsWithRql): Promise<PagedResult<OAuth2Authorization>>;
+    /**
+     * Delete an OAuth2 Authorization
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * DELETE_AUTHORIZATIONS | global | **Required** for this endpoint
+     * @see https://swagger.extrahorizon.com/swagger-ui/?url=https://swagger.extrahorizon.com/auth-service/2.0.4-dev/openapi.yaml#/OAuth2/delete_oauth2_authorizations__authorizationId_
+     * @throws {ResourceUnknownError}
+     */
+    deleteAuthorization(authorizationId: string, options?: OptionsWithRql): Promise<AffectedRecords>;
+}
+export interface OAuth2AuthorizationCreation {
+    responseType: string;
+    clientId: string;
+    redirectUri: string;
+    state: string;
+    scope: string;
+}
+export interface OAuth2Authorization {
+    id: string;
+    userId: string;
+    clientId: string;
+    authorizationCode: string;
+    state: string;
+    /** The timestamp when the authorization was last updated */
+    updateTimestamp?: Date;
+    /** The timestamp when the authorization was created */
+    creationTimestamp?: Date;
+}

package/build/types/services/auth/oidc/index.d.ts

@@ -1,5 +1,5 @@
-import { HttpInstance } from '../../../types';
-import { HttpClient } from '../../http-client';
-import { OidcService } from './types';
-declare const _default: (oidcClient: HttpClient, httpWithAuth: HttpInstance) => OidcService;
-export default _default;
+import { HttpInstance } from '../../../types';
+import { HttpClient } from '../../http-client';
+import { OidcService } from './types';
+declare const _default: (oidcClient: HttpClient, httpWithAuth: HttpInstance) => OidcService;
+export default _default;

package/build/types/services/auth/oidc/loginAttempts/index.d.ts

@@ -1,5 +1,5 @@
-import { HttpInstance } from '../../../../http/types';
-import { HttpClient } from '../../../http-client';
-import { LoginAttemptsService } from './types';
-declare const _default: (oidcClient: HttpClient, httpWithAuth: HttpInstance) => LoginAttemptsService;
-export default _default;
+import { HttpInstance } from '../../../../http/types';
+import { HttpClient } from '../../../http-client';
+import { LoginAttemptsService } from './types';
+declare const _default: (oidcClient: HttpClient, httpWithAuth: HttpInstance) => LoginAttemptsService;
+export default _default;

package/build/types/services/auth/oidc/loginAttempts/types.d.ts

@@ -1,67 +1,67 @@
-import { FindAllIterator } from '../../../helpers';
-import { OptionsWithRql, PagedResultWithPager } from '../../../types';
-export interface LoginAttemptsService {
-    /**
-     * ## Retrieve a paged list of login attempts
-     *
-     * **Global Permissions:**
-     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns A paged list of login attempts {@link PagedResultWithPager PagedResultWithPager<LoginAttempt>}
-     */
-    find(options?: OptionsWithRql): Promise<PagedResultWithPager<LoginAttempt>>;
-    /**
-     * ## Retrieve a list of all login attempts
-     *
-     * **Global Permissions:**
-     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns An array of login attempts {@link LoginAttempt LoginAttempt[]}
-     * @throws {@link Error} Do not pass in limit operator with findAll
-     */
-    findAll(options?: OptionsWithRql): Promise<LoginAttempt[]>;
-    /**
-     * ## Retrieve a paged list of login attempts
-     *
-     * **Global Permissions:**
-     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns An iterator for the queried login attempts {@link FindAllIterator FindAllIterator<LoginAttempt>}
-     */
-    findAllIterator(options?: OptionsWithRql): FindAllIterator<LoginAttempt>;
-    /**
-     * ## Retrieve the first queried login attempt
-     *
-     * **Global Permissions:**
-     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns The first element of the queried login attempts {@link LoginAttempt}
-     */
-    findFirst(options?: OptionsWithRql): Promise<LoginAttempt>;
-}
-export declare enum LoginAttemptStatus {
-    SUCCESS = "success",
-    FAILED = "failed"
-}
-export interface LoginAttempt {
-    /** The Extra Horizon document id */
-    id: string;
-    /** The (success / failed) status of a login attempt. */
-    status: LoginAttemptStatus;
-    /** The id of the provider */
-    providerId: string;
-    /** The unique name of the provider */
-    providerName: string;
-    /** The subject id (sub) of the user for the given provider */
-    providerSubjectId: string;
-    /** The Extra Horizon user id */
-    userId: string;
-    /** An Extra Horizon formatted error for failed requests */
-    error: {
-        name: string;
-        message: string;
-        code: number;
-    };
-    /** The date and time of the login attempt */
-    creationTimestamp: Date;
-}
+import { FindAllIterator } from '../../../helpers';
+import { OptionsWithRql, PagedResultWithPager } from '../../../types';
+export interface LoginAttemptsService {
+    /**
+     * ## Retrieve a paged list of login attempts
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns A paged list of login attempts {@link PagedResultWithPager PagedResultWithPager<LoginAttempt>}
+     */
+    find(options?: OptionsWithRql): Promise<PagedResultWithPager<LoginAttempt>>;
+    /**
+     * ## Retrieve a list of all login attempts
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An array of login attempts {@link LoginAttempt LoginAttempt[]}
+     * @throws {@link Error} Do not pass in limit operator with findAll
+     */
+    findAll(options?: OptionsWithRql): Promise<LoginAttempt[]>;
+    /**
+     * ## Retrieve a paged list of login attempts
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An iterator for the queried login attempts {@link FindAllIterator FindAllIterator<LoginAttempt>}
+     */
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<LoginAttempt>;
+    /**
+     * ## Retrieve the first queried login attempt
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_LOGIN_ATTEMPTS` - Allows a user to view login attempts
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns The first element of the queried login attempts {@link LoginAttempt}
+     */
+    findFirst(options?: OptionsWithRql): Promise<LoginAttempt>;
+}
+export declare enum LoginAttemptStatus {
+    SUCCESS = "success",
+    FAILED = "failed"
+}
+export interface LoginAttempt {
+    /** The Extra Horizon document id */
+    id: string;
+    /** The (success / failed) status of a login attempt. */
+    status: LoginAttemptStatus;
+    /** The id of the provider */
+    providerId: string;
+    /** The unique name of the provider */
+    providerName: string;
+    /** The subject id (sub) of the user for the given provider */
+    providerSubjectId: string;
+    /** The Extra Horizon user id */
+    userId: string;
+    /** An Extra Horizon formatted error for failed requests */
+    error: {
+        name: string;
+        message: string;
+        code: number;
+    };
+    /** The date and time of the login attempt */
+    creationTimestamp: Date;
+}

package/build/types/services/auth/oidc/providers/index.d.ts

@@ -1,5 +1,5 @@
-import { HttpInstance } from '../../../../http/types';
-import { HttpClient } from '../../../http-client';
-import { OidcProviderService } from './types';
-declare const _default: (oidcClient: HttpClient, httpWithAuth: HttpInstance) => OidcProviderService;
-export default _default;
+import { HttpInstance } from '../../../../http/types';
+import { HttpClient } from '../../../http-client';
+import { OidcProviderService } from './types';
+declare const _default: (oidcClient: HttpClient, httpWithAuth: HttpInstance) => OidcProviderService;
+export default _default;

package/build/types/services/auth/oidc/providers/types.d.ts

@@ -1,144 +1,144 @@
-import { FindAllIterator } from '../../../helpers';
-import { AffectedRecords, OptionsWithRql, PagedResultWithPager } from '../../../types';
-export interface OidcProviderService {
-    /**
-     * ## Create a new OpenID Connect Provider
-     * ### You can use this function to create a new OpenId Connect Provider to enable Single Sign On.
-     *
-     * **Global Permissions:**
-     * `CREATE_OIDC_PROVIDER` - Allows a user to create a new OpenID Connect Provider
-     *
-     * @param body {@link OidcProviderCreation}
-     * @returns OidcProvider {@link OidcProvider}
-     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
-     * @throws {@link FieldFormatError} when one of the provided parameters is not correctly formatted according to the documentation.
-     */
-    create(body: OidcProviderCreation): Promise<OidcProvider>;
-    /**
-     * ## Retrieve a paged list of OpenID Connect providers
-     *
-     * **Global Permissions:**
-     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns A paged list of providers {@link PagedResultWithPager PagedResultWithPager<OidcProvider>}
-     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
-     */
-    find(options?: OptionsWithRql): Promise<PagedResultWithPager<OidcProvider>>;
-    /**
-     * ## Retrieve a list of all OpenID Connect providers
-     *
-     * **Global Permissions:**
-     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns An array of providers {@link OidcProvider OidcProvider[]}
-     * @throws {@link Error} Do not pass in limit operator with findAll
-     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
-     */
-    findAll(options?: OptionsWithRql): Promise<OidcProvider[]>;
-    /**
-     * ## Retrieve a paged list of OpenID Connect providers
-     *
-     * **Global Permissions:**
-     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns An iterator for the queried providers {@link FindAllIterator FindAllIterator<OidcProvider>}
-     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
-     */
-    findAllIterator(options?: OptionsWithRql): FindAllIterator<OidcProvider>;
-    /**
-     * ## Retrieve the first queried OpenID Connect provider
-     *
-     * **Global Permissions:**
-     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
-     * @param options {@link OptionsWithRql} - Add filters to the requested list
-     * @returns The first element of the queried providers {@link OidcProvider}
-     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
-     */
-    findFirst(options?: OptionsWithRql): Promise<OidcProvider>;
-    /**
-     * ## Update an OpenID Connect provider
-     * ### You can use this function to update an existing OpenId Connect Provider. Fields left undefined will not be updated.
-     *
-     * **Global Permissions:**
-     * - `UPDATE_OIDC_PROVIDER` - Allows a user to update an OpenID Connect provider
-     *
-     * @param providerId {@link string} - The Extra Horizon provider id
-     * @param body {@link OidcProviderUpdate} - The set of updatable fields for an existing provider
-     * @returns An affected records promise {@link AffectedRecords}
-     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
-     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
-     * @throws {@link FieldFormatError} when one of the provided parameters is not correctly formatted according to the documentation.
-     */
-    update(providerId: string, body: OidcProviderUpdate): Promise<AffectedRecords>;
-    /**
-     * ## Delete an OpenID Connect provider
-     * ### You can use this function to delete an existing OpenId Connect provider.
-     *
-     * **Global Permissions:**
-     * - `DELETE_OIDC_PROVIDER` - Allows a user to delete an OpenID Connect provider
-     *
-     * @param providerId {@link string} - The Extra Horizon provider id
-     * @returns An affected records response {@link AffectedRecords}
-     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
-     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
-     * @throws {@link IllegalStateError} when the provider is enabled (Only disabled providers can be removed) or when there are still users linked to this provider.
-     */
-    delete(providerId: string): Promise<AffectedRecords>;
-    /**
-     * ## Enable an OpenID Connect provider
-     *
-     * **Global Permissions:**
-     * - `UPDATE_OIDC_PROVIDER` - Allows a user to update an OpenID Connect provider
-     *
-     * @param providerId {@link string} - The Extra Horizon provider id
-     * @returns An affected records response {@link AffectedRecords}
-     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
-     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
-     */
-    enable(providerId: string): Promise<AffectedRecords>;
-    /**
-     * ## Disable an OpenID Connect provider
-     *
-     * **Global Permissions:**
-     * - `UPDATE_OIDC_PROVIDER` - Allows a user to update an OpenID Connect provider
-     *
-     * @param providerId - The Extra Horizon provider id
-     * @returns An affected records response {@link AffectedRecords}
-     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
-     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
-     */
-    disable(providerId: string): Promise<AffectedRecords>;
-}
-export interface OidcProvider {
-    /** A 24 character long hexadecimal value acting as the identifier of an OpenId Connect provider */
-    id: string;
-    /** Human friendly name of the provider, which can also be used in the oidc login url. Then name can be between 3 and 40 characters and match pattern: '/^[a-zA-Z0-9_-]+$/' */
-    name: string;
-    /** Description of the provider. With a maximum of 256 characters */
-    description: string;
-    /** Provided by the OpenID Connect provider after registration. With a maximum of 2048 characters */
-    clientId: string;
-    /** A URL of maximum 2048 charactes that acts as a unique identifier for the provider. `Issuer` in the provider's discovery document. */
-    issuerId: string;
-    /** A URL of maximum 2048 character that points to the provider’s URL for authorising the user (i.e., signing the user in). authorization_endpoint in the provider's discovery document. */
-    authorizationEndpoint: string;
-    /** A URL of maximum 2048 character that points to the provider’s OAuth 2.0 protected URL from which user information can be obtained. token_endpoint in the provider's discovery document. */
-    tokenEndpoint: string;
-    /** A URL of maximum 2048 character that points to the provider’s endpoint of the authorization server Extra Horizon can use to obtain the email address and optionally also the family name and given name. userinfo_endpoint in the provider's discovery document. */
-    userinfoEndpoint: string;
-    /** A URL of maximum 2048 character that points to the location where the authorization server sends the user once the app has been successfully authorised and granted an authorization code or access token */
-    redirectUri: string;
-    /** Indicates wether the OpenID Connect provider is active and can be used for SSO */
-    enabled: boolean;
-    /** The last four characters of the client secret */
-    clientSecretHint: string;
-    /** The creation timestamp of the OpenID Connectprovider */
-    creationTimestamp: Date;
-    /** The update timestamp of the OpenID Connect provider */
-    updateTimestamp: Date;
-}
-export interface OidcProviderCreation extends Required<Pick<OidcProvider, 'name' | 'description' | 'clientId' | 'authorizationEndpoint' | 'redirectUri' | 'tokenEndpoint' | 'userinfoEndpoint' | 'issuerId'>> {
-    /** The OAuth 2.0 Client Secret you received from your provider. Max 2048 characters */
-    clientSecret: string;
-}
-export declare type OidcProviderUpdate = Partial<OidcProviderCreation>;
+import { FindAllIterator } from '../../../helpers';
+import { AffectedRecords, OptionsWithRql, PagedResultWithPager } from '../../../types';
+export interface OidcProviderService {
+    /**
+     * ## Create a new OpenID Connect Provider
+     * ### You can use this function to create a new OpenId Connect Provider to enable Single Sign On.
+     *
+     * **Global Permissions:**
+     * `CREATE_OIDC_PROVIDER` - Allows a user to create a new OpenID Connect Provider
+     *
+     * @param body {@link OidcProviderCreation}
+     * @returns OidcProvider {@link OidcProvider}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link FieldFormatError} when one of the provided parameters is not correctly formatted according to the documentation.
+     */
+    create(body: OidcProviderCreation): Promise<OidcProvider>;
+    /**
+     * ## Retrieve a paged list of OpenID Connect providers
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns A paged list of providers {@link PagedResultWithPager PagedResultWithPager<OidcProvider>}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     */
+    find(options?: OptionsWithRql): Promise<PagedResultWithPager<OidcProvider>>;
+    /**
+     * ## Retrieve a list of all OpenID Connect providers
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An array of providers {@link OidcProvider OidcProvider[]}
+     * @throws {@link Error} Do not pass in limit operator with findAll
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     */
+    findAll(options?: OptionsWithRql): Promise<OidcProvider[]>;
+    /**
+     * ## Retrieve a paged list of OpenID Connect providers
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns An iterator for the queried providers {@link FindAllIterator FindAllIterator<OidcProvider>}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     */
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<OidcProvider>;
+    /**
+     * ## Retrieve the first queried OpenID Connect provider
+     *
+     * **Global Permissions:**
+     * - `VIEW_OIDC_PROVIDERS` - Allows a user to view OpenID Connect providers
+     * @param options {@link OptionsWithRql} - Add filters to the requested list
+     * @returns The first element of the queried providers {@link OidcProvider}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     */
+    findFirst(options?: OptionsWithRql): Promise<OidcProvider>;
+    /**
+     * ## Update an OpenID Connect provider
+     * ### You can use this function to update an existing OpenId Connect Provider. Fields left undefined will not be updated.
+     *
+     * **Global Permissions:**
+     * - `UPDATE_OIDC_PROVIDER` - Allows a user to update an OpenID Connect provider
+     *
+     * @param providerId {@link string} - The Extra Horizon provider id
+     * @param body {@link OidcProviderUpdate} - The set of updatable fields for an existing provider
+     * @returns An affected records promise {@link AffectedRecords}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
+     * @throws {@link FieldFormatError} when one of the provided parameters is not correctly formatted according to the documentation.
+     */
+    update(providerId: string, body: OidcProviderUpdate): Promise<AffectedRecords>;
+    /**
+     * ## Delete an OpenID Connect provider
+     * ### You can use this function to delete an existing OpenId Connect provider.
+     *
+     * **Global Permissions:**
+     * - `DELETE_OIDC_PROVIDER` - Allows a user to delete an OpenID Connect provider
+     *
+     * @param providerId {@link string} - The Extra Horizon provider id
+     * @returns An affected records response {@link AffectedRecords}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
+     * @throws {@link IllegalStateError} when the provider is enabled (Only disabled providers can be removed) or when there are still users linked to this provider.
+     */
+    delete(providerId: string): Promise<AffectedRecords>;
+    /**
+     * ## Enable an OpenID Connect provider
+     *
+     * **Global Permissions:**
+     * - `UPDATE_OIDC_PROVIDER` - Allows a user to update an OpenID Connect provider
+     *
+     * @param providerId {@link string} - The Extra Horizon provider id
+     * @returns An affected records response {@link AffectedRecords}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
+     */
+    enable(providerId: string): Promise<AffectedRecords>;
+    /**
+     * ## Disable an OpenID Connect provider
+     *
+     * **Global Permissions:**
+     * - `UPDATE_OIDC_PROVIDER` - Allows a user to update an OpenID Connect provider
+     *
+     * @param providerId - The Extra Horizon provider id
+     * @returns An affected records response {@link AffectedRecords}
+     * @throws {@link NoPermissionError} when the user doesn't have the required permissions to execute the function.
+     * @throws {@link ResourceUnknownError} when no provider is found for the specified providerId.
+     */
+    disable(providerId: string): Promise<AffectedRecords>;
+}
+export interface OidcProvider {
+    /** A 24 character long hexadecimal value acting as the identifier of an OpenId Connect provider */
+    id: string;
+    /** Human friendly name of the provider, which can also be used in the oidc login url. Then name can be between 3 and 40 characters and match pattern: '/^[a-zA-Z0-9_-]+$/' */
+    name: string;
+    /** Description of the provider. With a maximum of 256 characters */
+    description: string;
+    /** Provided by the OpenID Connect provider after registration. With a maximum of 2048 characters */
+    clientId: string;
+    /** A URL of maximum 2048 charactes that acts as a unique identifier for the provider. `Issuer` in the provider's discovery document. */
+    issuerId: string;
+    /** A URL of maximum 2048 character that points to the provider’s URL for authorising the user (i.e., signing the user in). authorization_endpoint in the provider's discovery document. */
+    authorizationEndpoint: string;
+    /** A URL of maximum 2048 character that points to the provider’s OAuth 2.0 protected URL from which user information can be obtained. token_endpoint in the provider's discovery document. */
+    tokenEndpoint: string;
+    /** A URL of maximum 2048 character that points to the provider’s endpoint of the authorization server Extra Horizon can use to obtain the email address and optionally also the family name and given name. userinfo_endpoint in the provider's discovery document. */
+    userinfoEndpoint: string;
+    /** A URL of maximum 2048 character that points to the location where the authorization server sends the user once the app has been successfully authorised and granted an authorization code or access token */
+    redirectUri: string;
+    /** Indicates wether the OpenID Connect provider is active and can be used for SSO */
+    enabled: boolean;
+    /** The last four characters of the client secret */
+    clientSecretHint: string;
+    /** The creation timestamp of the OpenID Connectprovider */
+    creationTimestamp: Date;
+    /** The update timestamp of the OpenID Connect provider */
+    updateTimestamp: Date;
+}
+export interface OidcProviderCreation extends Required<Pick<OidcProvider, 'name' | 'description' | 'clientId' | 'authorizationEndpoint' | 'redirectUri' | 'tokenEndpoint' | 'userinfoEndpoint' | 'issuerId'>> {
+    /** The OAuth 2.0 Client Secret you received from your provider. Max 2048 characters */
+    clientSecret: string;
+}
+export declare type OidcProviderUpdate = Partial<OidcProviderCreation>;