export declare const $success_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly example: "Success"; }; readonly code: { readonly type: "string"; readonly example: "OK"; }; }; }; export declare const $error: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Error code."; }; readonly message: { readonly type: "string"; readonly description: "Error message."; }; }; }; export declare const $error_response: { readonly type: "object"; readonly properties: { readonly errors: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/error"; }; }; }; }; export declare const $not_found_response: { readonly type: "object"; readonly properties: { readonly errors: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly example: "ROUTE_NOT_FOUND"; }; readonly message: { readonly type: "string"; readonly example: "The requested API route does not exist"; }; }; }; }; }; export declare const $get_apis_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly next_token: { readonly type: "string"; readonly description: "Pagination token."; readonly example: "Njo5Om1hvWVfYXNj"; }; readonly apis: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The unique ID for the API."; readonly type: "string"; readonly example: "7ccd126599aa422a771abcb341596881"; }; readonly name: { readonly type: "string"; readonly description: "The API's name."; readonly example: "Example API"; }; readonly audience: { readonly type: "string"; readonly description: "A unique identifier for the API - commonly the URL. This value will be used as the `audience` parameter in authorization claims."; readonly example: "https://api.example.com"; }; readonly is_management_api: { readonly type: "boolean"; readonly description: "Whether or not it is the Kinde management API."; readonly example: false; }; readonly scopes: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly example: "api_scope_01939128c3d7193ae87c4755213c07c6"; }; readonly key: { readonly type: "string"; readonly example: "create:apis"; }; }; }; }; }; }; }; }; }; export declare const $create_apis_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly description: "A Kinde generated message."; readonly example: "Success"; }; readonly code: { readonly type: "string"; readonly description: "A Kinde generated status code."; readonly example: "OK"; }; readonly api: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The unique ID for the API."; readonly type: "string"; readonly example: "7ccd126599aa422a771abcb341596881"; }; }; }; }; }; export declare const $create_api_scopes_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly description: "A Kinde generated message."; readonly example: "Success"; }; readonly code: { readonly type: "string"; readonly description: "A Kinde generated status code."; readonly example: "OK"; }; readonly scope: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The unique ID for the API scope."; readonly type: "string"; readonly example: "api_scope_0193ab57965aef77b2b687d0ef673713"; }; }; }; }; }; export declare const $get_environment_variables_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly has_more: { readonly description: "Whether more records exist."; readonly type: "boolean"; }; readonly environment_variables: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/environment_variable"; }; }; }; }; export declare const $get_environment_variable_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly environment_variable: { readonly $ref: "#/components/schemas/environment_variable"; }; }; }; export declare const $create_environment_variable_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly description: "A Kinde generated message."; readonly example: "Environment variable created"; }; readonly code: { readonly type: "string"; readonly description: "A Kinde generated status code."; readonly example: "VARIABLE_CREATED"; }; readonly environment_variable: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The unique ID for the environment variable."; readonly type: "string"; readonly example: "env_var_0192b194f6156fb7452fe38cfb144958"; }; }; }; }; }; export declare const $update_environment_variable_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly description: "A Kinde generated message."; readonly example: "Environment variable updated"; }; readonly code: { readonly type: "string"; readonly description: "A Kinde generated status code."; readonly example: "ENVIRONMENT_VARIABLE_UPDATED"; }; }; }; export declare const $delete_environment_variable_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly description: "A Kinde generated message."; readonly example: "Environment variable deleted"; }; readonly code: { readonly type: "string"; readonly description: "A Kinde generated status code."; readonly example: "ENVIRONMENT_VARIABLE_DELETED"; }; }; }; export declare const $get_business_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly business: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "The unique ID for the business."; readonly example: "bus_c69fb73b091"; }; readonly name: { readonly type: "string"; readonly description: "Your business's name."; readonly example: "Tailsforce Ltd"; }; readonly phone: { readonly type: "string"; readonly description: "Phone number associated with business."; readonly example: "555-555-5555"; readonly nullable: true; }; readonly email: { readonly type: "string"; readonly description: "Email address associated with business."; readonly example: "sally@example.com"; readonly nullable: true; }; readonly industry: { readonly type: "string"; readonly description: "The industry your business is in."; readonly example: "Healthcare & Medical"; readonly nullable: true; }; readonly timezone: { readonly type: "string"; readonly description: "The timezone your business is in."; readonly example: "Los Angeles (Pacific Standard Time)"; readonly nullable: true; }; readonly privacy_url: { readonly type: "string"; readonly description: "Your Privacy policy URL."; readonly example: "https://example.com/privacy"; readonly nullable: true; }; readonly terms_url: { readonly type: "string"; readonly description: "Your Terms and Conditions URL."; readonly example: "https://example.com/terms"; readonly nullable: true; }; readonly has_clickwrap: { readonly type: "boolean"; readonly description: "Whether your business uses clickwrap agreements."; readonly example: false; }; readonly has_kinde_branding: { readonly type: "boolean"; readonly description: "Whether your business shows Kinde branding."; readonly example: true; }; readonly created_on: { readonly type: "string"; readonly description: "Date of business creation in ISO 8601 format."; readonly example: "2021-01-01T00:00:00Z"; }; }; }; }; }; export declare const $get_industries_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly industries: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly key: { readonly description: "The unique key for the industry."; readonly type: "string"; readonly example: "administration_office_support"; }; readonly name: { readonly type: "string"; readonly description: "The display name for the industry."; readonly example: "Administration & Office Support"; }; }; }; }; }; }; export declare const $get_timezones_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly timezones: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly key: { readonly description: "The unique key for the timezone."; readonly type: "string"; readonly example: "london_greenwich_mean_time"; }; readonly name: { readonly type: "string"; readonly description: "The display name for the timezone."; readonly example: "London (Greenwich Mean Time) [+01:00]"; }; }; }; }; }; }; export declare const $get_api_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "success_response"; }; readonly api: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique ID of the API."; readonly example: "7ccd126599aa422a771abcb341596881"; }; readonly name: { readonly type: "string"; readonly description: "The API's name."; readonly example: "Example API"; }; readonly audience: { readonly type: "string"; readonly description: "A unique identifier for the API - commonly the URL. This value will be used as the `audience` parameter in authorization claims."; readonly example: "https://api.example.com"; }; readonly is_management_api: { readonly type: "boolean"; readonly description: "Whether or not it is the Kinde management API."; readonly example: false; }; readonly scopes: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The ID of the scope."; readonly example: "api_scope_01939222ef24200668b9f5829af001ce"; }; readonly key: { readonly type: "string"; readonly description: "The reference key for the scope."; readonly example: "read:logs"; }; }; }; }; readonly applications: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The Client ID of the application."; readonly example: "3b0b5c6c8fcc464fab397f4969b5f482"; }; readonly name: { readonly type: "string"; readonly description: "The application's name."; readonly example: "My M2M app"; }; readonly type: { readonly type: "string"; readonly description: "The application's type."; readonly enum: readonly ["Machine to machine (M2M)", "Back-end web", "Front-end and mobile", "Device and IoT"]; readonly example: "Machine to machine (M2M)"; }; readonly is_active: { readonly type: "boolean"; readonly description: "Whether or not the application is authorized to access the API"; readonly example: true; readonly nullable: true; }; }; }; }; }; }; }; }; export declare const $get_api_scopes_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "success_response"; }; readonly scopes: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique ID of the API scope."; readonly example: "api_scope_01939128c3d7193ae87c4755213c07c6"; }; readonly key: { readonly type: "string"; readonly description: "The scope's reference key."; readonly example: "read:logs"; }; readonly description: { readonly type: "string"; readonly description: "Explanation of the scope purpose."; readonly example: "Read logs scope"; }; }; }; }; }; }; export declare const $get_api_scope_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "success_response"; }; readonly scope: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique ID of the API scope."; readonly example: "api_scope_01939128c3d7193ae87c4755213c07c6"; }; readonly key: { readonly type: "string"; readonly description: "The scope's reference key."; readonly example: "read:logs"; }; readonly description: { readonly type: "string"; readonly description: "Explanation of the scope purpose."; readonly example: "Read logs scope"; }; }; }; }; }; export declare const $authorize_app_api_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly example: "API applications updated"; }; readonly code: { readonly type: "string"; readonly example: "API_APPLICATIONS_UPDATED"; }; readonly applications_disconnected: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly applications_connected: { readonly type: "array"; readonly items: { readonly type: "string"; readonly example: "d2db282d6214242b3b145c123f0c123"; }; }; }; }; export declare const $delete_api_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly example: "API successfully deleted"; }; readonly code: { readonly type: "string"; readonly example: "API_DELETED"; }; }; }; export declare const $user: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique ID of the user in Kinde."; }; readonly provided_id: { readonly type: "string"; readonly description: "External ID for user."; }; readonly preferred_email: { readonly type: "string"; readonly description: "Default email address of the user in Kinde."; }; readonly phone: { readonly type: "string"; readonly description: "User's primary phone number."; }; readonly username: { readonly type: "string"; readonly description: "Primary username of the user in Kinde."; }; readonly last_name: { readonly type: "string"; readonly description: "User's last name."; }; readonly first_name: { readonly type: "string"; readonly description: "User's first name."; }; readonly is_suspended: { readonly type: "boolean"; readonly description: "Whether the user is currently suspended or not."; }; readonly picture: { readonly type: "string"; readonly description: "User's profile picture URL."; }; readonly total_sign_ins: { readonly type: "integer"; readonly description: "Total number of user sign ins."; readonly nullable: true; }; readonly failed_sign_ins: { readonly type: "integer"; readonly description: "Number of consecutive failed user sign ins."; readonly nullable: true; }; readonly last_signed_in: { readonly type: "string"; readonly description: "Last sign in date in ISO 8601 format."; readonly nullable: true; }; readonly created_on: { readonly type: "string"; readonly description: "Date of user creation in ISO 8601 format."; readonly nullable: true; }; readonly organizations: { readonly type: "array"; readonly description: "Array of organizations a user belongs to."; readonly items: { readonly type: "string"; }; }; readonly identities: { readonly type: "array"; readonly description: "Array of identities belonging to the user."; readonly items: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; }; readonly identity: { readonly type: "string"; }; }; }; }; readonly billing: { readonly type: "object"; readonly properties: { readonly customer_id: { readonly type: "string"; }; }; }; }; }; export declare const $update_user_response: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique ID of the user in Kinde."; }; readonly given_name: { readonly type: "string"; readonly description: "User's first name."; }; readonly family_name: { readonly type: "string"; readonly description: "User's last name."; }; readonly email: { readonly type: "string"; readonly description: "User's preferred email."; }; readonly is_suspended: { readonly type: "boolean"; readonly description: "Whether the user is currently suspended or not."; }; readonly is_password_reset_requested: { readonly type: "boolean"; readonly description: "Whether a password reset has been requested."; }; readonly picture: { readonly type: "string"; readonly description: "User's profile picture URL."; readonly nullable: true; }; }; }; export declare const $users: { readonly type: "array"; readonly description: "Array of users."; readonly items: { readonly $ref: "#/components/schemas/user"; }; }; export declare const $users_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly users: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique ID of the user in Kinde."; }; readonly provided_id: { readonly type: "string"; readonly description: "External ID for user."; }; readonly email: { readonly type: "string"; readonly description: "Default email address of the user in Kinde."; }; readonly phone: { readonly type: "string"; readonly description: "User's primary phone number."; }; readonly username: { readonly type: "string"; readonly description: "Primary username of the user in Kinde."; }; readonly last_name: { readonly type: "string"; readonly description: "User's last name."; }; readonly first_name: { readonly type: "string"; readonly description: "User's first name."; }; readonly is_suspended: { readonly type: "boolean"; readonly description: "Whether the user is currently suspended or not."; }; readonly picture: { readonly type: "string"; readonly description: "User's profile picture URL."; }; readonly total_sign_ins: { readonly type: "integer"; readonly description: "Total number of user sign ins."; readonly nullable: true; }; readonly failed_sign_ins: { readonly type: "integer"; readonly description: "Number of consecutive failed user sign ins."; readonly nullable: true; }; readonly last_signed_in: { readonly type: "string"; readonly description: "Last sign in date in ISO 8601 format."; readonly nullable: true; }; readonly created_on: { readonly type: "string"; readonly description: "Date of user creation in ISO 8601 format."; readonly nullable: true; }; readonly last_organization_sign_ins: { readonly type: "array"; readonly description: "Array of organization sign-in information for the user."; readonly nullable: true; readonly items: { readonly type: "object"; readonly properties: { readonly org_code: { readonly type: "string"; readonly description: "The organization code."; readonly example: "org_d2d85014942"; }; readonly last_signed_in: { readonly type: "string"; readonly format: "date-time"; readonly description: "The date and time the user last signed in to this organization in ISO 8601 format."; readonly example: "2026-01-28T14:26:02.448856+00:00"; }; }; }; }; readonly organizations: { readonly type: "array"; readonly description: "Array of organizations a user belongs to."; readonly items: { readonly type: "string"; }; }; readonly identities: { readonly type: "array"; readonly description: "Array of identities belonging to the user."; readonly items: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; }; readonly identity: { readonly type: "string"; }; readonly connection_id: { readonly type: "string"; readonly description: "The social or enterprise connection ID associated with the identity. Null for email, phone, username, and passkey identities."; readonly nullable: true; readonly example: "conn_019289347f1193da6c0e4d49b97b4bd2"; }; }; }; }; readonly billing: { readonly type: "object"; readonly properties: { readonly customer_id: { readonly type: "string"; readonly description: "The billing customer id."; readonly example: "customer_1245adbc6789"; }; }; }; }; }; }; readonly next_token: { readonly type: "string"; readonly description: "Pagination token."; }; }; }; export declare const $search_users_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly results: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Unique ID of the user in Kinde."; readonly example: "kp_0ba7c433e5d648cf992621ce99d42817"; }; readonly provided_id: { readonly type: "string"; readonly description: "External ID for user."; readonly nullable: true; readonly example: "U123456"; }; readonly email: { readonly type: "string"; readonly description: "Default email address of the user in Kinde."; readonly nullable: true; readonly example: "user@domain.com"; }; readonly username: { readonly type: "string"; readonly description: "Primary username of the user in Kinde."; readonly nullable: true; readonly example: "john.snow"; }; readonly last_name: { readonly type: "string"; readonly description: "User's last name."; readonly example: "Snow"; }; readonly first_name: { readonly type: "string"; readonly description: "User's first name."; readonly example: "John"; }; readonly is_suspended: { readonly type: "boolean"; readonly description: "Whether the user is currently suspended or not."; readonly example: true; }; readonly picture: { readonly type: "string"; readonly description: "User's profile picture URL."; readonly example: "https://example.com/john_snow.jpg"; readonly nullable: true; }; readonly total_sign_ins: { readonly type: "integer"; readonly description: "Total number of user sign ins."; readonly nullable: true; readonly example: 1; }; readonly failed_sign_ins: { readonly type: "integer"; readonly description: "Number of consecutive failed user sign ins."; readonly nullable: true; readonly example: 0; }; readonly last_signed_in: { readonly type: "string"; readonly description: "Last sign in date in ISO 8601 format."; readonly nullable: true; readonly example: "2025-02-12T18:02:23.614638+00:00"; }; readonly created_on: { readonly type: "string"; readonly description: "Date of user creation in ISO 8601 format."; readonly nullable: true; readonly example: "2025-02-12T18:02:23.614638+00:00"; }; readonly organizations: { readonly type: "array"; readonly description: "Array of organizations a user belongs to."; readonly items: { readonly type: "string"; }; }; readonly identities: { readonly type: "array"; readonly description: "Array of identities belonging to the user."; readonly items: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; }; readonly identity: { readonly type: "string"; }; }; }; }; readonly properties: { readonly type: "object"; readonly description: "The user properties."; readonly additionalProperties: { readonly type: "string"; }; }; readonly api_scopes: { readonly type: "array"; readonly description: "Array of api scopes belonging to the user."; readonly items: { readonly type: "object"; readonly properties: { readonly org_code: { readonly type: "string"; }; readonly scope: { readonly type: "string"; }; readonly api_id: { readonly type: "string"; }; }; }; }; }; }; }; }; }; export declare const $create_user_response: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "Unique ID of the user in Kinde."; readonly type: "string"; }; readonly created: { readonly description: "True if the user was successfully created."; readonly type: "boolean"; }; readonly identities: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/user_identity"; }; }; }; }; export declare const $create_organization_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly organization: { readonly type: "object"; readonly properties: { readonly code: { readonly description: "The organization's unique code."; readonly type: "string"; readonly example: "org_1ccfb819462"; }; readonly billing_customer_id: { readonly description: "The billing customer id if the organization was created with the is_create_billing_customer as true"; readonly type: "string"; readonly example: "customer_1245adbc6789"; }; }; }; }; }; export declare const $user_identity: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; readonly description: "The type of identity object created."; }; readonly result: { readonly type: "object"; readonly description: "The result of the user creation operation."; readonly properties: { readonly created: { readonly type: "boolean"; readonly description: "True if the user identity was successfully created."; }; }; }; }; }; export declare const $create_property_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; }; readonly code: { readonly type: "string"; }; readonly property: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The property's ID."; readonly type: "string"; }; }; }; }; }; export declare const $create_identity_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; }; readonly code: { readonly type: "string"; }; readonly identity: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The identity's ID."; readonly type: "string"; }; }; }; }; }; export declare const $get_identities_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly identities: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/identity"; }; }; readonly has_more: { readonly description: "Whether more records exist."; readonly type: "boolean"; }; }; }; export declare const $get_user_sessions_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly example: "Success"; }; readonly has_more: { readonly type: "boolean"; readonly example: false; }; readonly sessions: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly user_id: { readonly description: "The unique identifier of the user associated with the session."; readonly type: "string"; readonly example: "kp_5fc30d0547734f30aca617450202169f"; }; readonly org_code: { readonly description: "The organization code associated with the session, if applicable."; readonly type: "string"; readonly nullable: true; readonly example: "org_1ccfb819462"; }; readonly client_id: { readonly description: "The client ID used to initiate the session."; readonly type: "string"; readonly example: "3b0b5c6c8fcc464fab397f4969b5f482"; }; readonly expires_on: { readonly description: "The timestamp indicating when the session will expire."; readonly type: "string"; readonly format: "date-time"; readonly example: "2025-04-02T13:04:20.315701+11:00"; }; readonly session_id: { readonly description: "The unique identifier of the session."; readonly type: "string"; readonly example: "session_0xc75ec12fe8434ffc9d527794f00692e5"; }; readonly started_on: { readonly description: "The timestamp when the session was initiated."; readonly type: "string"; readonly format: "date-time"; readonly example: "2025-04-01T13:04:20.315701+11:00"; }; readonly updated_on: { readonly description: "The timestamp of the last update to the session."; readonly type: "string"; readonly format: "date-time"; readonly example: "2025-04-01T13:04:20+11"; }; readonly connection_id: { readonly description: "The identifier of the connection through which the session was established."; readonly type: "string"; readonly example: "conn_75ab8ec0faae4f73bae9fc64daf120c9"; }; readonly last_ip_address: { readonly description: "The last known IP address of the user during this session."; readonly type: "string"; readonly example: "192.168.65.1"; }; readonly last_user_agent: { readonly description: "The last known user agent (browser or app) used during this session."; readonly type: "string"; readonly example: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36"; }; readonly initial_ip_address: { readonly description: "The IP address from which the session was initially started."; readonly type: "string"; readonly example: "192.168.65.1"; }; readonly initial_user_agent: { readonly description: "The user agent (browser or app) used when the session was first created."; readonly type: "string"; readonly example: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36"; }; }; }; }; }; }; export declare const $get_user_mfa_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; }; readonly code: { readonly type: "string"; }; readonly mfa: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The MFA's identifier."; readonly type: "string"; readonly example: "mfa_01933d1ca1f093e7fad48ebcdb65a871"; }; readonly type: { readonly description: "The type of MFA (e.g. email, SMS, authenticator app)."; readonly type: "string"; readonly example: "email"; }; readonly created_on: { readonly description: "The timestamp when the MFA was created."; readonly type: "string"; readonly format: "date-time"; readonly example: "2024-11-18T13:31:46.795085+11:00"; }; readonly name: { readonly description: "The identifier used for MFA (e.g. email address, phone number)."; readonly type: "string"; readonly example: "sally@gmail.com"; }; readonly is_verified: { readonly description: "Whether the MFA is verified or not."; readonly type: "boolean"; readonly example: true; }; readonly usage_count: { readonly description: "The number of times MFA has been used."; readonly type: "integer"; readonly example: 2; }; readonly last_used_on: { readonly description: "The timestamp when the MFA was last used."; readonly type: "string"; readonly format: "date-time"; readonly example: "2024-11-18T13:32:07.22538+11:00"; }; }; }; }; }; export declare const $get_properties_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly properties: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/property"; }; }; readonly has_more: { readonly description: "Whether more records exist."; readonly type: "boolean"; }; }; }; export declare const $get_property_values_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly properties: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/property_value"; }; }; readonly next_token: { readonly description: "Pagination token."; readonly type: "string"; }; }; }; export declare const $create_category_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; }; readonly code: { readonly type: "string"; }; readonly category: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The category's ID."; readonly type: "string"; }; }; }; }; }; export declare const $get_categories_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly categories: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/category"; }; }; readonly has_more: { readonly description: "Whether more records exist."; readonly type: "boolean"; }; }; }; export declare const $get_event_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly event: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; }; readonly source: { readonly type: "string"; }; readonly event_id: { readonly type: "string"; }; readonly timestamp: { readonly type: "integer"; readonly description: "Timestamp in ISO 8601 format."; }; readonly data: { readonly type: "object"; readonly description: "Event specific data object."; }; }; }; }; }; export declare const $get_event_types_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly event_types: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/event_type"; }; }; }; }; export declare const $get_webhooks_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly webhooks: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/webhook"; }; }; }; }; export declare const $webhook: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; readonly endpoint: { readonly type: "string"; }; readonly description: { readonly type: "string"; }; readonly event_types: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly created_on: { readonly type: "string"; readonly description: "Created on date in ISO 8601 format."; }; }; }; export declare const $create_webhook_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly webhook: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly endpoint: { readonly type: "string"; }; }; }; }; }; export declare const $update_webhook_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; }; readonly code: { readonly type: "string"; }; readonly webhook: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; }; }; }; }; export declare const $create_connection_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; }; readonly code: { readonly type: "string"; }; readonly connection: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The connection's ID."; readonly type: "string"; }; }; }; }; }; export declare const $get_connections_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly connections: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/connection"; }; }; readonly has_more: { readonly description: "Whether more records exist."; readonly type: "boolean"; }; }; }; export declare const $delete_webhook_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; }; }; export declare const $event_type: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly code: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; readonly origin: { readonly type: "string"; }; readonly schema: { readonly type: "object"; }; }; }; export declare const $organization_item_schema: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "The unique identifier for the organization."; readonly example: "org_1ccfb819462"; }; readonly name: { readonly type: "string"; readonly description: "The organization's name."; readonly example: "Acme Corp"; }; readonly handle: { readonly type: "string"; readonly description: "A unique handle for the organization - can be used for dynamic callback urls."; readonly example: "acme_corp"; readonly nullable: true; }; readonly is_default: { readonly type: "boolean"; readonly description: "Whether the organization is the default organization."; readonly example: false; }; readonly external_id: { readonly type: "string"; readonly description: "The organization's external identifier - commonly used when migrating from or mapping to other systems."; readonly example: "some1234"; readonly nullable: true; }; readonly is_auto_membership_enabled: { readonly type: "boolean"; readonly example: true; readonly description: "If users become members of this organization when the org code is supplied during authentication."; }; }; }; export declare const $get_environment_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "success_response"; }; readonly environment: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "The unique identifier for the environment."; readonly example: "production"; }; readonly name: { readonly type: "string"; readonly description: "The environment's name."; readonly example: "Production"; }; readonly hotjar_site_id: { readonly type: "string"; readonly description: "Your HotJar site ID."; readonly example: 404009; readonly nullable: true; }; readonly google_analytics_tag: { readonly type: "string"; readonly description: "Your Google Analytics tag."; readonly example: "G-1234567"; readonly nullable: true; }; readonly contentsquare_tag_id: { readonly type: "string"; readonly description: "Your Contentsquare Tag ID."; readonly example: "769238b6e1309"; readonly nullable: true; }; readonly is_default: { readonly type: "boolean"; readonly description: "Whether the environment is the default. Typically this is your production environment."; readonly example: true; }; readonly is_live: { readonly type: "boolean"; readonly description: "Whether the environment is live."; readonly example: true; }; readonly kinde_domain: { readonly type: "string"; readonly description: "Your domain on Kinde"; readonly example: "example.kinde.com"; }; readonly custom_domain: { readonly type: "string"; readonly description: "Your custom domain for the environment"; readonly nullable: true; readonly example: "app.example.com"; }; readonly logo: { readonly type: "string"; readonly nullable: true; readonly description: "The organization's logo URL."; readonly example: "https://yoursubdomain.kinde.com/logo?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d"; }; readonly logo_dark: { readonly type: "string"; readonly nullable: true; readonly description: "The organization's logo URL to be used for dark themes."; readonly example: "https://yoursubdomain.kinde.com/logo_dark?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d"; }; readonly favicon_svg: { readonly type: "string"; readonly nullable: true; readonly description: "The organization's SVG favicon URL. Optimal format for most browsers"; readonly example: "https://yoursubdomain.kinde.com/favicon_svg?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d"; }; readonly favicon_fallback: { readonly type: "string"; readonly nullable: true; readonly description: "The favicon URL to be used as a fallback in browsers that don't support SVG, add a PNG"; readonly example: "https://yoursubdomain.kinde.com/favicon_fallback?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d"; }; readonly link_color: { readonly type: "object"; readonly nullable: true; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly background_color: { readonly nullable: true; readonly type: "object"; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#ffffff"; }; readonly hex: { readonly type: "string"; readonly example: "#ffffff"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(0, 0%, 100%)"; }; }; }; readonly button_color: { readonly nullable: true; readonly type: "object"; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly button_text_color: { readonly nullable: true; readonly type: "object"; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#ffffff"; }; readonly hex: { readonly type: "string"; readonly example: "#ffffff"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(0, 0%, 100%)"; }; }; }; readonly link_color_dark: { readonly type: "object"; readonly nullable: true; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly background_color_dark: { readonly type: "object"; readonly nullable: true; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly button_text_color_dark: { readonly type: "object"; readonly nullable: true; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly button_color_dark: { readonly type: "object"; readonly nullable: true; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly button_border_radius: { readonly type: "integer"; readonly nullable: true; readonly description: "The border radius for buttons. Value is px, Kinde transforms to rem for rendering"; readonly example: 8; }; readonly card_border_radius: { readonly type: "integer"; readonly nullable: true; readonly description: "The border radius for cards. Value is px, Kinde transforms to rem for rendering"; readonly example: 16; }; readonly input_border_radius: { readonly type: "integer"; readonly nullable: true; readonly description: "The border radius for inputs. Value is px, Kinde transforms to rem for rendering"; readonly example: 4; }; readonly theme_code: { readonly type: "string"; readonly description: "Whether the environment is forced into light mode, dark mode or user preference"; readonly enum: readonly ["light", "dark", "user_preference"]; }; readonly color_scheme: { readonly type: "string"; readonly description: "The color scheme for the environment used for meta tags based on the theme code"; readonly enum: readonly ["light", "dark", "light dark"]; }; readonly created_on: { readonly type: "string"; readonly description: "Date of environment creation in ISO 8601 format."; readonly example: "2021-01-01T00:00:00Z"; }; }; }; }; }; export declare const $get_organization_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "The unique identifier for the organization."; readonly example: "org_1ccfb819462"; }; readonly name: { readonly type: "string"; readonly description: "The organization's name."; readonly example: "Acme Corp"; }; readonly handle: { readonly type: "string"; readonly description: "A unique handle for the organization - can be used for dynamic callback urls."; readonly example: "acme_corp"; readonly nullable: true; }; readonly is_default: { readonly type: "boolean"; readonly description: "Whether the organization is the default organization."; readonly example: false; }; readonly external_id: { readonly type: "string"; readonly description: "The organization's external identifier - commonly used when migrating from or mapping to other systems."; readonly example: "some1234"; readonly nullable: true; }; readonly is_auto_membership_enabled: { readonly type: "boolean"; readonly example: true; readonly description: "If users become members of this organization when the org code is supplied during authentication."; }; readonly logo: { readonly type: "string"; readonly nullable: true; readonly description: "The organization's logo URL."; readonly example: "https://yoursubdomain.kinde.com/logo?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d"; }; readonly logo_dark: { readonly type: "string"; readonly nullable: true; readonly description: "The organization's logo URL to be used for dark themes."; readonly example: "https://yoursubdomain.kinde.com/logo_dark?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d"; }; readonly favicon_svg: { readonly type: "string"; readonly nullable: true; readonly description: "The organization's SVG favicon URL. Optimal format for most browsers"; readonly example: "https://yoursubdomain.kinde.com/favicon_svg?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d"; }; readonly favicon_fallback: { readonly type: "string"; readonly nullable: true; readonly description: "The favicon URL to be used as a fallback in browsers that don't support SVG, add a PNG"; readonly example: "https://yoursubdomain.kinde.com/favicon_fallback?org_code=org_1ccfb819462&cache=311308b8ad3544bf8e572979f0e5748d"; }; readonly allowed_domains: { readonly type: "array"; readonly description: "Domains allowed for self-sign up to this environment. Empty array means no restrictions."; readonly example: readonly ["https://acme.kinde.com", "https://acme.com"]; readonly items: { readonly type: "string"; }; }; readonly link_color: { readonly type: "object"; readonly nullable: true; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly background_color: { readonly nullable: true; readonly type: "object"; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#ffffff"; }; readonly hex: { readonly type: "string"; readonly example: "#ffffff"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(0, 0%, 100%)"; }; }; }; readonly button_color: { readonly nullable: true; readonly type: "object"; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly button_text_color: { readonly nullable: true; readonly type: "object"; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#ffffff"; }; readonly hex: { readonly type: "string"; readonly example: "#ffffff"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(0, 0%, 100%)"; }; }; }; readonly link_color_dark: { readonly type: "object"; readonly nullable: true; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly background_color_dark: { readonly type: "object"; readonly nullable: true; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly button_text_color_dark: { readonly type: "object"; readonly nullable: true; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly button_color_dark: { readonly type: "object"; readonly nullable: true; readonly properties: { readonly raw: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hex: { readonly type: "string"; readonly example: "#0056F1"; }; readonly hsl: { readonly type: "string"; readonly example: "hsl(220, 100%, 50%)"; }; }; }; readonly button_border_radius: { readonly type: "integer"; readonly nullable: true; readonly description: "The border radius for buttons. Value is px, Kinde transforms to rem for rendering"; readonly example: 8; }; readonly card_border_radius: { readonly type: "integer"; readonly nullable: true; readonly description: "The border radius for cards. Value is px, Kinde transforms to rem for rendering"; readonly example: 16; }; readonly input_border_radius: { readonly type: "integer"; readonly nullable: true; readonly description: "The border radius for inputs. Value is px, Kinde transforms to rem for rendering"; readonly example: 4; }; readonly theme_code: { readonly type: "string"; readonly description: "Whether the environment is forced into light mode, dark mode or user preference"; readonly enum: readonly ["light", "dark", "user_preference"]; }; readonly color_scheme: { readonly type: "string"; readonly description: "The color scheme for the environment used for meta tags based on the theme code"; readonly enum: readonly ["light", "dark", "light dark"]; }; readonly created_on: { readonly type: "string"; readonly description: "Date of organization creation in ISO 8601 format."; readonly example: "2021-01-01T00:00:00Z"; }; readonly is_allow_registrations: { readonly nullable: true; readonly type: "boolean"; readonly example: true; readonly deprecated: true; readonly description: "Deprecated - Use 'is_auto_membership_enabled' instead"; }; readonly sender_name: { readonly nullable: true; readonly type: "string"; readonly example: "Acme Corp"; readonly description: "The name of the organization that will be used in emails"; }; readonly sender_email: { readonly nullable: true; readonly type: "string"; readonly example: "hello@acmecorp.com"; readonly description: "The email address that will be used in emails. Requires custom SMTP to be set up."; }; readonly is_suspended: { readonly type: "boolean"; readonly description: "Whether the organization is currently suspended or not."; readonly example: false; }; readonly suspended_on: { readonly type: "string"; readonly description: "The date the organization was suspended in ISO 8601 format. Null if not suspended."; readonly nullable: true; readonly example: "2021-01-01T00:00:00Z"; }; readonly billing: { readonly type: "object"; readonly description: "The billing information if the organization is a billing customer."; readonly properties: { readonly billing_customer_id: { readonly type: "string"; }; readonly agreements: { readonly type: "array"; readonly description: "The billing agreements the billing customer is currently subscribed to"; readonly items: { readonly type: "object"; readonly properties: { readonly plan_code: { readonly type: "string"; readonly example: "pro"; readonly description: "The code of the plan from which this agreement is taken from"; }; readonly agreement_id: { readonly type: "string"; readonly example: "agreement_a1234b"; readonly description: "The id of the billing agreement in Kinde"; }; }; }; }; }; }; }; }; export declare const $organization_user: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly example: "kp:97c2ba24217d48e3b96a799b76cf2c74"; readonly description: "The unique ID for the user."; readonly nullable: true; }; readonly email: { readonly type: "string"; readonly example: "john.snow@example.com"; readonly description: "The user's email address."; readonly nullable: true; }; readonly full_name: { readonly type: "string"; readonly example: "John Snow"; readonly description: "The user's full name."; }; readonly last_name: { readonly type: "string"; readonly example: "Snow"; readonly description: "The user's last name."; readonly nullable: true; }; readonly first_name: { readonly type: "string"; readonly example: "John"; readonly description: "The user's first name."; readonly nullable: true; }; readonly picture: { readonly type: "string"; readonly example: "https://example.com/john_snow.jpg"; readonly description: "The user's profile picture URL."; readonly nullable: true; }; readonly joined_on: { readonly type: "string"; readonly example: "2021-01-01T00:00:00Z"; readonly description: "The date the user joined the organization."; }; readonly last_accessed_on: { readonly type: "string"; readonly example: "2022-01-01T00:00:00Z"; readonly description: "The date the user last accessed the organization."; readonly nullable: true; }; readonly is_suspended: { readonly type: "boolean"; readonly description: "Whether the user is currently suspended or not."; readonly example: false; }; readonly roles: { readonly type: "array"; readonly description: "The roles the user has in the organization."; readonly items: { readonly type: "string"; readonly example: "admin"; readonly description: "The role's key."; }; }; }; }; export declare const $category: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; }; }; export declare const $connection: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly connection: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; readonly display_name: { readonly type: "string"; }; readonly strategy: { readonly type: "string"; }; }; }; }; }; export declare const $environment_variable: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The unique ID for the environment variable."; readonly type: "string"; readonly example: "env_var_0192b1941f125645fa15bf28a662a0b3"; }; readonly key: { readonly type: "string"; readonly description: "The name of the environment variable."; readonly example: "MY_API_KEY"; }; readonly value: { readonly type: "string"; readonly description: "The value of the environment variable."; readonly example: "some-secret"; readonly nullable: true; }; readonly is_secret: { readonly type: "boolean"; readonly description: "Whether the environment variable is sensitive."; readonly example: false; }; readonly created_on: { readonly type: "string"; readonly description: "The date the environment variable was created."; readonly example: "2021-01-01T00:00:00Z"; }; }; }; export declare const $identity: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The unique ID for the identity"; readonly example: "identity_019617f0cd72460a42192cf37b41084f"; }; readonly type: { readonly type: "string"; readonly description: "The type of identity"; readonly example: "email"; }; readonly is_confirmed: { readonly type: "boolean"; readonly description: "Whether the identity is confirmed"; readonly example: true; }; readonly created_on: { readonly type: "string"; readonly description: "Date of user creation in ISO 8601 format"; readonly example: "2025-01-01T00:00:00Z"; }; readonly last_login_on: { readonly type: "string"; readonly description: "Date of last login in ISO 8601 format"; readonly example: "2025-01-05T00:00:00Z"; }; readonly total_logins: { readonly type: "integer"; readonly example: 20; }; readonly name: { readonly type: "string"; readonly description: "The value of the identity"; readonly example: "sally@example.com"; }; readonly email: { readonly type: "string"; readonly description: "The associated email of the identity"; readonly example: "sally@example.com"; }; readonly connection_id: { readonly type: "string"; readonly description: "The social or enterprise connection ID associated with the identity. Null for email, phone, username, and passkey identities."; readonly nullable: true; readonly example: "conn_019289347f1193da6c0e4d49b97b4bd2"; }; readonly is_primary: { readonly type: "boolean"; readonly description: "Whether the identity is the primary identity for the user"; readonly nullable: true; readonly example: true; }; }; }; export declare const $property: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly key: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; readonly is_private: { readonly type: "boolean"; }; readonly description: { readonly type: "string"; }; readonly is_kinde_property: { readonly type: "boolean"; }; }; }; export declare const $property_value: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly example: "prop_0192b7e8b4f8ca08110d2b22059662a8"; }; readonly name: { readonly type: "string"; readonly example: "Town"; }; readonly description: { readonly type: "string"; readonly example: "Where the entity is located"; readonly nullable: true; }; readonly key: { readonly type: "string"; readonly example: "kp_town"; }; readonly value: { readonly type: "string"; readonly example: "West-side Staines massive"; readonly nullable: true; }; }; }; export declare const $role: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly key: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; readonly description: { readonly type: "string"; }; }; }; export declare const $subscribers_subscriber: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly email: { readonly type: "string"; }; readonly full_name: { readonly type: "string"; }; readonly first_name: { readonly type: "string"; }; readonly last_name: { readonly type: "string"; }; }; }; export declare const $subscriber: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly preferred_email: { readonly type: "string"; }; readonly first_name: { readonly type: "string"; }; readonly last_name: { readonly type: "string"; }; }; }; export declare const $organization_user_role: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly key: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; }; }; export declare const $organization_user_role_permissions: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly role: { readonly type: "string"; }; readonly permissions: { readonly type: "object"; readonly properties: { readonly key: { readonly type: "string"; }; }; }; }; }; export declare const $organization_user_permission: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly key: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; readonly description: { readonly type: "string"; }; readonly roles: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly key: { readonly type: "string"; }; }; }; }; }; }; export declare const $organization_users: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/organization_user"; }; }; export declare const $get_subscriber_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly subscribers: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/subscriber"; }; }; }; }; export declare const $get_subscribers_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly subscribers: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/subscribers_subscriber"; }; }; readonly next_token: { readonly description: "Pagination token."; readonly type: "string"; }; }; }; export declare const $get_roles_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly roles: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/roles"; }; }; readonly next_token: { readonly description: "Pagination token."; readonly type: "string"; }; }; }; export declare const $get_role_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly role: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The role's ID."; readonly example: "01929904-316d-bb2c-069f-99dfea4ac394"; }; readonly key: { readonly type: "string"; readonly description: "The role identifier to use in code."; readonly example: "admin"; }; readonly name: { readonly type: "string"; readonly description: "The role's name."; readonly example: "Administrator"; }; readonly description: { readonly type: "string"; readonly description: "The role's description."; readonly example: "Full access to all resources."; }; readonly is_default_role: { readonly type: "boolean"; readonly description: "Whether the role is the default role."; readonly example: false; }; }; }; }; }; export declare const $create_roles_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly role: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The role's ID."; }; }; }; }; }; export declare const $add_role_scope_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "ROLE_SCOPE_ADDED"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Scope added to role"; }; }; }; export declare const $delete_role_scope_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "SCOPE_DELETED"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Scope deleted from role"; }; }; }; export declare const $get_organizations_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly organizations: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/organization_item_schema"; }; }; readonly next_token: { readonly description: "Pagination token."; readonly type: "string"; readonly example: "Mjo5Om1hbWVfYZNj"; }; }; }; export declare const $get_organization_users_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly organization_users: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/organization_user"; }; }; readonly next_token: { readonly type: "string"; readonly description: "Pagination token."; }; }; }; export declare const $get_organizations_user_roles_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly roles: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/organization_user_role"; }; }; readonly next_token: { readonly type: "string"; readonly description: "Pagination token."; }; }; }; export declare const $get_organizations_user_permissions_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly permissions: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/organization_user_permission"; }; }; }; }; export declare const $get_organization_invites_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly invites: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/organization_invite"; }; }; readonly next_token: { readonly type: "string"; readonly description: "Pagination token."; readonly nullable: true; }; }; }; export declare const $get_organization_invite_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly id: { readonly type: "string"; readonly description: "The invitation's unique identifier."; readonly example: "inv_abc123def456"; }; readonly code: { readonly type: "string"; readonly description: "The invitation's code."; readonly example: "inv_abc123def456"; }; readonly email: { readonly type: "string"; readonly description: "The email address of the invited user."; readonly example: "user@example.com"; }; readonly first_name: { readonly type: "string"; readonly description: "The first name of the invited user."; readonly nullable: true; readonly example: "John"; }; readonly last_name: { readonly type: "string"; readonly description: "The last name of the invited user."; readonly nullable: true; readonly example: "Doe"; }; readonly full_name: { readonly type: "string"; readonly description: "The full name of the invited user."; readonly example: "John Doe"; }; readonly created_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the invitation was created."; readonly example: "2024-11-18T13:32:03+11"; }; readonly is_sent: { readonly type: "boolean"; readonly description: "Whether the invitation email was sent."; readonly example: true; }; readonly accepted_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the invitation was accepted."; readonly nullable: true; readonly example: "2024-11-19T10:15:30+11"; }; readonly roles: { readonly type: "array"; readonly description: "The roles assigned to the invitation."; readonly items: { readonly type: "object"; readonly properties: { readonly key: { readonly type: "string"; readonly description: "The role's key."; readonly example: "admin"; }; readonly name: { readonly type: "string"; readonly description: "The role's name."; readonly example: "Administrator"; }; }; }; readonly example: readonly [{ readonly key: "admin"; readonly name: "Administrator"; }, { readonly key: "manager"; readonly name: "Manager"; }]; }; readonly is_revoked: { readonly type: "boolean"; readonly description: "Whether the invitation has been revoked."; readonly example: false; }; readonly invite_link: { readonly type: "string"; readonly description: "URL to share with the invitee to accept the invitation."; readonly example: "https://example.kinde.com/team_invitation?code=inv_abc123def456"; }; }; }; export declare const $create_organization_invite_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "INVITATION_CREATED"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Invitation created"; }; readonly invite: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The invitation's unique identifier."; readonly example: "inv_abc123def456"; }; readonly code: { readonly type: "string"; readonly description: "The invitation's code."; readonly example: "inv_abc123def456"; }; readonly email: { readonly type: "string"; readonly description: "The email address of the invited user."; readonly example: "user@example.com"; }; readonly first_name: { readonly type: "string"; readonly description: "The first name of the invited user."; readonly nullable: true; readonly example: "John"; }; readonly last_name: { readonly type: "string"; readonly description: "The last name of the invited user."; readonly nullable: true; readonly example: "Doe"; }; readonly full_name: { readonly type: "string"; readonly description: "The full name of the invited user."; readonly example: "John Doe"; }; readonly created_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the invitation was created."; readonly example: "2024-11-18T13:32:03+11"; }; readonly is_sent: { readonly type: "boolean"; readonly description: "Whether the invitation email was sent."; readonly example: true; }; readonly accepted_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the invitation was accepted. Always null for a freshly created invitation."; readonly nullable: true; readonly example: null; }; readonly roles: { readonly type: "array"; readonly description: "The roles assigned to the invitation."; readonly items: { readonly type: "object"; readonly properties: { readonly key: { readonly type: "string"; readonly description: "The role's key."; readonly example: "admin"; }; readonly name: { readonly type: "string"; readonly description: "The role's name."; readonly example: "Administrator"; }; }; }; readonly example: readonly [{ readonly key: "admin"; readonly name: "Administrator"; }, { readonly key: "manager"; readonly name: "Manager"; }]; }; readonly is_revoked: { readonly type: "boolean"; readonly description: "Whether the invitation has been revoked. Always false for a freshly created invitation."; readonly example: false; }; readonly invite_link: { readonly type: "string"; readonly description: "URL to share with the invitee to accept the invitation."; readonly example: "https://example.kinde.com/team_invitation?code=inv_abc123def456"; }; }; }; }; }; export declare const $organization_invite: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The invitation's unique identifier."; readonly example: "inv_abc123def456"; }; readonly code: { readonly type: "string"; readonly description: "The invitation's code."; readonly example: "inv_abc123def456"; }; readonly email: { readonly type: "string"; readonly description: "The email address of the invited user."; readonly example: "user@example.com"; }; readonly first_name: { readonly type: "string"; readonly description: "The first name of the invited user."; readonly nullable: true; readonly example: "John"; }; readonly last_name: { readonly type: "string"; readonly description: "The last name of the invited user."; readonly nullable: true; readonly example: "Doe"; }; readonly full_name: { readonly type: "string"; readonly description: "The full name of the invited user."; readonly example: "John Doe"; }; readonly created_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the invitation was created."; readonly example: "2024-11-18T13:32:03+11"; }; readonly is_sent: { readonly type: "boolean"; readonly description: "Whether the invitation email was sent."; readonly example: true; }; readonly accepted_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the invitation was accepted."; readonly nullable: true; readonly example: "2024-11-19T10:15:30+11"; }; readonly roles: { readonly type: "array"; readonly description: "The roles assigned to the invitation."; readonly items: { readonly type: "object"; readonly properties: { readonly key: { readonly type: "string"; readonly description: "The role's key."; readonly example: "admin"; }; readonly name: { readonly type: "string"; readonly description: "The role's name."; readonly example: "Administrator"; }; }; }; readonly example: readonly [{ readonly key: "admin"; readonly name: "Administrator"; }, { readonly key: "manager"; readonly name: "Manager"; }]; }; readonly is_revoked: { readonly type: "boolean"; readonly description: "Whether the invitation has been revoked."; readonly example: false; }; readonly invite_link: { readonly type: "string"; readonly description: "URL to share with the invitee to accept the invitation."; readonly example: "https://example.kinde.com/team_invitation?code=inv_abc123def456"; }; }; }; export declare const $get_organization_feature_flags_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly feature_flags: { readonly type: "object"; readonly description: "The environment's feature flag settings."; readonly additionalProperties: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; readonly enum: readonly ["str", "int", "bool"]; }; readonly value: { readonly type: "string"; }; }; }; }; }; }; export declare const $get_environment_feature_flags_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly feature_flags: { readonly type: "object"; readonly description: "The environment's feature flag settings."; readonly additionalProperties: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; readonly enum: readonly ["str", "int", "bool"]; }; readonly value: { readonly type: "string"; }; }; }; }; readonly next_token: { readonly type: "string"; readonly description: "Pagination token."; }; }; }; export declare const $add_organization_users_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly users_added: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }; }; export declare const $update_role_permissions_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; }; readonly message: { readonly type: "string"; }; readonly permissions_added: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; readonly permissions_removed: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }; }; export declare const $update_organization_users_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly example: "Success"; }; readonly code: { readonly type: "string"; readonly example: "OK"; }; readonly users_added: { readonly type: "array"; readonly items: { readonly type: "string"; readonly example: "kp_057ee6debc624c70947b6ba512908c35"; }; }; readonly users_updated: { readonly type: "array"; readonly items: { readonly type: "string"; readonly example: "kp_057ee6debc624c70947b6ba512908c35"; }; }; readonly users_removed: { readonly type: "array"; readonly items: { readonly type: "string"; readonly example: "kp_057ee6debc624c70947b6ba512908c35"; }; }; }; }; export declare const $connected_apps_auth_url: { readonly type: "object"; readonly properties: { readonly url: { readonly type: "string"; readonly description: "A URL that is used to authenticate an end-user against a connected app."; }; readonly session_id: { readonly type: "string"; readonly description: "A unique identifier for the login session."; }; }; }; export declare const $create_subscriber_success_response: { readonly type: "object"; readonly properties: { readonly subscriber: { readonly type: "object"; readonly properties: { readonly subscriber_id: { readonly type: "string"; readonly description: "A unique identifier for the subscriber."; }; }; }; }; }; export declare const $connected_apps_access_token: { readonly type: "object"; readonly properties: { readonly access_token: { readonly type: "string"; readonly description: "The access token to access a third-party provider."; }; readonly access_token_expiry: { readonly type: "string"; readonly description: "The date and time that the access token expires."; }; }; }; export declare const $api_result: { readonly type: "object"; readonly properties: { readonly result: { readonly type: "string"; readonly description: "The result of the api operation."; }; }; }; export declare const $create_application_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly application: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The application's identifier."; readonly type: "string"; readonly example: "3b0b5c6c8fcc464fab397f4969b5f482"; }; readonly client_id: { readonly description: "The application's client ID."; readonly type: "string"; readonly example: "3b0b5c6c8fcc464fab397f4969b5f482"; }; readonly client_secret: { readonly description: "The application's client secret."; readonly type: "string"; readonly example: "sUJSHI3ZQEVTJkx6hOxdOSHaLsZkCBRFLzTNOI791rX8mDjgt7LC"; }; }; }; }; }; export declare const $get_application_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly application: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The application's identifier."; readonly type: "string"; readonly example: "3b0b5c6c8fcc464fab397f4969b5f482"; }; readonly name: { readonly description: "The application's name."; readonly type: "string"; readonly example: "My React app"; }; readonly type: { readonly description: "The application's type."; readonly type: "string"; readonly enum: readonly ["m2m", "reg", "spa"]; }; readonly client_id: { readonly description: "The application's client ID."; readonly type: "string"; readonly example: "3b0b5c6c8fcc464fab397f4969b5f482"; }; readonly client_secret: { readonly description: "The application's client secret."; readonly type: "string"; readonly example: "sUJSHI3ZQEVTJkx6hOxdOSHaLsZkCBRFLzTNOI791rX8mDjgt7LC"; }; readonly login_uri: { readonly description: "The default login route for resolving session issues."; readonly type: "string"; readonly example: "https://yourapp.com/api/auth/login"; }; readonly homepage_uri: { readonly description: "The homepage link to your application."; readonly type: "string"; readonly example: "https://yourapp.com"; }; readonly has_cancel_button: { readonly description: "Whether the application has a cancel button to allow users to exit the auth flow [Beta]."; readonly type: "boolean"; readonly example: false; }; }; }; }; }; export declare const $applications: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; }; readonly name: { readonly type: "string"; }; readonly type: { readonly type: "string"; }; }; }; export declare const $get_applications_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly applications: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/applications"; }; }; readonly next_token: { readonly description: "Pagination token."; readonly type: "string"; }; }; }; export declare const $redirect_callback_urls: { readonly type: "object"; readonly properties: { readonly redirect_urls: { readonly type: "array"; readonly description: "An application's redirect URLs."; readonly items: { readonly type: "string"; }; }; }; }; export declare const $get_redirect_callback_urls_response: { readonly type: "object"; readonly properties: { readonly redirect_urls: { readonly description: "An application's redirect callback URLs."; readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/redirect_callback_urls"; }; }; }; }; export declare const $logout_redirect_urls: { readonly type: "object"; readonly properties: { readonly logout_urls: { readonly type: "array"; readonly description: "An application's logout URLs."; readonly items: { readonly type: "string"; }; }; readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; }; }; export declare const $get_permissions_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly permissions: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/permissions"; }; }; readonly next_token: { readonly type: "string"; readonly description: "Pagination token."; }; }; }; export declare const $permissions: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The permission's ID."; }; readonly key: { readonly type: "string"; readonly description: "The permission identifier to use in code."; }; readonly name: { readonly type: "string"; readonly description: "The permission's name."; }; readonly description: { readonly type: "string"; readonly description: "The permission's description."; }; }; }; export declare const $scopes: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "Scope ID."; readonly example: "api_scope_019541f3fa0c874fc47b3ae73585b21c"; }; readonly key: { readonly type: "string"; readonly description: "Scope key."; readonly example: "create:users"; }; readonly description: { readonly type: "string"; readonly description: "Description of scope."; readonly example: "Create users"; }; readonly api_id: { readonly type: "string"; readonly description: "API ID."; readonly example: "3635b4431f174de6b789c67481bd0c7a"; }; }; }; export declare const $roles: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The role's ID."; }; readonly key: { readonly type: "string"; readonly description: "The role identifier to use in code."; }; readonly name: { readonly type: "string"; readonly description: "The role's name."; }; readonly description: { readonly type: "string"; readonly description: "The role's description."; readonly nullable: true; }; readonly is_default_role: { readonly type: "boolean"; readonly description: "Whether the role is the default role."; }; }; }; export declare const $role_permissions_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly permissions: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/permissions"; }; }; readonly next_token: { readonly type: "string"; readonly description: "Pagination token."; }; }; }; export declare const $get_role_users_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly users: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The user's ID."; }; readonly org_codes: { readonly type: "array"; readonly description: "The organization codes where the user has this role."; readonly items: { readonly type: "string"; }; }; }; }; }; readonly next_token: { readonly type: "string"; readonly description: "Pagination token."; readonly nullable: true; }; }; }; export declare const $get_organization_role_users_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; }; readonly message: { readonly type: "string"; readonly description: "Response message."; }; readonly users: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The user's ID."; }; }; }; }; readonly next_token: { readonly type: "string"; readonly description: "Pagination token."; readonly nullable: true; }; }; }; export declare const $role_scopes_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly scopes: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/scopes"; }; }; }; }; export declare const $read_logo_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly logos: { readonly type: "array"; readonly description: "A list of logos."; readonly items: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; readonly description: "The type of logo (light or dark)."; readonly example: "light"; }; readonly file_name: { readonly type: "string"; readonly description: "The name of the logo file."; readonly example: "kinde_light.jpeg"; }; readonly path: { readonly type: "string"; readonly description: "The relative path to the logo file."; readonly example: "/logo?p_org_code=org_1767f11ce62"; }; }; }; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; }; }; export declare const $read_env_logo_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly logos: { readonly type: "array"; readonly description: "A list of logos."; readonly items: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; readonly description: "The type of logo (light or dark)."; readonly example: "light"; }; readonly file_name: { readonly type: "string"; readonly description: "The name of the logo file."; readonly example: "kinde_light.jpeg"; }; }; }; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; }; }; export declare const $get_billing_entitlements_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly has_more: { readonly description: "Whether more records exist."; readonly type: "boolean"; }; readonly entitlements: { readonly type: "array"; readonly description: "A list of entitlements"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The friendly id of an entitlement"; readonly example: "entitlement_0195ac80a14e8d71f42b98e75d3c61ad"; }; readonly fixed_charge: { readonly type: "integer"; readonly description: "The price charged if this is an entitlement for a fixed charged"; readonly example: 35; }; readonly price_name: { readonly type: "string"; readonly description: "The name of the price associated with the entitlement"; readonly example: "Pro gym"; }; readonly unit_amount: { readonly type: "integer"; readonly description: "The price charged for this entitlement in cents"; }; readonly feature_code: { readonly type: "string"; readonly description: "The feature code of the feature corresponding to this entitlement"; readonly example: "CcdkvEXpbg6UY"; }; readonly feature_name: { readonly type: "string"; readonly description: "The feature name of the feature corresponding to this entitlement"; readonly example: "Pro Gym"; }; readonly entitlement_limit_max: { readonly type: "integer"; readonly description: "The maximum number of units of the feature the customer is entitled to"; }; readonly entitlement_limit_min: { readonly type: "integer"; readonly description: "The minimum number of units of the feature the customer is entitled to"; }; }; }; }; readonly plans: { readonly type: "array"; readonly description: "A list of plans."; readonly items: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "The plan code the billing customer is subscribed to"; }; readonly subscribed_on: { readonly type: "string"; readonly format: "date-time"; readonly example: "2024-11-18T13:32:03+11"; }; }; }; }; }; }; export declare const $get_billing_agreements_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly has_more: { readonly description: "Whether more records exist."; readonly type: "boolean"; }; readonly agreements: { readonly type: "array"; readonly description: "A list of billing agreements"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The friendly id of an agreement"; readonly example: "agreement_0195ac80a14c2ca2cec97d026d864de0"; }; readonly plan_code: { readonly type: "string"; readonly description: "The plan code the billing customer is subscribed to"; }; readonly expires_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "The date the agreement expired (and was no longer active)"; readonly example: "2024-11-18T13:32:03+11"; }; readonly billing_group_id: { readonly type: "string"; readonly description: "The friendly id of the billing group this agreement's plan is part of"; readonly example: "sbg_0195abf6773fdae18d5da72281a3fde2"; }; readonly entitlements: { readonly type: "array"; readonly description: "A list of billing entitlements that is part of this agreement"; readonly items: { readonly type: "object"; readonly properties: { readonly feature_code: { readonly type: "string"; readonly description: "The feature code of the feature corresponding to this entitlement"; readonly example: "CcdkvEXpbg6UY"; }; readonly entitlement_id: { readonly type: "string"; readonly description: "The friendly id of an entitlement"; readonly example: "entitlement_0195ac80a14e8d71f42b98e75d3c61ad"; }; }; }; }; }; }; }; }; }; export declare const $create_meter_usage_record_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; }; }; export declare const $get_api_keys_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly has_more: { readonly description: "Whether more records exist."; readonly type: "boolean"; }; readonly api_keys: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The unique ID for the API key."; readonly type: "string"; readonly example: "api_key_0195ac80a14e8d71f42b98e75d3c61ad"; }; readonly name: { readonly type: "string"; readonly description: "The API key's name."; readonly example: "My API Key"; }; readonly type: { readonly type: "string"; readonly description: "The type of API key."; readonly example: "organization"; }; readonly status: { readonly type: "string"; readonly description: "The status of the API key."; readonly example: "active"; }; readonly key_prefix: { readonly type: "string"; readonly description: "The first 6 characters of the API key for identification."; readonly example: "kinde_"; }; readonly key_suffix: { readonly type: "string"; readonly description: "The last 4 characters of the API key for identification."; readonly example: "abcd"; readonly nullable: true; }; readonly created_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the API key was created."; readonly example: "2024-11-18T13:32:03+11"; }; readonly last_verified_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the API key was last verified."; readonly example: "2024-11-18T13:32:03+11"; readonly nullable: true; }; readonly last_verified_ip: { readonly type: "string"; readonly description: "The IP address from which the API key was last verified."; readonly example: "192.168.1.1"; readonly nullable: true; }; readonly created_by: { readonly type: "string"; readonly description: "The name of the user who created the API key."; readonly example: "John Doe"; readonly nullable: true; }; readonly api_ids: { readonly type: "array"; readonly description: "Array of API IDs associated with this key."; readonly items: { readonly type: "string"; }; readonly example: readonly ["api_123", "api_456"]; }; readonly scopes: { readonly type: "array"; readonly description: "Array of scopes associated with this key."; readonly items: { readonly type: "string"; }; readonly example: readonly ["read:users", "write:users"]; }; }; }; }; }; }; export declare const $rotate_api_key_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "API_KEY_ROTATED"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "API key rotated successfully"; }; readonly api_key: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The unique ID for the API key."; readonly example: "api_key_0195ac80a14e8d71f42b98e75d3c61ad"; }; readonly key: { readonly type: "string"; readonly description: "The new API key value (only shown once)."; readonly example: "k_live_1234567890abcdef1234567890abcdef"; }; }; }; }; }; export declare const $create_api_key_response: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; readonly description: "A Kinde generated message."; readonly example: "API key created"; }; readonly code: { readonly type: "string"; readonly description: "A Kinde generated status code."; readonly example: "API_KEY_CREATED"; }; readonly api_key: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The unique ID for the API key."; readonly type: "string"; readonly example: "api_key_0195ac80a14e8d71f42b98e75d3c61ad"; }; readonly key: { readonly description: "The API key value (only shown once on creation)."; readonly type: "string"; readonly example: "k_live_1234567890abcdef"; }; }; }; }; }; export declare const $verify_api_key_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "API_KEY_VERIFIED"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "API key verified"; }; readonly is_valid: { readonly type: "boolean"; readonly description: "Whether the API key is valid."; readonly example: true; }; readonly key_id: { readonly type: "string"; readonly description: "The unique ID for the API key."; readonly example: "api_key_0195ac80a14e8d71f42b98e75d3c61ad"; }; readonly status: { readonly type: "string"; readonly description: "The status of the API key."; readonly example: "active"; }; readonly scopes: { readonly type: "array"; readonly description: "Array of scopes associated with this key."; readonly items: { readonly type: "string"; }; readonly example: readonly ["read:users", "write:users"]; }; readonly org_code: { readonly type: "string"; readonly description: "The organization code associated with this key."; readonly example: "org_123"; readonly nullable: true; }; readonly user_id: { readonly type: "string"; readonly description: "The user ID associated with this key."; readonly example: "user_456"; readonly nullable: true; }; readonly last_verified_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the API key was last verified."; readonly example: "2024-11-18T13:32:03+11"; readonly nullable: true; }; readonly verification_count: { readonly type: "integer"; readonly description: "Number of times this API key has been verified."; readonly example: 42; }; }; }; export declare const $get_api_key_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly api_key: { readonly type: "object"; readonly properties: { readonly id: { readonly description: "The unique ID for the API key."; readonly type: "string"; readonly example: "api_key_0195ac80a14e8d71f42b98e75d3c61ad"; }; readonly name: { readonly type: "string"; readonly description: "The API key's name."; readonly example: "My API Key"; }; readonly type: { readonly type: "string"; readonly description: "The type of API key."; readonly example: "organization"; }; readonly status: { readonly type: "string"; readonly description: "The status of the API key."; readonly example: "active"; }; readonly key_prefix: { readonly type: "string"; readonly description: "The first 6 characters of the API key for identification."; readonly example: "k_live"; }; readonly key_suffix: { readonly type: "string"; readonly description: "The last 4 characters of the API key for identification."; readonly example: "abcd"; readonly nullable: true; }; readonly created_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the API key was created."; readonly example: "2024-11-18T13:32:03+11"; }; readonly last_verified_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the API key was last verified."; readonly example: "2024-11-18T13:32:03+11"; readonly nullable: true; }; readonly last_verified_ip: { readonly type: "string"; readonly description: "The IP address from which the API key was last verified."; readonly example: "192.168.1.1"; readonly nullable: true; }; readonly created_by: { readonly type: "string"; readonly description: "The name of the user who created the API key."; readonly example: "John Doe"; readonly nullable: true; }; readonly api_ids: { readonly type: "array"; readonly description: "Array of API IDs associated with this key."; readonly items: { readonly type: "string"; }; readonly example: readonly ["api_123", "api_456"]; }; readonly scopes: { readonly type: "array"; readonly description: "Array of scopes associated with this key."; readonly items: { readonly type: "string"; }; readonly example: readonly ["read:users", "write:users"]; }; readonly verification_count: { readonly type: "integer"; readonly description: "Number of times this API key has been verified."; readonly example: 42; readonly nullable: true; }; readonly organization_id: { readonly type: "string"; readonly description: "The organization code associated with this key."; readonly example: "org_123"; readonly nullable: true; }; readonly user_id: { readonly type: "string"; readonly description: "The user ID associated with this key."; readonly example: "user_456"; readonly nullable: true; }; }; }; }; }; export declare const $get_directories_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly has_more: { readonly description: "Whether more records exist."; readonly type: "boolean"; }; readonly directories: { readonly type: "array"; readonly items: { readonly $ref: "#/components/schemas/directory"; }; }; }; }; export declare const $get_directory_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "OK"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "Success"; }; readonly directory: { readonly $ref: "#/components/schemas/directory"; }; }; }; export declare const $create_directory_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "DIRECTORY_CREATED"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "SCIM directory created successfully"; }; readonly directory: { readonly $ref: "#/components/schemas/directory"; }; }; }; export declare const $update_directory_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "DIRECTORY_UPDATED"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "SCIM directory updated successfully"; }; readonly directory: { readonly $ref: "#/components/schemas/directory"; }; }; }; export declare const $delete_directory_response: { readonly type: "object"; readonly properties: { readonly code: { readonly type: "string"; readonly description: "Response code."; readonly example: "DIRECTORY_DELETED"; }; readonly message: { readonly type: "string"; readonly description: "Response message."; readonly example: "SCIM directory deleted successfully"; }; readonly directory_id: { readonly type: "string"; readonly description: "The ID of the deleted SCIM directory."; readonly example: "directory_0192b1941f125645fa15bf28a662a0b3"; }; }; }; export declare const $directory: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly description: "The unique ID for the SCIM directory."; readonly example: "directory_0192b1941f125645fa15bf28a662a0b3"; }; readonly directory_name: { readonly type: "string"; readonly description: "The name of the SCIM directory."; readonly example: "Production Directory"; }; readonly directory_endpoint_id: { readonly type: "string"; readonly description: "The endpoint ID for the SCIM directory."; readonly example: "ksde_0192b1941f125645fa15bf28a662a0b3"; }; readonly secret_token: { readonly type: "string"; readonly description: "The secret token for SCIM authentication."; readonly example: "kstkn_0192b1941f125645fa15bf28a662a0b3"; }; readonly status: { readonly type: "string"; readonly description: "The current status of the SCIM directory."; readonly enum: readonly ["Pending", "Validating", "Active", "Inactive", "Error"]; readonly example: "Pending"; }; readonly organization_code: { readonly type: "string"; readonly description: "The organization code this directory belongs to."; readonly example: "org_1ccfb819462"; }; readonly enterprise_connection_id: { readonly type: "string"; readonly description: "The enterprise connection ID used for SCIM-provisioned users."; readonly example: "conn_01h9xyzabc123"; readonly nullable: true; }; readonly enterprise_connection_name: { readonly type: "string"; readonly description: "The display name of the selected enterprise connection."; readonly example: "ACME SAML"; readonly nullable: true; }; readonly last_sync_started_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the last sync started."; readonly example: "2024-11-18T13:32:03+11"; readonly nullable: true; }; readonly last_sync_completed_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the last sync completed."; readonly example: "2024-11-18T13:32:03+11"; readonly nullable: true; }; readonly last_sync_error: { readonly type: "string"; readonly description: "The last sync error message."; readonly example: "Connection timeout"; readonly nullable: true; }; readonly created_on: { readonly type: "string"; readonly format: "date-time"; readonly description: "When the directory was created."; readonly example: "2024-11-18T13:32:03+11"; }; }; };