@refoldai/refold-js
    Preparing search index...

    Interface Application

    interface Application {
        app_id: string;
        auth_input_map?: InputField[];
        auth_type: "oauth2" | "keybased";
        auth_type_options?: {
            api_key?: InputField[];
            basic_auth?: InputField[];
            bearer_token?: InputField[];
            keybased?: InputField[];
            noauth?: InputField[];
            oauth2?: InputField[];
        };
        connected?: boolean;
        connected_accounts?: {
            auth_profile_id?: string;
            auth_profile_name?: string;
            auth_type?: AuthType
            | ConnectorAuthType;
            connectedAt: string;
            connection_id?: string;
            identifier: unknown;
            status?: AuthStatus;
            user_defined_fields?: Record<string, unknown>;
        }[];
        description: string;
        grant_type?: GrantType;
        has_multi_auth_enabled?: boolean;
        icon: string;
        kind?: ConnectorKind;
        name: string;
        reauth_required?: boolean;
        slug: string;
        tags?: string[];
        type: string;
    }
    Index
    app_id auth_input_map? auth_type auth_type_options? connected? connected_accounts? description grant_type? has_multi_auth_enabled? icon kind? name reauth_required? slug tags? type
    app_id: string

    Application ID

    auth_input_map?: InputField[]

    The fields required from the user to connect the application (for keybased auth type).

    Check auth_type_options for multiple auth types support.

    auth_type: "oauth2" | "keybased"

    The type of auth used by application.

    Check auth_type_options and connected_accounts for multiple auth types support.

    auth_type_options?: {
        api_key?: InputField[];
        basic_auth?: InputField[];
        bearer_token?: InputField[];
        keybased?: InputField[];
        noauth?: InputField[];
        oauth2?: InputField[];
    }

    The supported auth types for the application, and the fields required from the user to connect the application.

    connected?: boolean

    Whether the user has connected the application.

    Check connected_accounts for multiple auth types support.

    connected_accounts?: {
        auth_profile_id?: string;
        auth_profile_name?: string;
        auth_type?: AuthType | ConnectorAuthType;
        connectedAt: string;
        connection_id?: string;
        identifier: unknown;
        status?: AuthStatus;
        user_defined_fields?: Record<string, unknown>;
    }[]

    The list of connected accounts for this application

    Type Declaration

    • Optionalauth_profile_id?: string

      The credential set this connection was opened against.

    • Optionalauth_profile_name?: string

      The display name of the auth_profile_id above.

    • Optionalauth_type?: AuthType | ConnectorAuthType

      The auth type used to connect the account.

    • connectedAt: string

      The timestamp at which the account was connected.

    • Optionalconnection_id?: string

      Names this connection to the methods that act on one.

    • identifier: unknown

      The identifier (username, email, etc.) of the connected account.

    • Optionalstatus?: AuthStatus

      The current status of the connection.

    • Optionaluser_defined_fields?: Record<string, unknown>

      Caller-supplied metadata stored against this connection.

    description: string

    The application description.

    grant_type?: GrantType

    OAuth grant type. Absent ⇒ GrantType.AuthorizationCode. Pass this to Refold.connect as OAuthParams.grantType; for GrantType.ClientCredentials (machine-to-machine) connect() routes to the OAuth path regardless of type, submits the fields to the server, and opens no browser window.

    has_multi_auth_enabled?: boolean

    Whether the application supports several connections per linked account. Absent, rather than false, for the applications that do not.

    icon: string

    The application icon.

    kind?: ConnectorKind

    Whether this is a native app, a custom app, or a universal connector.

    name: string

    The application name.

    reauth_required?: boolean

    Whether the connection has expired and re-auth is required.

    Check connected_accounts for multiple auth types support.

    slug: string

    The application slug.

    tags?: string[]

    The categories/tags for the application.

    type: string

    Use slug instead. The application slug for native apps and custom for custom apps.

    Settings
    Member Visibility

    On This Page
    Properties