Skip to main content

@slack/web-api / UserConnectionPrimaryProvider

Interface: UserConnectionPrimaryProvider

Defined in: packages/web-api/src/types/request/apps.ts:59

Properties​

accessory?​

optional accessory?: Overflow;

Defined in: packages/web-api/src/types/request/apps.ts:85

Description​

Overflow menu shown when connected (e.g., Disconnect, Re-authenticate).

auth_url?​

optional auth_url?: string;

Defined in: packages/web-api/src/types/request/apps.ts:77

Description​

OAuth redirect URL opened when the user clicks Connect. Must be HTTPs format.

connected_context?​

optional connected_context?: PlainTextElement;

Defined in: packages/web-api/src/types/request/apps.ts:83

Description​

Additional context about the connection (e.g., org or workspace name).

connected_identity?​

optional connected_identity?: PlainTextElement;

Defined in: packages/web-api/src/types/request/apps.ts:81

Description​

Display name of the connected account, shown when is_connected is true.

description?​

optional description?: PlainTextElement;

Defined in: packages/web-api/src/types/request/apps.ts:73

Description​

Brief description of what this connection enables.

disconnect_url?​

optional disconnect_url?: string;

Defined in: packages/web-api/src/types/request/apps.ts:79

Description​

URL opened when the user clicks Disconnect. Must be HTTPs format on a registered auth host.

icon_url?​

optional icon_url?: string;

Defined in: packages/web-api/src/types/request/apps.ts:75

Description​

URL for the provider icon image. Must be HTTPs format. Falls back to the app's avatar when absent.

is_connected​

is_connected: boolean;

Defined in: packages/web-api/src/types/request/apps.ts:71

Description​

Whether this provider is currently connected or disconnected. Slack records this state for the user, so an omitted value would be indistinguishable from an explicit false and silently mark the user disconnected.

name​

name: PlainTextElement;

Defined in: packages/web-api/src/types/request/apps.ts:66

Description​

Human-readable name of the provider.

value​

value: string;

Defined in: packages/web-api/src/types/request/apps.ts:64

Description​

Unique identifier for this provider within the app. Included in interaction payloads and used to derive the connect button action_id (auth_provider_connect_<value>).