Interface CopilotAuthState

Current authentication state.

interface CopilotAuthState {
    accountLabel?: string;
    enterpriseUrl?: string;
    isAuthenticated: boolean;
    migrationRequired?: boolean;
}

Properties

accountLabel?: string

GitHub username if authenticated

enterpriseUrl?: string

GitHub Enterprise URL if using enterprise

isAuthenticated: boolean

Whether the user is authenticated

migrationRequired?: boolean

True when the credentials of a previous version were found and discarded, so that the user can be told why they have to sign in again.