|
| 1 | +[@slack/types](../index.md) / AuthProviderBlock |
| 2 | + |
| 3 | +# Interface: AuthProviderBlock |
| 4 | + |
| 5 | +Defined in: [block-kit/blocks.ts:142](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L142) |
| 6 | + |
| 7 | +## Description |
| 8 | + |
| 9 | +Displays authentication provider information, including its icon, name, and connection state. |
| 10 | + |
| 11 | +## See |
| 12 | + |
| 13 | +[Auth provider block reference](https://docs.slack.dev/reference/block-kit/blocks/auth-provider-block). |
| 14 | + |
| 15 | +## Extends |
| 16 | + |
| 17 | +- [`Block`](Block.md) |
| 18 | + |
| 19 | +## Properties |
| 20 | + |
| 21 | +### accessory? |
| 22 | + |
| 23 | +```ts |
| 24 | +optional accessory?: Overflow; |
| 25 | +``` |
| 26 | + |
| 27 | +Defined in: [block-kit/blocks.ts:195](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L195) |
| 28 | + |
| 29 | +#### Description |
| 30 | + |
| 31 | +An [Overflow](Overflow.md) menu shown when connected, e.g. Disconnect or Re-authenticate. |
| 32 | + |
| 33 | +*** |
| 34 | + |
| 35 | +### auth\_url? |
| 36 | + |
| 37 | +```ts |
| 38 | +optional auth_url?: string; |
| 39 | +``` |
| 40 | + |
| 41 | +Defined in: [block-kit/blocks.ts:176](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L176) |
| 42 | + |
| 43 | +#### Description |
| 44 | + |
| 45 | +OAuth redirect URL opened when the user clicks Connect. Must be an HTTPS URL on a host listed in the |
| 46 | +app manifest's `features.user_connections.auth_hosts`. Maximum length for this field is 3000 characters. |
| 47 | + |
| 48 | +*** |
| 49 | + |
| 50 | +### block\_id? |
| 51 | + |
| 52 | +```ts |
| 53 | +optional block_id?: string; |
| 54 | +``` |
| 55 | + |
| 56 | +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) |
| 57 | + |
| 58 | +#### Description |
| 59 | + |
| 60 | +A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. |
| 61 | +You can use this `block_id` when you receive an interaction payload to |
| 62 | +[identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). |
| 63 | +Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of |
| 64 | +a message. If a message is updated, use a new `block_id`. |
| 65 | + |
| 66 | +#### Inherited from |
| 67 | + |
| 68 | +[`Block`](Block.md).[`block_id`](Block.md#block_id) |
| 69 | + |
| 70 | +*** |
| 71 | + |
| 72 | +### connected\_context? |
| 73 | + |
| 74 | +```ts |
| 75 | +optional connected_context?: PlainTextElement; |
| 76 | +``` |
| 77 | + |
| 78 | +Defined in: [block-kit/blocks.ts:191](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L191) |
| 79 | + |
| 80 | +#### Description |
| 81 | + |
| 82 | +Additional context about the connection in the form of a [PlainTextElement](PlainTextElement.md), e.g. the org or |
| 83 | +workspace name. Maximum length for the text in this field is 75 characters. |
| 84 | + |
| 85 | +*** |
| 86 | + |
| 87 | +### connected\_identity? |
| 88 | + |
| 89 | +```ts |
| 90 | +optional connected_identity?: PlainTextElement; |
| 91 | +``` |
| 92 | + |
| 93 | +Defined in: [block-kit/blocks.ts:186](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L186) |
| 94 | + |
| 95 | +#### Description |
| 96 | + |
| 97 | +Display name of the connected account in the form of a [PlainTextElement](PlainTextElement.md), shown when |
| 98 | +`is_connected` is `true`. Maximum length for the text in this field is 75 characters. |
| 99 | + |
| 100 | +*** |
| 101 | + |
| 102 | +### description? |
| 103 | + |
| 104 | +```ts |
| 105 | +optional description?: PlainTextElement; |
| 106 | +``` |
| 107 | + |
| 108 | +Defined in: [block-kit/blocks.ts:166](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L166) |
| 109 | + |
| 110 | +#### Description |
| 111 | + |
| 112 | +Brief description of what this connection enables in the form of a [PlainTextElement](PlainTextElement.md). |
| 113 | +Maximum length for the text in this field is 150 characters. |
| 114 | + |
| 115 | +*** |
| 116 | + |
| 117 | +### disconnect\_url? |
| 118 | + |
| 119 | +```ts |
| 120 | +optional disconnect_url?: string; |
| 121 | +``` |
| 122 | + |
| 123 | +Defined in: [block-kit/blocks.ts:181](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L181) |
| 124 | + |
| 125 | +#### Description |
| 126 | + |
| 127 | +URL opened when the user clicks Disconnect. Must be an HTTPS URL on a host listed in the app |
| 128 | +manifest's `features.user_connections.auth_hosts`. Maximum length for this field is 3000 characters. |
| 129 | + |
| 130 | +*** |
| 131 | + |
| 132 | +### fallback? |
| 133 | + |
| 134 | +```ts |
| 135 | +optional fallback?: KnownBlock[]; |
| 136 | +``` |
| 137 | + |
| 138 | +Defined in: [block-kit/blocks.ts:200](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L200) |
| 139 | + |
| 140 | +#### Description |
| 141 | + |
| 142 | +An array of stable [KnownBlock](../type-aliases/KnownBlock.md) objects rendered by clients that don't recognize |
| 143 | +`auth_provider`, spliced into the parent blocks array. |
| 144 | + |
| 145 | +*** |
| 146 | + |
| 147 | +### icon\_url? |
| 148 | + |
| 149 | +```ts |
| 150 | +optional icon_url?: string; |
| 151 | +``` |
| 152 | + |
| 153 | +Defined in: [block-kit/blocks.ts:171](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L171) |
| 154 | + |
| 155 | +#### Description |
| 156 | + |
| 157 | +URL for the provider icon image. Must be an HTTPS URL. Falls back to the app's avatar when absent. |
| 158 | +Maximum length for this field is 3000 characters. |
| 159 | + |
| 160 | +*** |
| 161 | + |
| 162 | +### is\_connected |
| 163 | + |
| 164 | +```ts |
| 165 | +is_connected: boolean; |
| 166 | +``` |
| 167 | + |
| 168 | +Defined in: [block-kit/blocks.ts:161](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L161) |
| 169 | + |
| 170 | +#### Description |
| 171 | + |
| 172 | +Whether this provider is currently connected. Slack records this state for the user. |
| 173 | + |
| 174 | +*** |
| 175 | + |
| 176 | +### name |
| 177 | + |
| 178 | +```ts |
| 179 | +name: PlainTextElement; |
| 180 | +``` |
| 181 | + |
| 182 | +Defined in: [block-kit/blocks.ts:157](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L157) |
| 183 | + |
| 184 | +#### Description |
| 185 | + |
| 186 | +Human-readable name of the provider in the form of a [PlainTextElement](PlainTextElement.md). |
| 187 | +Maximum length for the text in this field is 75 characters. |
| 188 | + |
| 189 | +*** |
| 190 | + |
| 191 | +### type |
| 192 | + |
| 193 | +```ts |
| 194 | +type: "auth_provider"; |
| 195 | +``` |
| 196 | + |
| 197 | +Defined in: [block-kit/blocks.ts:146](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L146) |
| 198 | + |
| 199 | +#### Description |
| 200 | + |
| 201 | +The type of block. For an auth provider block, `type` is always `auth_provider`. |
| 202 | + |
| 203 | +#### Overrides |
| 204 | + |
| 205 | +[`Block`](Block.md).[`type`](Block.md#type) |
| 206 | + |
| 207 | +*** |
| 208 | + |
| 209 | +### value |
| 210 | + |
| 211 | +```ts |
| 212 | +value: string; |
| 213 | +``` |
| 214 | + |
| 215 | +Defined in: [block-kit/blocks.ts:152](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L152) |
| 216 | + |
| 217 | +#### Description |
| 218 | + |
| 219 | +Unique identifier for this provider within the app. Included in interaction payloads and used to |
| 220 | +derive the connect button `action_id` (`auth_provider_connect_<value>`). Maximum length for this field is 150 |
| 221 | +characters. |
0 commit comments