@cobaltio/cobalt-js
    Preparing search index...

    Interface Application

    An application in Cobalt.

    interface Application {
        app_id: string;
        auth_input_map?: InputField[];
        auth_type: "oauth2" | "keybased";
        auth_type_options?: { keybased: InputField[]; oauth2: InputField[] };
        connected?: boolean;
        connected_accounts?: {
            auth_type: AuthType;
            connectedAt: string;
            identifier: unknown;
            status?: AuthStatus;
        }[];
        description: string;
        icon: string;
        name: string;
        reauth_required?: boolean;
        slug: string;
        tags?: string[];
        type: string;
    }
    Index

    Properties

    app_id auth_input_map? auth_type auth_type_options? connected? connected_accounts? description icon name reauth_required? slug tags? type

    Properties

    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?: { keybased: 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_type: AuthType;
        connectedAt: string;
        identifier: unknown;
        status?: AuthStatus;
    }[]

    The list of connected accounts for this application

    Type declaration

    • auth_type: AuthType

      The auth type used to connect the account.

    • connectedAt: string

      The timestamp at which the account was connected.

    • identifier: unknown

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

    • Optionalstatus?: AuthStatus

      The current status of the connection.

    description: string

    The application description.

    icon: string

    The application icon.

    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