Skip to main content

@slack/types / AuthProviderBlock

Interface: AuthProviderBlock

Defined in: block-kit/blocks.ts:142

Description​

Displays authentication provider information, including its icon, name, and connection state.

See​

Auth provider block reference.

Extends​

Properties​

accessory?​

optional accessory?: Overflow;

Defined in: block-kit/blocks.ts:195

Description​

An Overflow menu shown when connected, e.g. Disconnect or Re-authenticate.

auth_url?​

optional auth_url?: string;

Defined in: block-kit/blocks.ts:176

Description​

OAuth redirect URL opened when the user clicks Connect. Must be an HTTPS URL on a host listed in the app manifest's features.user_connections.auth_hosts. Maximum length for this field is 3000 characters.

block_id?​

optional block_id?: string;

Defined in: block-kit/blocks.ts:50

Description​

A string acting as a unique identifier for a block. If not specified, a block_id will be generated. You can use this block_id when you receive an interaction payload to identify the source of the action. Maximum length for this field is 255 characters. block_id should be unique for each message and each iteration of a message. If a message is updated, use a new block_id.

Inherited from​

Block.block_id

connected_context?​

optional connected_context?: PlainTextElement;

Defined in: block-kit/blocks.ts:191

Description​

Additional context about the connection in the form of a PlainTextElement, e.g. the org or workspace name. Maximum length for the text in this field is 75 characters.

connected_identity?​

optional connected_identity?: PlainTextElement;

Defined in: block-kit/blocks.ts:186

Description​

Display name of the connected account in the form of a PlainTextElement, shown when is_connected is true. Maximum length for the text in this field is 75 characters.

description?​

optional description?: PlainTextElement;

Defined in: block-kit/blocks.ts:166

Description​

Brief description of what this connection enables in the form of a PlainTextElement. Maximum length for the text in this field is 150 characters.

disconnect_url?​

optional disconnect_url?: string;

Defined in: block-kit/blocks.ts:181

Description​

URL opened when the user clicks Disconnect. Must be an HTTPS URL on a host listed in the app manifest's features.user_connections.auth_hosts. Maximum length for this field is 3000 characters.

fallback?​

optional fallback?: KnownBlock[];

Defined in: block-kit/blocks.ts:200

Description​

An array of stable KnownBlock objects rendered by clients that don't recognize auth_provider, spliced into the parent blocks array.

icon_url?​

optional icon_url?: string;

Defined in: block-kit/blocks.ts:171

Description​

URL for the provider icon image. Must be an HTTPS URL. Falls back to the app's avatar when absent. Maximum length for this field is 3000 characters.

is_connected​

is_connected: boolean;

Defined in: block-kit/blocks.ts:161

Description​

Whether this provider is currently connected. Slack records this state for the user.

name​

name: PlainTextElement;

Defined in: block-kit/blocks.ts:157

Description​

Human-readable name of the provider in the form of a PlainTextElement. Maximum length for the text in this field is 75 characters.

type​

type: "auth_provider";

Defined in: block-kit/blocks.ts:146

Description​

The type of block. For an auth provider block, type is always auth_provider.

Overrides​

Block.type

value​

value: string;

Defined in: block-kit/blocks.ts:152

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>). Maximum length for this field is 150 characters.