import { CancelablePromise } from './core/CancelablePromise'; import { GetApiKeysData, GetApiKeysResponse, CreateApiKeyData, CreateApiKeyResponse, GetApiKeyData, GetApiKeyResponse, DeleteApiKeyData, DeleteApiKeyResponse, RotateApiKeyData, RotateApiKeyResponse, VerifyApiKeyData, VerifyApiKeyResponse, GetApisData, GetApisResponse, AddApisData, AddApisResponse, GetApiData, GetApiResponse, DeleteApiData, DeleteApiResponse, GetApiScopesData, GetApiScopesResponse, AddApiScopeData, AddApiScopeResponse, GetApiScopeData, GetApiScopeResponse, UpdateApiScopeData, UpdateApiScopeResponse, DeleteApiScopeData, DeleteApiScopeResponse, UpdateApiApplicationsData, UpdateApiApplicationsResponse, AddApiApplicationScopeData, AddApiApplicationScopeResponse, DeleteApiApplicationScopeData, DeleteApiApplicationScopeResponse, GetApplicationsData, GetApplicationsResponse, CreateApplicationData, CreateApplicationResponse, GetApplicationData, GetApplicationResponse, UpdateApplicationData, UpdateApplicationResponse, DeleteApplicationData, DeleteApplicationResponse, GetApplicationConnectionsData, GetApplicationConnectionsResponse, EnableConnectionData, EnableConnectionResponse, RemoveConnectionData, RemoveConnectionResponse, GetApplicationPropertyValuesData, GetApplicationPropertyValuesResponse, UpdateApplicationsPropertyData, UpdateApplicationsPropertyResponse, UpdateApplicationTokensData, UpdateApplicationTokensResponse, GetBillingAgreementsData, GetBillingAgreementsResponse, CreateBillingAgreementData, CreateBillingAgreementResponse, GetBillingEntitlementsData, GetBillingEntitlementsResponse, CreateMeterUsageRecordData, CreateMeterUsageRecordResponse, GetBusinessResponse, UpdateBusinessData, UpdateBusinessResponse, GetCallbackUrlsData, GetCallbackUrlsResponse, AddRedirectCallbackUrlsData, AddRedirectCallbackUrlsResponse, ReplaceRedirectCallbackUrlsData, ReplaceRedirectCallbackUrlsResponse, DeleteCallbackUrlsData, DeleteCallbackUrlsResponse, GetLogoutUrlsData, GetLogoutUrlsResponse, AddLogoutRedirectUrlsData, AddLogoutRedirectUrlsResponse, ReplaceLogoutRedirectUrlsData, ReplaceLogoutRedirectUrlsResponse, DeleteLogoutUrlsData, DeleteLogoutUrlsResponse, GetConnectedAppAuthUrlData, GetConnectedAppAuthUrlResponse, GetConnectedAppTokenData, GetConnectedAppTokenResponse, RevokeConnectedAppTokenData, RevokeConnectedAppTokenResponse, GetConnectionsData, GetConnectionsResponse, CreateConnectionData, CreateConnectionResponse, GetConnectionData, GetConnectionResponse, UpdateConnectionData, UpdateConnectionResponse, ReplaceConnectionData, ReplaceConnectionResponse, DeleteConnectionData, DeleteConnectionResponse, GetDirectoriesData, GetDirectoriesResponse, CreateDirectoryData, CreateDirectoryResponse, GetDirectoryData, GetDirectoryResponse, UpdateDirectoryData, UpdateDirectoryResponse, DeleteDirectoryData, DeleteDirectoryResponse, GetEnvironmentResponse, DeleteEnvironementFeatureFlagOverridesResponse, GetEnvironementFeatureFlagsResponse, DeleteEnvironementFeatureFlagOverrideData, DeleteEnvironementFeatureFlagOverrideResponse, UpdateEnvironementFeatureFlagOverrideData, UpdateEnvironementFeatureFlagOverrideResponse, ReadLogoResponse, AddLogoData, AddLogoResponse, DeleteLogoData, DeleteLogoResponse, GetPasskeyResponse, UpdatePasskeyData, UpdatePasskeyResponse, GetEnvironmentVariablesResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableResponse, GetEnvironmentVariableData, GetEnvironmentVariableResponse, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponse, CreateFeatureFlagData, CreateFeatureFlagResponse, DeleteFeatureFlagData, DeleteFeatureFlagResponse, UpdateFeatureFlagData, UpdateFeatureFlagResponse, GetIdentityData, GetIdentityResponse, UpdateIdentityData, UpdateIdentityResponse, DeleteIdentityData, DeleteIdentityResponse, GetIndustriesResponse, ReplaceMfaData, ReplaceMfaResponse, GetOrganizationInvitesData, GetOrganizationInvitesResponse, CreateOrganizationInviteData, CreateOrganizationInviteResponse, GetOrganizationInviteData, GetOrganizationInviteResponse, DeleteOrganizationInviteData, DeleteOrganizationInviteResponse, GetOrganizationData, GetOrganizationResponse, CreateOrganizationData, CreateOrganizationResponse, GetOrganizationsData, GetOrganizationsResponse, UpdateOrganizationData, UpdateOrganizationResponse, DeleteOrganizationData, DeleteOrganizationResponse, GetOrganizationUsersData, GetOrganizationUsersResponse, AddOrganizationUsersData, AddOrganizationUsersResponse, UpdateOrganizationUsersData, UpdateOrganizationUsersResponse, GetOrganizationUserRolesData, GetOrganizationUserRolesResponse, CreateOrganizationUserRoleData, CreateOrganizationUserRoleResponse, DeleteOrganizationUserRoleData, DeleteOrganizationUserRoleResponse, GetOrganizationRoleUsersData, GetOrganizationRoleUsersResponse, GetOrganizationUserPermissionsData, GetOrganizationUserPermissionsResponse, CreateOrganizationUserPermissionData, CreateOrganizationUserPermissionResponse, DeleteOrganizationUserPermissionData, DeleteOrganizationUserPermissionResponse, RemoveOrganizationUserData, RemoveOrganizationUserResponse, AddOrganizationUserApiScopeData, AddOrganizationUserApiScopeResponse, DeleteOrganizationUserApiScopeData, DeleteOrganizationUserApiScopeResponse, GetOrgUserMfaData, GetOrgUserMfaResponse, ResetOrgUserMfaAllData, ResetOrgUserMfaAllResponse, ResetOrgUserMfaData, ResetOrgUserMfaResponse, GetOrganizationFeatureFlagsData, GetOrganizationFeatureFlagsResponse, DeleteOrganizationFeatureFlagOverridesData, DeleteOrganizationFeatureFlagOverridesResponse, DeleteOrganizationFeatureFlagOverrideData, DeleteOrganizationFeatureFlagOverrideResponse, UpdateOrganizationFeatureFlagOverrideData, UpdateOrganizationFeatureFlagOverrideResponse, UpdateOrganizationPropertyData, UpdateOrganizationPropertyResponse, GetOrganizationPropertyValuesData, GetOrganizationPropertyValuesResponse, UpdateOrganizationPropertiesData, UpdateOrganizationPropertiesResponse, ReplaceOrganizationMfaData, ReplaceOrganizationMfaResponse, GetOrganizationPasskeyData, GetOrganizationPasskeyResponse, UpdateOrganizationPasskeyData, UpdateOrganizationPasskeyResponse, DeleteOrganizationHandleData, DeleteOrganizationHandleResponse, ReadOrganizationLogoData, ReadOrganizationLogoResponse, AddOrganizationLogoData, AddOrganizationLogoResponse, DeleteOrganizationLogoData, DeleteOrganizationLogoResponse, GetOrganizationConnectionsData, GetOrganizationConnectionsResponse, EnableOrgConnectionData, EnableOrgConnectionResponse, RemoveOrgConnectionData, RemoveOrgConnectionResponse, UpdateOrganizationSessionsData, UpdateOrganizationSessionsResponse, GetPermissionsData, GetPermissionsResponse, CreatePermissionData, CreatePermissionResponse, UpdatePermissionsData, UpdatePermissionsResponse, DeletePermissionData, DeletePermissionResponse, GetPropertiesData, GetPropertiesResponse, CreatePropertyData, CreatePropertyResponse, UpdatePropertyData, UpdatePropertyResponse, DeletePropertyData, DeletePropertyResponse, GetCategoriesData, GetCategoriesResponse, CreateCategoryData, CreateCategoryResponse, UpdateCategoryData, UpdateCategoryResponse, GetRolesData, GetRolesResponse, CreateRoleData, CreateRoleResponse, GetRoleData, GetRoleResponse, UpdateRolesData, UpdateRolesResponse, DeleteRoleData, DeleteRoleResponse, GetRoleScopesData, GetRoleScopesResponse, AddRoleScopeData, AddRoleScopeResponse, DeleteRoleScopeData, DeleteRoleScopeResponse, GetRolePermissionsData, GetRolePermissionsResponse, UpdateRolePermissionsData, UpdateRolePermissionsResponse, GetRoleUsersData, GetRoleUsersResponse, RemoveRolePermissionData, RemoveRolePermissionResponse, SearchUsersData, SearchUsersResponse, GetSubscribersData, GetSubscribersResponse, CreateSubscriberData, CreateSubscriberResponse, GetSubscriberData, GetSubscriberResponse, GetTimezonesResponse, GetUsersData, GetUsersResponse, RefreshUserClaimsData, RefreshUserClaimsResponse, GetUserDataData, GetUserDataResponse, CreateUserData, CreateUserResponse, UpdateUserData, UpdateUserResponse, DeleteUserData, DeleteUserResponse, UpdateUserFeatureFlagOverrideData, UpdateUserFeatureFlagOverrideResponse, UpdateUserPropertyData, UpdateUserPropertyResponse, GetUserPropertyValuesData, GetUserPropertyValuesResponse, UpdateUserPropertiesData, UpdateUserPropertiesResponse, SetUserPasswordData, SetUserPasswordResponse, GetUserIdentitiesData, GetUserIdentitiesResponse, CreateUserIdentityData, CreateUserIdentityResponse, GetUserSessionsData, GetUserSessionsResponse, DeleteUserSessionsData, DeleteUserSessionsResponse, GetUsersMfaData, GetUsersMfaResponse, ResetUsersMfaAllData, ResetUsersMfaAllResponse, ResetUsersMfaData, ResetUsersMfaResponse, GetEventData, GetEventResponse, GetEventTypesResponse, DeleteWebHookData, DeleteWebHookResponse, UpdateWebHookData, UpdateWebHookResponse, GetWebHooksResponse, CreateWebHookData, CreateWebHookResponse } from './types.gen'; export declare class ApiKeys { /** * Get API keys * Returns a list of API keys. * *
* read:api_keys *
* * @param data The data for the request. * @param data.pageSize Number of results per page. Defaults to 50 if parameter not sent. * @param data.startingAfter The ID of the API key to start after. * @param data.keyType Filter by API key type (organization or user). * @param data.status Filter by API key status (active, inactive, revoked). * @param data.userId Filter by user ID to get API keys associated with a specific user. * @param data.orgCode Filter by organization code to get API keys associated with a specific organization. * @returns get_api_keys_response API keys successfully retrieved. * @throws ApiError */ static getApiKeys(data?: GetApiKeysData): CancelablePromise; /** * Create API key * Create a new API key. * *
* create:api_keys *
* * @param data The data for the request. * @param data.requestBody API key details. * @returns create_api_key_response API key successfully created. * @throws ApiError */ static createApiKey(data: CreateApiKeyData): CancelablePromise; /** * Get API key * Retrieve API key details by ID. * *
* read:api_keys *
* * @param data The data for the request. * @param data.keyId The ID of the API key. * @returns get_api_key_response API key successfully retrieved. * @throws ApiError */ static getApiKey(data: GetApiKeyData): CancelablePromise; /** * Delete API key * Delete an API key. * *
* delete:api_keys *
* * @param data The data for the request. * @param data.keyId The ID of the API key. * @returns success_response API key successfully deleted. * @throws ApiError */ static deleteApiKey(data: DeleteApiKeyData): CancelablePromise; /** * Rotate API key * Rotate an API key to generate a new key while maintaining the same permissions and associations. * *
* update:api_keys *
* * @param data The data for the request. * @param data.keyId The ID of the API key to rotate. * @returns rotate_api_key_response API key successfully rotated. * @throws ApiError */ static rotateApiKey(data: RotateApiKeyData): CancelablePromise; /** * Verify API key * Verify an API key (public endpoint, no authentication required). * * @param data The data for the request. * @param data.requestBody API key verification details. * @returns verify_api_key_response API key verification result. * @throws ApiError */ static verifyApiKey(data: VerifyApiKeyData): CancelablePromise; } export declare class Apis { /** * Get APIs * Returns a list of your APIs. The APIs are returned sorted by name. * *
* read:apis *
* * @param data The data for the request. * @param data.expand Additional data to include in the response. Allowed value: "scopes". * @returns get_apis_response A list of APIs. * @throws ApiError */ static getApis(data?: GetApisData): CancelablePromise; /** * Create API * Register a new API. For more information read [Register and manage APIs](https://docs.kinde.com/developer-tools/your-apis/register-manage-apis/). * *
* create:apis *
* * @param data The data for the request. * @param data.requestBody * @returns create_apis_response APIs successfully updated * @throws ApiError */ static addApis(data: AddApisData): CancelablePromise; /** * Get API * Retrieve API details by ID. * *
* read:apis *
* * @param data The data for the request. * @param data.apiId The API's ID. * @returns get_api_response API successfully retrieved. * @throws ApiError */ static getApi(data: GetApiData): CancelablePromise; /** * Delete API * Delete an API you previously created. * *
* delete:apis *
* * @param data The data for the request. * @param data.apiId The API's ID. * @returns delete_api_response API successfully deleted. * @throws ApiError */ static deleteApi(data: DeleteApiData): CancelablePromise; /** * Get API scopes * Retrieve API scopes by API ID. * *
* read:api_scopes *
* * @param data The data for the request. * @param data.apiId API ID * @returns get_api_scopes_response API scopes successfully retrieved. * @throws ApiError */ static getApiScopes(data: GetApiScopesData): CancelablePromise; /** * Create API scope * Create a new API scope. * *
* create:api_scopes *
* * @param data The data for the request. * @param data.apiId API ID * @param data.requestBody * @returns create_api_scopes_response API scopes successfully created * @throws ApiError */ static addApiScope(data: AddApiScopeData): CancelablePromise; /** * Get API scope * Retrieve API scope by API ID. * *
* read:api_scopes *
* * @param data The data for the request. * @param data.apiId API ID * @param data.scopeId Scope ID * @returns get_api_scope_response API scope successfully retrieved. * @throws ApiError */ static getApiScope(data: GetApiScopeData): CancelablePromise; /** * Update API scope * Update an API scope. * *
* update:api_scopes *
* * @param data The data for the request. * @param data.apiId API ID * @param data.scopeId Scope ID * @param data.requestBody * @returns unknown API scope successfully updated * @throws ApiError */ static updateApiScope(data: UpdateApiScopeData): CancelablePromise; /** * Delete API scope * Delete an API scope you previously created. * *
* delete:apis_scopes *
* * @param data The data for the request. * @param data.apiId API ID * @param data.scopeId Scope ID * @returns unknown API scope successfully deleted. * @throws ApiError */ static deleteApiScope(data: DeleteApiScopeData): CancelablePromise; /** * Authorize API applications * Authorize applications to be allowed to request access tokens for an API * *
* update:apis *
* * @param data The data for the request. * @param data.requestBody The applications you want to authorize. * @param data.apiId The API's ID. * @returns authorize_app_api_response Authorized applications updated. * @throws ApiError */ static updateApiApplications(data: UpdateApiApplicationsData): CancelablePromise; /** * Add scope to API application * Add a scope to an API application. * *
* create:api_application_scopes *
* * @param data The data for the request. * @param data.apiId API ID * @param data.applicationId Application ID * @param data.scopeId Scope ID * @returns unknown API scope successfully added to API application * @throws ApiError */ static addApiApplicationScope(data: AddApiApplicationScopeData): CancelablePromise; /** * Delete API application scope * Delete an API application scope you previously created. * *
* delete:apis_application_scopes *
* * @param data The data for the request. * @param data.apiId API ID * @param data.applicationId Application ID * @param data.scopeId Scope ID * @returns unknown API scope successfully deleted. * @throws ApiError */ static deleteApiApplicationScope(data: DeleteApiApplicationScopeData): CancelablePromise; } export declare class Applications { /** * Get applications * Get a list of applications / clients. * *
* read:applications *
* * @param data The data for the request. * @param data.sort Field and order to sort the result by. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.nextToken A string to get the next page of results if there are more results. * @returns get_applications_response A successful response with a list of applications or an empty list. * @throws ApiError */ static getApplications(data?: GetApplicationsData): CancelablePromise; /** * Create application * Create a new client. * *
* create:applications *
* * @param data The data for the request. * @param data.requestBody * @returns create_application_response Application successfully created. * @throws ApiError */ static createApplication(data: CreateApplicationData): CancelablePromise; /** * Get application * Gets an application given the application's ID. * *
* read:applications *
* * @param data The data for the request. * @param data.applicationId The identifier for the application. * @returns get_application_response Application successfully retrieved. * @throws ApiError */ static getApplication(data: GetApplicationData): CancelablePromise; /** * Update Application * Updates a client's settings. For more information, read [Applications in Kinde](https://docs.kinde.com/build/applications/about-applications) * *
* update:applications *
* * @param data The data for the request. * @param data.applicationId The identifier for the application. * @param data.requestBody Application details. * @returns unknown Application successfully updated. * @throws ApiError */ static updateApplication(data: UpdateApplicationData): CancelablePromise; /** * Delete application * Delete a client / application. * *
* delete:applications *
* * @param data The data for the request. * @param data.applicationId The identifier for the application. * @returns success_response Application successfully deleted. * @throws ApiError */ static deleteApplication(data: DeleteApplicationData): CancelablePromise; /** * Get connections * Gets all connections for an application. * *
* read:application_connections *
* * @param data The data for the request. * @param data.applicationId The identifier/client ID for the application. * @returns get_connections_response Application connections successfully retrieved. * @throws ApiError */ static getApplicationConnections(data: GetApplicationConnectionsData): CancelablePromise; /** * Enable connection * Enable an auth connection for an application. * *
* create:application_connections *
* * @param data The data for the request. * @param data.applicationId The identifier/client ID for the application. * @param data.connectionId The identifier for the connection. * @returns unknown Connection successfully enabled. * @throws ApiError */ static enableConnection(data: EnableConnectionData): CancelablePromise; /** * Remove connection * Turn off an auth connection for an application * *
* delete:application_connections *
* * @param data The data for the request. * @param data.applicationId The identifier/client ID for the application. * @param data.connectionId The identifier for the connection. * @returns success_response Connection successfully removed. * @throws ApiError */ static removeConnection(data: RemoveConnectionData): CancelablePromise; /** * Get property values * Gets properties for an application by client ID. * *
* read:application_properties *
* * @param data The data for the request. * @param data.applicationId The application's ID / client ID. * @returns get_property_values_response Properties successfully retrieved. * @throws ApiError */ static getApplicationPropertyValues(data: GetApplicationPropertyValuesData): CancelablePromise; /** * Update property * Update application property value. * *
* update:application_properties *
* * @param data The data for the request. * @param data.requestBody * @param data.applicationId The application's ID / client ID. * @param data.propertyKey The property's key. * @returns success_response Property successfully updated * @throws ApiError */ static updateApplicationsProperty(data: UpdateApplicationsPropertyData): CancelablePromise; /** * Update application tokens * Configure tokens for an application. *
* update:application_tokens *
* * @param data The data for the request. * @param data.applicationId The identifier/client ID for the application. * @param data.requestBody Application tokens. * @returns success_response Application tokens successfully updated. * @throws ApiError */ static updateApplicationTokens(data: UpdateApplicationTokensData): CancelablePromise; } export declare class BillingAgreements { /** * Get billing agreements * Returns all the agreements a billing customer currently has access to * *
* read:billing_agreements *
* * @param data The data for the request. * @param data.customerId The ID of the billing customer to retrieve agreements for * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.startingAfter The ID of the billing agreement to start after. * @param data.endingBefore The ID of the billing agreement to end before. * @param data.featureCode The feature code to filter by agreements only containing that feature * @returns get_billing_agreements_response Billing agreements successfully retrieved. * @throws ApiError */ static getBillingAgreements(data: GetBillingAgreementsData): CancelablePromise; /** * Create billing agreement * Creates a new billing agreement based on the plan code passed, and cancels the customer's existing agreements * *
* create:billing_agreements *
* * @param data The data for the request. * @param data.requestBody New agreement request values * @returns success_response Billing agreement successfully changed * @throws ApiError */ static createBillingAgreement(data: CreateBillingAgreementData): CancelablePromise; } export declare class BillingEntitlements { /** * Get billing entitlements * Returns all the entitlements a billing customer currently has access to * *
* read:billing_entitlements *
* * @param data The data for the request. * @param data.customerId The ID of the billing customer to retrieve entitlements for * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.startingAfter The ID of the billing entitlement to start after. * @param data.endingBefore The ID of the billing entitlement to end before. * @param data.maxValue When the maximum limit of an entitlement is null, this value is returned as the maximum limit * @param data.expand Additional plan data to include in the response. Allowed value: "plans". * @returns get_billing_entitlements_response Billing entitlements successfully retrieved. * @throws ApiError */ static getBillingEntitlements(data: GetBillingEntitlementsData): CancelablePromise; } export declare class BillingMeterUsage { /** * Create meter usage record * Create a new meter usage record * *
* create:meter_usage *
* * @param data The data for the request. * @param data.requestBody Meter usage record * @returns create_meter_usage_record_response Meter usage record successfully created. * @throws ApiError */ static createMeterUsageRecord(data: CreateMeterUsageRecordData): CancelablePromise; } export declare class Business { /** * Get business * Get your business details. * *
* read:businesses *
* * @returns get_business_response Your business details. * @throws ApiError */ static getBusiness(): CancelablePromise; /** * Update business * Update your business details. * *
* update:businesses *
* * @param data The data for the request. * @param data.requestBody The business details to update. * @returns success_response Business successfully updated. * @throws ApiError */ static updateBusiness(data: UpdateBusinessData): CancelablePromise; } export declare class Callbacks { /** * List Callback URLs * Returns an application's redirect callback URLs. * *
* read:applications_redirect_uris *
* * @param data The data for the request. * @param data.appId The identifier for the application. * @returns redirect_callback_urls Callback URLs successfully retrieved. * @throws ApiError */ static getCallbackUrls(data: GetCallbackUrlsData): CancelablePromise; /** * Add Redirect Callback URLs * Add additional redirect callback URLs. * *
* create:applications_redirect_uris *
* * @param data The data for the request. * @param data.appId The identifier for the application. * @param data.requestBody Callback details. * @returns success_response Callbacks successfully updated * @throws ApiError */ static addRedirectCallbackUrls(data: AddRedirectCallbackUrlsData): CancelablePromise; /** * Replace Redirect Callback URLs * Replace all redirect callback URLs. * *
* update:applications_redirect_uris *
* * @param data The data for the request. * @param data.appId The identifier for the application. * @param data.requestBody Callback details. * @returns success_response Callbacks successfully updated * @throws ApiError */ static replaceRedirectCallbackUrls(data: ReplaceRedirectCallbackUrlsData): CancelablePromise; /** * Delete Callback URLs * Delete callback URLs. * *
* delete:applications_redirect_uris *
* * @param data The data for the request. * @param data.appId The identifier for the application. * @param data.urls Urls to delete, comma separated and url encoded. * @returns success_response Callback URLs successfully deleted. * @throws ApiError */ static deleteCallbackUrls(data: DeleteCallbackUrlsData): CancelablePromise; /** * List logout URLs * Returns an application's logout redirect URLs. * *
* read:application_logout_uris *
* * @param data The data for the request. * @param data.appId The identifier for the application. * @returns logout_redirect_urls Logout URLs successfully retrieved. * @throws ApiError */ static getLogoutUrls(data: GetLogoutUrlsData): CancelablePromise; /** * Add logout redirect URLs * Add additional logout redirect URLs. * *
* create:application_logout_uris *
* * @param data The data for the request. * @param data.appId The identifier for the application. * @param data.requestBody Callback details. * @returns success_response Logout URLs successfully updated. * @throws ApiError */ static addLogoutRedirectUrls(data: AddLogoutRedirectUrlsData): CancelablePromise; /** * Replace logout redirect URls * Replace all logout redirect URLs. * *
* update:application_logout_uris *
* * @param data The data for the request. * @param data.appId The identifier for the application. * @param data.requestBody Callback details. * @returns success_response Logout URLs successfully updated. * @throws ApiError */ static replaceLogoutRedirectUrls(data: ReplaceLogoutRedirectUrlsData): CancelablePromise; /** * Delete Logout URLs * Delete logout URLs. * *
* delete:application_logout_uris *
* * @param data The data for the request. * @param data.appId The identifier for the application. * @param data.urls Urls to delete, comma separated and url encoded. * @returns success_response Logout URLs successfully deleted. * @throws ApiError */ static deleteLogoutUrls(data: DeleteLogoutUrlsData): CancelablePromise; } export declare class ConnectedApps { /** * Get Connected App URL * Get a URL that authenticates and authorizes a user to a third-party connected app. * *
* read:connected_apps *
* * @param data The data for the request. * @param data.keyCodeRef The unique key code reference of the connected app to authenticate against. * @param data.userId The id of the user that needs to authenticate to the third-party connected app. * @param data.orgCode The code of the Kinde organization that needs to authenticate to the third-party connected app. * @param data.overrideCallbackUrl A URL that overrides the default callback URL setup in your connected app configuration * @returns connected_apps_auth_url A URL that can be used to authenticate and a session id to identify this authentication session. * @throws ApiError */ static getConnectedAppAuthUrl(data: GetConnectedAppAuthUrlData): CancelablePromise; /** * Get Connected App Token * Get an access token that can be used to call the third-party provider linked to the connected app. * *
* read:connected_apps *
* * @param data The data for the request. * @param data.sessionId The unique sesssion id representing the login session of a user. * @returns connected_apps_access_token An access token that can be used to query a third-party provider, as well as the token's expiry time. * @throws ApiError */ static getConnectedAppToken(data: GetConnectedAppTokenData): CancelablePromise; /** * Revoke Connected App Token * Revoke the tokens linked to the connected app session. * *
* create:connected_apps *
* * @param data The data for the request. * @param data.sessionId The unique sesssion id representing the login session of a user. * @returns success_response An access token that can be used to query a third-party provider, as well as the token's expiry time. * @throws ApiError */ static revokeConnectedAppToken(data: RevokeConnectedAppTokenData): CancelablePromise; } export declare class Connections { /** * Get connections * Returns a list of authentication connections. Optionally you can filter this by a home realm domain. * *
* read:connections *
* * @param data The data for the request. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.homeRealmDomain Filter the results by the home realm domain. * @param data.startingAfter The ID of the connection to start after. * @param data.endingBefore The ID of the connection to end before. * @returns get_connections_response Connections successfully retrieved. * @throws ApiError */ static getConnections(data?: GetConnectionsData): CancelablePromise; /** * Create Connection * Create Connection. * *
* create:connections *
* * @param data The data for the request. * @param data.requestBody Connection details. * @returns create_connection_response Connection successfully created. * @throws ApiError */ static createConnection(data: CreateConnectionData): CancelablePromise; /** * Get Connection * Get Connection. * *
* read:connections *
* * @param data The data for the request. * @param data.connectionId The unique identifier for the connection. * @returns connection Connection successfully retrieved. * @throws ApiError */ static getConnection(data: GetConnectionData): CancelablePromise; /** * Update Connection * Update Connection. * *
* update:connections *
* * @param data The data for the request. * @param data.connectionId The unique identifier for the connection. * @param data.requestBody The fields of the connection to update. * @returns success_response Connection successfully updated. * @throws ApiError */ static updateConnection(data: UpdateConnectionData): CancelablePromise; /** * Replace Connection * Replace Connection Config. * *
* update:connections *
* * @param data The data for the request. * @param data.connectionId The unique identifier for the connection. * @param data.requestBody The complete connection configuration to replace the existing one. * @returns success_response Connection successfully updated * @throws ApiError */ static replaceConnection(data: ReplaceConnectionData): CancelablePromise; /** * Delete Connection * Delete connection. * *
* delete:connections *
* * @param data The data for the request. * @param data.connectionId The identifier for the connection. * @returns success_response Connection successfully deleted. * @throws ApiError */ static deleteConnection(data: DeleteConnectionData): CancelablePromise; } export declare class Directories { /** * Get SCIM directories * Returns a list of SCIM directories for your organization. * *
* read:scim_directories *
* * @param data The data for the request. * @param data.pageSize Number of results per page. Defaults to 50 if parameter not sent. * @param data.startingAfter The ID of the directory to start after. * @param data.organizationCode Filter by organization code to get directories for a specific organization. * @returns get_directories_response SCIM directories successfully retrieved. * @throws ApiError */ static getDirectories(data?: GetDirectoriesData): CancelablePromise; /** * Create SCIM directory * Create a new SCIM directory for user and group synchronization. * *
* create:scim_directories *
* * @param data The data for the request. * @param data.requestBody * @returns create_directory_response SCIM directory successfully created. * @throws ApiError */ static createDirectory(data: CreateDirectoryData): CancelablePromise; /** * Get SCIM directory * Retrieve SCIM directory details by ID. * *
* read:scim_directories *
* * @param data The data for the request. * @param data.directoryId The directory's ID. * @returns get_directory_response SCIM directory successfully retrieved. * @throws ApiError */ static getDirectory(data: GetDirectoryData): CancelablePromise; /** * Update SCIM directory * Update SCIM directory configuration. * *
* update:scim_directories *
* * @param data The data for the request. * @param data.requestBody * @param data.directoryId The directory's ID. * @returns update_directory_response SCIM directory successfully updated. * @throws ApiError */ static updateDirectory(data: UpdateDirectoryData): CancelablePromise; /** * Delete SCIM directory * Delete a SCIM directory and all associated data. * *
* delete:scim_directories *
* * @param data The data for the request. * @param data.directoryId The directory's ID. * @returns delete_directory_response SCIM directory successfully deleted. * @throws ApiError */ static deleteDirectory(data: DeleteDirectoryData): CancelablePromise; } export declare class Environments { /** * Get environment * Gets the current environment. * *
* read:environments *
* * @returns get_environment_response Environment successfully retrieved. * @throws ApiError */ static getEnvironment(): CancelablePromise; /** * Delete Environment Feature Flag Overrides * Delete all environment feature flag overrides. * *
* delete:environment_feature_flags *
* * @returns success_response Feature flag overrides deleted successfully. * @throws ApiError */ static deleteEnvironementFeatureFlagOverrides(): CancelablePromise; /** * List Environment Feature Flags * Get environment feature flags. * *
* read:environment_feature_flags *
* * @returns get_environment_feature_flags_response Feature flags retrieved successfully. * @throws ApiError */ static getEnvironementFeatureFlags(): CancelablePromise; /** * Delete Environment Feature Flag Override * Delete environment feature flag override. * *
* delete:environment_feature_flags *
* * @param data The data for the request. * @param data.featureFlagKey The identifier for the feature flag. * @returns success_response Feature flag deleted successfully. * @throws ApiError */ static deleteEnvironementFeatureFlagOverride(data: DeleteEnvironementFeatureFlagOverrideData): CancelablePromise; /** * Update Environment Feature Flag Override * Update environment feature flag override. * *
* update:environment_feature_flags *
* * @param data The data for the request. * @param data.featureFlagKey The identifier for the feature flag. * @param data.requestBody Flag details. * @returns success_response Feature flag override successful * @throws ApiError */ static updateEnvironementFeatureFlagOverride(data: UpdateEnvironementFeatureFlagOverrideData): CancelablePromise; /** * Read logo details * Read environment logo details * *
* read:environments *
* * @returns read_env_logo_response Success * @throws ApiError */ static readLogo(): CancelablePromise; /** * Add logo * Add environment logo * *
* update:environments *
* * @param data The data for the request. * @param data.type The type of logo to add. * @param data.formData Logo details. * @returns success_response Logo successfully updated * @throws ApiError */ static addLogo(data: AddLogoData): CancelablePromise; /** * Delete logo * Delete environment logo * *
* update:environments *
* * @param data The data for the request. * @param data.type The type of logo to delete. * @returns success_response Logo successfully deleted * @returns void No logo found to delete * @throws ApiError */ static deleteLogo(data: DeleteLogoData): CancelablePromise; /** * Get environment passkey settings * Retrieve passkey policy for the current environment. * *
* read:passkey *
* * @returns unknown Passkey settings successfully retrieved. * @throws ApiError */ static getPasskey(): CancelablePromise; /** * Update environment passkey settings * Set the passkey policy for the current environment. Policies other than `off` require the `passkeys` entitlement. * *
* update:passkey *
* * @param data The data for the request. * @param data.requestBody Environment passkey settings. * @returns unknown Passkey settings successfully updated. * @throws ApiError */ static updatePasskey(data: UpdatePasskeyData): CancelablePromise; } export declare class EnvironmentVariables { /** * Get environment variables * Get environment variables. This feature is in beta and admin UI is not yet available. * *
* read:environment_variables *
* * @returns get_environment_variables_response A successful response with a list of environment variables or an empty list. * @throws ApiError */ static getEnvironmentVariables(): CancelablePromise; /** * Create environment variable * Create a new environment variable. This feature is in beta and admin UI is not yet available. * *
* create:environment_variables *
* * @param data The data for the request. * @param data.requestBody The environment variable details. * @returns create_environment_variable_response Environment variable successfully created. * @throws ApiError */ static createEnvironmentVariable(data: CreateEnvironmentVariableData): CancelablePromise; /** * Get environment variable * Retrieve environment variable details by ID. This feature is in beta and admin UI is not yet available. * *
* read:environment_variables *
* * @param data The data for the request. * @param data.variableId The environment variable's ID. * @returns get_environment_variable_response Environment variable successfully retrieved. * @throws ApiError */ static getEnvironmentVariable(data: GetEnvironmentVariableData): CancelablePromise; /** * Update environment variable * Update an environment variable you previously created. This feature is in beta and admin UI is not yet available. * *
* update:environment_variables *
* * @param data The data for the request. * @param data.requestBody The new details for the environment variable * @param data.variableId The environment variable's ID. * @returns update_environment_variable_response Environment variable successfully updated. * @throws ApiError */ static updateEnvironmentVariable(data: UpdateEnvironmentVariableData): CancelablePromise; /** * Delete environment variable * Delete an environment variable you previously created. This feature is in beta and admin UI is not yet available. * *
* delete:environment_variables *
* * @param data The data for the request. * @param data.variableId The environment variable's ID. * @returns delete_environment_variable_response Environment variable successfully deleted. * @throws ApiError */ static deleteEnvironmentVariable(data: DeleteEnvironmentVariableData): CancelablePromise; } export declare class FeatureFlags { /** * Create Feature Flag * Create feature flag. * *
* create:feature_flags *
* * @param data The data for the request. * @param data.requestBody Flag details. * @returns success_response Feature flag successfully created * @throws ApiError */ static createFeatureFlag(data: CreateFeatureFlagData): CancelablePromise; /** * Delete Feature Flag * Delete feature flag * *
* delete:feature_flags *
* * @param data The data for the request. * @param data.featureFlagKey The identifier for the feature flag. * @returns success_response Feature flag successfully updated. * @throws ApiError */ static deleteFeatureFlag(data: DeleteFeatureFlagData): CancelablePromise; /** * Replace Feature Flag * Update feature flag. * *
* update:feature_flags *
* * @param data The data for the request. * @param data.featureFlagKey The key identifier for the feature flag. * @param data.name The name of the flag. * @param data.description Description of the flag purpose. * @param data.type The variable type * @param data.allowOverrideLevel Allow the flag to be overridden at a different level. * @param data.defaultValue Default value for the flag used by environments and organizations. * @returns success_response Feature flag successfully updated. * @throws ApiError */ static updateFeatureFlag(data: UpdateFeatureFlagData): CancelablePromise; } export declare class Identities { /** * Get identity * Returns an identity by ID * *
* read:identities *
* * @param data The data for the request. * @param data.identityId The unique identifier for the identity. * @returns identity Identity successfully retrieved. * @throws ApiError */ static getIdentity(data: GetIdentityData): CancelablePromise; /** * Update identity * Update identity by ID. * *
* update:identities *
* * @param data The data for the request. * @param data.identityId The unique identifier for the identity. * @param data.requestBody The fields of the identity to update. * @returns success_response Identity successfully updated. * @throws ApiError */ static updateIdentity(data: UpdateIdentityData): CancelablePromise; /** * Delete identity * Delete identity by ID. * *
* delete:identities *
* * @param data The data for the request. * @param data.identityId The unique identifier for the identity. * @returns success_response Identity successfully deleted. * @throws ApiError */ static deleteIdentity(data: DeleteIdentityData): CancelablePromise; } export declare class Industries { /** * Get industries * Get a list of industries and associated industry keys. * *
* read:industries *
* * @returns get_industries_response A list of industries. * @throws ApiError */ static getIndustries(): CancelablePromise; } export declare class Mfa { /** * Replace MFA Configuration * Replace MFA Configuration. * *
* update:mfa *
* * @param data The data for the request. * @param data.requestBody MFA details. * @returns success_response MFA Configuration updated successfully. * @throws ApiError */ static replaceMfa(data: ReplaceMfaData): CancelablePromise; } export declare class Organizations { /** * Get organization invites * Get a list of invitations for an organization. By default, only pending (non-revoked, non-accepted) invitations are returned. * *
* read:organization_invites *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.sort Field and order to sort the result by. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.nextToken A string to get the next page of results if there are more results. * @param data.includeRevoked Include revoked invitations in the results. * @param data.includeAccepted Include accepted invitations in the results. * @returns get_organization_invites_response Invitations successfully retrieved. * @throws ApiError */ static getOrganizationInvites(data: GetOrganizationInvitesData): CancelablePromise; /** * Create organization invite * Create a new invitation for an organization. An invitation email will be sent to the provided email address if `send_email` is set to `true`. * * Invitations cannot be created for organizations that are managed by directory sync; user and role changes for those organizations must be made in the upstream identity provider. * * Roles that require an explicit assignment permission cannot be granted to an invitee unless the caller (or the user the token represents) holds that permission. On Kinde-hosted plans, roles outside `owner`/`admin` additionally require the `extended_roles` entitlement. * * Per-organization rate limits apply: a maximum number of invitations may be created per rolling 24 hour window, and a maximum number of active (non-accepted, non-revoked) invitations may exist at any time. Requests that exceed either limit are rejected. * *
* create:organization_invites *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.requestBody Invitation details. `email` is capped at 254 characters (RFC 5321). `first_name` and `last_name` are capped at 64 characters each. Inputs over these limits are rejected with `EMAIL_TOO_LONG`, `FIRST_NAME_TOO_LONG`, or `LAST_NAME_TOO_LONG`. * @returns create_organization_invite_response Invitation successfully created. * @throws ApiError */ static createOrganizationInvite(data: CreateOrganizationInviteData): CancelablePromise; /** * Get organization invite * Get details of a specific invitation by its code. * *
* read:organization_invites *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.inviteCode The invitation's code. * @returns get_organization_invite_response Invitation successfully retrieved. * @throws ApiError */ static getOrganizationInvite(data: GetOrganizationInviteData): CancelablePromise; /** * Delete organization invite * Revoke (delete) an invitation. This will mark the invitation as revoked and prevent it from being accepted. * *
* delete:organization_invites *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.inviteCode The invitation's code. * @returns success_response Invitation successfully revoked. * @throws ApiError */ static deleteOrganizationInvite(data: DeleteOrganizationInviteData): CancelablePromise; /** * Get organization * Retrieve organization details by code. * *
* read:organizations *
* * @param data The data for the request. * @param data.code The organization's code. * @param data.expand Additional data to include in the response. Allowed value: "billing". * @returns get_organization_response Organization successfully retrieved. * @throws ApiError */ static getOrganization(data: GetOrganizationData): CancelablePromise; /** * Create organization * Create a new organization. To learn more read about [multi tenancy using organizations](https://docs.kinde.com/build/organizations/multi-tenancy-using-organizations/) * *
* create:organizations *
* * @param data The data for the request. * @param data.requestBody Organization details. * @returns create_organization_response Organization successfully created. * @throws ApiError */ static createOrganization(data: CreateOrganizationData): CancelablePromise; /** * Get organizations * Get a list of organizations. * *
* read:organizations *
* * @param data The data for the request. * @param data.sort Field and order to sort the result by. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.nextToken A string to get the next page of results if there are more results. * @returns get_organizations_response Organizations successfully retreived. * @throws ApiError */ static getOrganizations(data?: GetOrganizationsData): CancelablePromise; /** * Update Organization * Update an organization. * *
* update:organizations *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization. * @param data.expand Additional data to include in the response. Allowed value: "billing". * @param data.requestBody Organization details. * @returns success_response Organization successfully updated. * @throws ApiError */ static updateOrganization(data: UpdateOrganizationData): CancelablePromise; /** * Delete Organization * Delete an organization. * *
* delete:organizations *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization. * @returns success_response Organization successfully deleted. * @throws ApiError */ static deleteOrganization(data: DeleteOrganizationData): CancelablePromise; /** * Get organization users * Get user details for all members of an organization. * *
* read:organization_users *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.sort Field and order to sort the result by. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.nextToken A string to get the next page of results if there are more results. * @param data.permissions Filter by user permissions comma separated (where all match) * @param data.roles Filter by user roles comma separated (where all match) * @returns get_organization_users_response A successful response with a list of organization users or an empty list. * @throws ApiError */ static getOrganizationUsers(data: GetOrganizationUsersData): CancelablePromise; /** * Add Organization Users * Add existing users to an organization. * *
* create:organization_users *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.requestBody * @returns add_organization_users_response Add organization users request successfully processed. * @throws ApiError */ static addOrganizationUsers(data: AddOrganizationUsersData): CancelablePromise; /** * Update Organization Users * Update users that belong to an organization. * *
* update:organization_users *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.requestBody * @returns update_organization_users_response Users successfully removed. * @throws ApiError */ static updateOrganizationUsers(data: UpdateOrganizationUsersData): CancelablePromise; /** * List Organization User Roles * Get roles for an organization user. * *
* read:organization_user_roles *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.userId The user's id. * @returns get_organizations_user_roles_response A successful response with a list of user roles. * @throws ApiError */ static getOrganizationUserRoles(data: GetOrganizationUserRolesData): CancelablePromise; /** * Add Organization User Role * Add role to an organization user. * *
* create:organization_user_roles *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.userId The user's id. * @param data.requestBody Role details. * @returns success_response Role successfully added. * @throws ApiError */ static createOrganizationUserRole(data: CreateOrganizationUserRoleData): CancelablePromise; /** * Delete Organization User Role * Delete role for an organization user. * *
* delete:organization_user_roles *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.userId The user's id. * @param data.roleId The role id. * @returns success_response User successfully removed. * @throws ApiError */ static deleteOrganizationUserRole(data: DeleteOrganizationUserRoleData): CancelablePromise; /** * List organization role users * Get users that have a given role within a specific organization. * *
* read:organization_user_roles *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.roleId The role's public id. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.nextToken A string to get the next page of results if there are more results. * @returns get_organization_role_users_response A list of users with the specified role in the organization. * @throws ApiError */ static getOrganizationRoleUsers(data: GetOrganizationRoleUsersData): CancelablePromise; /** * List Organization User Permissions * Get permissions for an organization user. * *
* read:organization_user_permissions *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.userId The user's id. * @param data.expand Additional data to include in the response. Allowed value: "roles". * @returns get_organizations_user_permissions_response A successful response with a list of user permissions. * @throws ApiError */ static getOrganizationUserPermissions(data: GetOrganizationUserPermissionsData): CancelablePromise; /** * Add Organization User Permission * Add permission to an organization user. * *
* create:organization_user_permissions *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.userId The user's id. * @param data.requestBody Permission details. * @returns success_response User permission successfully updated. * @throws ApiError */ static createOrganizationUserPermission(data: CreateOrganizationUserPermissionData): CancelablePromise; /** * Delete Organization User Permission * Delete permission for an organization user. * *
* delete:organization_user_permissions *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.userId The user's id. * @param data.permissionId The permission id. * @returns success_response User successfully removed. * @throws ApiError */ static deleteOrganizationUserPermission(data: DeleteOrganizationUserPermissionData): CancelablePromise; /** * Remove Organization User * Remove user from an organization. * *
* delete:organization_users *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.userId The user's id. * @returns success_response User successfully removed from organization * @throws ApiError */ static removeOrganizationUser(data: RemoveOrganizationUserData): CancelablePromise; /** * Add scope to organization user api * Add a scope to an organization user api. * *
* create:organization_user_api_scopes *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization. * @param data.userId User ID * @param data.apiId API ID * @param data.scopeId Scope ID * @returns unknown API scope successfully added to organization user api * @throws ApiError */ static addOrganizationUserApiScope(data: AddOrganizationUserApiScopeData): CancelablePromise; /** * Delete scope from organization user API * Delete a scope from an organization user api you previously created. * *
* delete:organization_user_api_scopes *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization. * @param data.userId User ID * @param data.apiId API ID * @param data.scopeId Scope ID * @returns unknown Organization user API scope successfully deleted. * @throws ApiError */ static deleteOrganizationUserApiScope(data: DeleteOrganizationUserApiScopeData): CancelablePromise; /** * Get an organization user's MFA configuration * Get an organization user’s MFA configuration. * *
* read:organization_user_mfa *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization. * @param data.userId The identifier for the user * @returns get_user_mfa_response Successfully retrieve user's MFA configuration. * @throws ApiError */ static getOrgUserMfa(data: GetOrgUserMfaData): CancelablePromise; /** * Reset all organization MFA for a user * Reset all organization MFA factors for a user. * *
* delete:organization_user_mfa *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization. * @param data.userId The identifier for the user * @returns success_response User's MFA successfully reset. * @throws ApiError */ static resetOrgUserMfaAll(data: ResetOrgUserMfaAllData): CancelablePromise; /** * Reset specific organization MFA for a user * Reset a specific organization MFA factor for a user. * *
* delete:organization_user_mfa *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization. * @param data.userId The identifier for the user * @param data.factorId The identifier for the MFA factor * @returns success_response User's MFA successfully reset. * @throws ApiError */ static resetOrgUserMfa(data: ResetOrgUserMfaData): CancelablePromise; /** * List Organization Feature Flags * Get all organization feature flags. * *
* read:organization_feature_flags *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization. * @returns get_organization_feature_flags_response Feature flag overrides successfully returned. * @throws ApiError */ static getOrganizationFeatureFlags(data: GetOrganizationFeatureFlagsData): CancelablePromise; /** * Delete Organization Feature Flag Overrides * Delete all organization feature flag overrides. * *
* delete:organization_feature_flags *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization. * @returns success_response Feature flag overrides successfully deleted. * @throws ApiError */ static deleteOrganizationFeatureFlagOverrides(data: DeleteOrganizationFeatureFlagOverridesData): CancelablePromise; /** * Delete Organization Feature Flag Override * Delete organization feature flag override. * *
* delete:organization_feature_flags *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization. * @param data.featureFlagKey The identifier for the feature flag. * @returns success_response Feature flag override successfully deleted. * @throws ApiError */ static deleteOrganizationFeatureFlagOverride(data: DeleteOrganizationFeatureFlagOverrideData): CancelablePromise; /** * Update Organization Feature Flag Override * Update organization feature flag override. * *
* update:organization_feature_flags *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization * @param data.featureFlagKey The identifier for the feature flag * @param data.value Override value * @returns success_response Feature flag override successfully updated. * @throws ApiError */ static updateOrganizationFeatureFlagOverride(data: UpdateOrganizationFeatureFlagOverrideData): CancelablePromise; /** * Update Organization Property value * Update organization property value. * *
* update:organization_properties *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization * @param data.propertyKey The identifier for the property * @param data.value The new property value * @returns success_response Property successfully updated. * @throws ApiError */ static updateOrganizationProperty(data: UpdateOrganizationPropertyData): CancelablePromise; /** * Get Organization Property Values * Gets properties for an organization by org code. * *
* read:organization_properties *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @returns get_property_values_response Properties successfully retrieved. * @throws ApiError */ static getOrganizationPropertyValues(data: GetOrganizationPropertyValuesData): CancelablePromise; /** * Update Organization Property values * Update organization property values. * *
* update:organization_properties *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization * @param data.requestBody Properties to update. * @returns success_response Properties successfully updated. * @throws ApiError */ static updateOrganizationProperties(data: UpdateOrganizationPropertiesData): CancelablePromise; /** * Replace Organization MFA Configuration * Replace Organization MFA Configuration. * *
* update:organization_mfa *
* * @param data The data for the request. * @param data.orgCode The identifier for the organization * @param data.requestBody MFA details. * @returns success_response MFA Configuration updated successfully. * @throws ApiError */ static replaceOrganizationMfa(data: ReplaceOrganizationMfaData): CancelablePromise; /** * Get organization passkey settings * Retrieve passkey settings for an organization, including whether the organization overrides the environment default. * *
* read:organization_passkey *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @returns unknown Organization passkey settings successfully retrieved. * @throws ApiError */ static getOrganizationPasskey(data: GetOrganizationPasskeyData): CancelablePromise; /** * Update organization passkey settings * Update passkey settings for an organization. Set `is_override_environment_passkey_settings` to `false` to revert to the environment default without providing a policy. * *
* update:organization_passkey *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.requestBody Organization passkey settings. * @returns unknown Organization passkey settings successfully updated. * @throws ApiError */ static updateOrganizationPasskey(data: UpdateOrganizationPasskeyData): CancelablePromise; /** * Delete organization handle * Delete organization handle * *
* delete:organization_handles *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @returns success_response Handle successfully deleted. * @throws ApiError */ static deleteOrganizationHandle(data: DeleteOrganizationHandleData): CancelablePromise; /** * Read organization logo details * Read organization logo details * *
* read:organizations *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @returns read_logo_response Successfully retrieved organization logo details * @throws ApiError */ static readOrganizationLogo(data: ReadOrganizationLogoData): CancelablePromise; /** * Add organization logo * Add organization logo * *
* update:organizations *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.type The type of logo to add. * @param data.formData Organization logo details. * @returns success_response Organization logo successfully updated * @throws ApiError */ static addOrganizationLogo(data: AddOrganizationLogoData): CancelablePromise; /** * Delete organization logo * Delete organization logo * *
* update:organizations *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.type The type of logo to delete. * @returns success_response Organization logo successfully deleted * @returns void No logo found to delete * @throws ApiError */ static deleteOrganizationLogo(data: DeleteOrganizationLogoData): CancelablePromise; /** * Get connections * Gets all connections for an organization. * *
* read:organization_connections *
* * @param data The data for the request. * @param data.organizationCode The organization code. * @returns get_connections_response Organization connections successfully retrieved. * @throws ApiError */ static getOrganizationConnections(data: GetOrganizationConnectionsData): CancelablePromise; /** * Enable connection * Enable an auth connection for an organization. * *
* create:organization_connections *
* * @param data The data for the request. * @param data.organizationCode The unique code for the organization. * @param data.connectionId The identifier for the connection. * @returns unknown Connection successfully enabled. * @throws ApiError */ static enableOrgConnection(data: EnableOrgConnectionData): CancelablePromise; /** * Remove connection * Turn off an auth connection for an organization * *
* delete:organization_connections *
* * @param data The data for the request. * @param data.organizationCode The unique code for the organization. * @param data.connectionId The identifier for the connection. * @returns success_response Connection successfully removed. * @throws ApiError */ static removeOrgConnection(data: RemoveOrgConnectionData): CancelablePromise; /** * Update organization session configuration * Update the organization's session configuration. * *
* update:organizations *
* * @param data The data for the request. * @param data.orgCode The organization's code. * @param data.requestBody Organization session configuration. * @returns success_response Organization sessions successfully updated * @throws ApiError */ static updateOrganizationSessions(data: UpdateOrganizationSessionsData): CancelablePromise; } export declare class Permissions { /** * List Permissions * The returned list can be sorted by permission name or permission ID in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query string parameter. * *
* read:permissions *
* * @param data The data for the request. * @param data.sort Field and order to sort the result by. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.nextToken A string to get the next page of results if there are more results. * @returns get_permissions_response Permissions successfully retrieved. * @throws ApiError */ static getPermissions(data?: GetPermissionsData): CancelablePromise; /** * Create Permission * Create a new permission. * *
* create:permissions *
* * @param data The data for the request. * @param data.requestBody Permission details. * @returns success_response Permission successfully created * @throws ApiError */ static createPermission(data?: CreatePermissionData): CancelablePromise; /** * Update Permission * Update permission * *
* update:permissions *
* * @param data The data for the request. * @param data.permissionId The identifier for the permission. * @param data.requestBody Permission details. * @returns success_response Permission successfully updated * @throws ApiError */ static updatePermissions(data: UpdatePermissionsData): CancelablePromise; /** * Delete Permission * Delete permission * *
* delete:permissions *
* * @param data The data for the request. * @param data.permissionId The identifier for the permission. * @returns success_response permission successfully updated. * @throws ApiError */ static deletePermission(data: DeletePermissionData): CancelablePromise; } export declare class Properties { /** * List properties * Returns a list of properties * *
* read:properties *
* * @param data The data for the request. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.startingAfter The ID of the property to start after. * @param data.endingBefore The ID of the property to end before. * @param data.context Filter results by user, organization or application context * @returns get_properties_response Properties successfully retrieved. * @throws ApiError */ static getProperties(data?: GetPropertiesData): CancelablePromise; /** * Create Property * Create property. * *
* create:properties *
* * @param data The data for the request. * @param data.requestBody Property details. * @returns create_property_response Property successfully created * @throws ApiError */ static createProperty(data: CreatePropertyData): CancelablePromise; /** * Update Property * Update property. * *
* update:properties *
* * @param data The data for the request. * @param data.propertyId The unique identifier for the property. * @param data.requestBody The fields of the property to update. * @returns success_response Property successfully updated. * @throws ApiError */ static updateProperty(data: UpdatePropertyData): CancelablePromise; /** * Delete Property * Delete property. * *
* delete:properties *
* * @param data The data for the request. * @param data.propertyId The unique identifier for the property. * @returns success_response Property successfully deleted. * @throws ApiError */ static deleteProperty(data: DeletePropertyData): CancelablePromise; } export declare class PropertyCategories { /** * List categories * Returns a list of categories. * *
* read:property_categories *
* * @param data The data for the request. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.startingAfter The ID of the category to start after. * @param data.endingBefore The ID of the category to end before. * @param data.context Filter the results by User or Organization context * @returns get_categories_response Categories successfully retrieved. * @throws ApiError */ static getCategories(data?: GetCategoriesData): CancelablePromise; /** * Create Category * Create category. * *
* create:property_categories *
* * @param data The data for the request. * @param data.requestBody Category details. * @returns create_category_response Category successfully created * @throws ApiError */ static createCategory(data: CreateCategoryData): CancelablePromise; /** * Update Category * Update category. * *
* update:property_categories *
* * @param data The data for the request. * @param data.categoryId The unique identifier for the category. * @param data.requestBody The fields of the category to update. * @returns success_response category successfully updated. * @throws ApiError */ static updateCategory(data: UpdateCategoryData): CancelablePromise; } export declare class Roles { /** * List roles * The returned list can be sorted by role name or role key in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query string parameter. * *
* read:roles *
* * @param data The data for the request. * @param data.sort Field and order to sort the result by. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.nextToken A string to get the next page of results if there are more results. * @returns get_roles_response Roles successfully retrieved. * @throws ApiError */ static getRoles(data?: GetRolesData): CancelablePromise; /** * Create role * Create role. * *
* create:roles *
* * @param data The data for the request. * @param data.requestBody Role details. * @returns create_roles_response Role successfully created * @throws ApiError */ static createRole(data?: CreateRoleData): CancelablePromise; /** * Get role * Get a role * *
* read:roles *
* * @param data The data for the request. * @param data.roleId The identifier for the role. * @returns get_role_response Role successfully retrieved. * @throws ApiError */ static getRole(data: GetRoleData): CancelablePromise; /** * Update role * Update a role * *
* update:roles *
* * @param data The data for the request. * @param data.roleId The identifier for the role. * @param data.requestBody Role details. * @returns success_response Role successfully updated * @throws ApiError */ static updateRoles(data: UpdateRolesData): CancelablePromise; /** * Delete role * Delete role * *
* delete:roles *
* * @param data The data for the request. * @param data.roleId The identifier for the role. * @returns success_response Role successfully deleted. * @throws ApiError */ static deleteRole(data: DeleteRoleData): CancelablePromise; /** * Get role scopes * Get scopes for a role. * *
* read:role_scopes *
* * @param data The data for the request. * @param data.roleId The role id. * @returns role_scopes_response A list of scopes for a role * @throws ApiError */ static getRoleScopes(data: GetRoleScopesData): CancelablePromise; /** * Add role scope * Add scope to role. * *
* create:role_scopes *
* * @param data The data for the request. * @param data.roleId The role id. * @param data.requestBody Add scope to role. * @returns add_role_scope_response Role scope successfully added. * @throws ApiError */ static addRoleScope(data: AddRoleScopeData): CancelablePromise; /** * Delete role scope * Delete scope from role. * *
* delete:role_scopes *
* * @param data The data for the request. * @param data.roleId The role id. * @param data.scopeId The scope id. * @returns delete_role_scope_response Role scope successfully deleted. * @throws ApiError */ static deleteRoleScope(data: DeleteRoleScopeData): CancelablePromise; /** * Get role permissions * Get permissions for a role. * *
* read:role_permissions *
* * @param data The data for the request. * @param data.roleId The role's public id. * @param data.sort Field and order to sort the result by. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.nextToken A string to get the next page of results if there are more results. * @returns role_permissions_response A list of permissions for a role * @throws ApiError */ static getRolePermissions(data: GetRolePermissionsData): CancelablePromise; /** * Update role permissions * Update role permissions. * *
* update:role_permissions *
* * @param data The data for the request. * @param data.roleId The identifier for the role. * @param data.requestBody * @returns update_role_permissions_response Permissions successfully updated. * @throws ApiError */ static updateRolePermissions(data: UpdateRolePermissionsData): CancelablePromise; /** * List role users * Get users that have a given role, across all organizations. Each user entry * includes the organization codes where they hold that role. * *
* read:organization_user_roles *
* * @param data The data for the request. * @param data.roleId The role's public id. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.nextToken A string to get the next page of results if there are more results. * @returns get_role_users_response A list of users with the specified role. * @throws ApiError */ static getRoleUsers(data: GetRoleUsersData): CancelablePromise; /** * Remove role permission * Remove a permission from a role. * *
* delete:role_permissions *
* * @param data The data for the request. * @param data.roleId The role's public id. * @param data.permissionId The permission's public id. * @returns success_response Permission successfully removed from role * @throws ApiError */ static removeRolePermission(data: RemoveRolePermissionData): CancelablePromise; } export declare class Search { /** * Search users * Search for users based on the provided query string. Set query to '*' to filter by other parameters only. * The number of records to return at a time can be controlled using the `page_size` query string parameter. * *
* read:users *
* * @param data The data for the request. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.query Search the users by email or name. Use '*' to search all. * @param data.apiScopes Search the users by api scopes. * @param data.properties * @param data.startingAfter The ID of the user to start after. * @param data.endingBefore The ID of the user to end before. * @param data.expand Additional data to include in the response. One or more of (comma-separated): "organizations", "identities", "properties". * @returns search_users_response Users successfully retrieved. * @throws ApiError */ static searchUsers(data?: SearchUsersData): CancelablePromise; } export declare class Subscribers { /** * List Subscribers * The returned list can be sorted by full name or email address * in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query * string parameter. * *
* read:subscribers *
* * @param data The data for the request. * @param data.sort Field and order to sort the result by. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.nextToken A string to get the next page of results if there are more results. * @returns get_subscribers_response Subscriber successfully retrieved. * @throws ApiError */ static getSubscribers(data?: GetSubscribersData): CancelablePromise; /** * Create Subscriber * Create subscriber. * *
* create:subscribers *
* * @param data The data for the request. * @param data.firstName Subscriber's first name. * @param data.lastName Subscriber's last name. * @param data.email The email address of the subscriber. * @returns create_subscriber_success_response Subscriber successfully created * @throws ApiError */ static createSubscriber(data: CreateSubscriberData): CancelablePromise; /** * Get Subscriber * Retrieve a subscriber record. * *
* read:subscribers *
* * @param data The data for the request. * @param data.subscriberId The subscriber's id. * @returns get_subscriber_response Subscriber successfully retrieved. * @throws ApiError */ static getSubscriber(data: GetSubscriberData): CancelablePromise; } export declare class Timezones { /** * Get timezones * Get a list of timezones and associated timezone keys. * *
* read:timezones *
* * @returns get_timezones_response A list of timezones. * @throws ApiError */ static getTimezones(): CancelablePromise; } export declare class Users { /** * Get users * The returned list can be sorted by full name or email address in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query string parameter. * *
* read:users *
* * @param data The data for the request. * @param data.pageSize Number of results per page. Defaults to 10 if parameter not sent. * @param data.userId Filter the results by User ID. The query string should be comma separated and url encoded. * @param data.nextToken A string to get the next page of results if there are more results. * @param data.email Filter the results by email address. The query string should be comma separated and url encoded. * @param data.username Filter the results by username. The query string should be comma separated and url encoded. * @param data.phone Filter the results by phone. The query string should be comma separated and url encoded. * @param data.expand Additional data to include in the response. One or more of (comma-separated): "organizations", "identities", "billing". * @param data.hasOrganization Filter the results by if the user has at least one organization assigned. * @param data.activeSince Filter the results to only include users who have been active since this date. Date should be in ISO 8601 format. * @returns users_response Users successfully retrieved. * @throws ApiError */ static getUsers(data?: GetUsersData): CancelablePromise; /** * Refresh User Claims and Invalidate Cache * Refreshes the user's claims and invalidates the current cache. * *
* update:user_refresh_claims *
* * @param data The data for the request. * @param data.userId The id of the user whose claims needs to be updated. * @returns success_response Claims successfully refreshed. * @throws ApiError */ static refreshUserClaims(data: RefreshUserClaimsData): CancelablePromise; /** * Get user * Retrieve a user record. * *
* read:users *
* * @param data The data for the request. * @param data.id The user's id. * @param data.expand Additional data to include in the response. One or more of (comma-separated): "organizations", "identities", "billing". * @returns user User successfully retrieved. * @throws ApiError */ static getUserData(data: GetUserDataData): CancelablePromise; /** * Create user * Creates a user record and optionally zero or more identities for the user. An example identity could be the email * address of the user. * *
* create:users *
* * @param data The data for the request. * @param data.requestBody The details of the user to create. * @returns create_user_response User successfully created. * @throws ApiError */ static createUser(data?: CreateUserData): CancelablePromise; /** * Update user * Update a user record. * *
* update:users *
* * @param data The data for the request. * @param data.id The user's id. * @param data.requestBody The user to update. * @returns update_user_response User successfully updated. * @throws ApiError */ static updateUser(data: UpdateUserData): CancelablePromise; /** * Delete user * Delete a user record. * *
* delete:users *
* * @param data The data for the request. * @param data.id The user's id. * @param data.isDeleteProfile Delete all data and remove the user's profile from all of Kinde, including the subscriber list * @returns success_response User successfully deleted. * @throws ApiError */ static deleteUser(data: DeleteUserData): CancelablePromise; /** * Update User Feature Flag Override * Update user feature flag override. * *
* update:user_feature_flags *
* * @param data The data for the request. * @param data.userId The identifier for the user * @param data.featureFlagKey The identifier for the feature flag * @param data.value Override value * @returns success_response Feature flag override successfully updated. * @throws ApiError */ static updateUserFeatureFlagOverride(data: UpdateUserFeatureFlagOverrideData): CancelablePromise; /** * Update Property value * Update property value. * *
* update:user_properties *
* * @param data The data for the request. * @param data.userId The identifier for the user * @param data.propertyKey The identifier for the property * @param data.value The new property value * @returns success_response Property successfully updated. * @throws ApiError */ static updateUserProperty(data: UpdateUserPropertyData): CancelablePromise; /** * Get property values * Gets properties for an user by ID. * *
* read:user_properties *
* * @param data The data for the request. * @param data.userId The user's ID. * @returns get_property_values_response Properties successfully retrieved. * @throws ApiError */ static getUserPropertyValues(data: GetUserPropertyValuesData): CancelablePromise; /** * Update Property values * Update property values. * *
* update:user_properties *
* * @param data The data for the request. * @param data.userId The identifier for the user * @param data.requestBody Properties to update. * @returns success_response Properties successfully updated. * @throws ApiError */ static updateUserProperties(data: UpdateUserPropertiesData): CancelablePromise; /** * Set User password * Set user password. * *
* update:user_passwords *
* * @param data The data for the request. * @param data.userId The identifier for the user * @param data.requestBody Password details. * @returns success_response User successfully created. * @throws ApiError */ static setUserPassword(data: SetUserPasswordData): CancelablePromise; /** * Get identities * Gets a list of identities for an user by ID. * *
* read:user_identities *
* * @param data The data for the request. * @param data.userId The user's ID. * @param data.startingAfter The ID of the identity to start after. * @param data.endingBefore The ID of the identity to end before. * @returns get_identities_response Identities successfully retrieved. * @throws ApiError */ static getUserIdentities(data: GetUserIdentitiesData): CancelablePromise; /** * Create identity * Creates an identity for a user. * *
* create:user_identities *
* * @param data The data for the request. * @param data.userId The user's ID. * @param data.requestBody The identity details. * @returns create_identity_response Identity successfully created. * @throws ApiError */ static createUserIdentity(data: CreateUserIdentityData): CancelablePromise; /** * Get user sessions * Retrieve the list of active sessions for a specific user. * *
* read:user_sessions *
* * @param data The data for the request. * @param data.userId The identifier for the user * @returns get_user_sessions_response Successfully retrieved user sessions. * @throws ApiError */ static getUserSessions(data: GetUserSessionsData): CancelablePromise; /** * Delete user sessions * Invalidate user sessions. * *
* delete:user_sessions *
* * @param data The data for the request. * @param data.userId The identifier for the user * @returns success_response User sessions successfully invalidated. * @throws ApiError */ static deleteUserSessions(data: DeleteUserSessionsData): CancelablePromise; /** * Get user's MFA configuration * Get a user’s MFA configuration. * *
* read:user_mfa *
* * @param data The data for the request. * @param data.userId The identifier for the user * @returns get_user_mfa_response Successfully retrieve user's MFA configuration. * @throws ApiError */ static getUsersMfa(data: GetUsersMfaData): CancelablePromise; /** * Reset all environment MFA for a user * Reset all environment MFA factors for a user. * *
* delete:user_mfa *
* * @param data The data for the request. * @param data.userId The identifier for the user * @returns success_response User's MFA successfully reset. * @throws ApiError */ static resetUsersMfaAll(data: ResetUsersMfaAllData): CancelablePromise; /** * Reset specific environment MFA for a user * Reset a specific environment MFA factor for a user. * *
* delete:user_mfa *
* * @param data The data for the request. * @param data.userId The identifier for the user * @param data.factorId The identifier for the MFA factor * @returns success_response User's MFA successfully reset. * @throws ApiError */ static resetUsersMfa(data: ResetUsersMfaData): CancelablePromise; } export declare class Webhooks { /** * Get Event * Returns an event * *
* read:events *
* * @param data The data for the request. * @param data.eventId The event id. * @returns get_event_response Event successfully retrieved. * @throws ApiError */ static getEvent(data: GetEventData): CancelablePromise; /** * List Event Types * Returns a list event type definitions * *
* read:event_types *
* * @returns get_event_types_response Event types successfully retrieved. * @throws ApiError */ static getEventTypes(): CancelablePromise; /** * Delete Webhook * Delete webhook * *
* delete:webhooks *
* * @param data The data for the request. * @param data.webhookId The webhook id. * @returns delete_webhook_response Webhook successfully deleted. * @throws ApiError */ static deleteWebHook(data: DeleteWebHookData): CancelablePromise; /** * Update a Webhook * Update a webhook * *
* update:webhooks *
* * @param data The data for the request. * @param data.webhookId The webhook id. * @param data.requestBody Update webhook request specification. * @returns update_webhook_response Webhook successfully updated. * @throws ApiError */ static updateWebHook(data: UpdateWebHookData): CancelablePromise; /** * List Webhooks * List webhooks * *
* read:webhooks *
* * @returns get_webhooks_response Webhook list successfully returned. * @throws ApiError */ static getWebHooks(): CancelablePromise; /** * Create a Webhook * Create a webhook * *
* create:webhooks *
* * @param data The data for the request. * @param data.requestBody Webhook request specification. * @returns create_webhook_response Webhook successfully created. * @throws ApiError */ static createWebHook(data: CreateWebHookData): CancelablePromise; }