Skip to content

Commit fe6ceea

Browse files
author
Slack API Ref Buildbot
committed
Updated from Slack docs, 2026/02/17
1 parent 748e77e commit fe6ceea

File tree

4 files changed

+341
-2
lines changed

4 files changed

+341
-2
lines changed

‎docs.slack.dev/methods/assistant.search.context.json‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,17 @@
33
"http_method": "POST",
44
"scope": {
55
"user": [
6-
"search:read"
6+
"search:read.public",
7+
"search:read.private",
8+
"search:read.im",
9+
"search:read.mpim",
10+
"search:read.files",
11+
"search:read.users"
712
],
813
"bot": [
9-
"search:read.public"
14+
"search:read.public",
15+
"search:read.files",
16+
"search:read.users"
1017
]
1118
},
1219
"rate_limits": "t5",

‎docs.slack.dev/methods/methods.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1672,6 +1672,13 @@
16721672
"oauth"
16731673
]
16741674
},
1675+
{
1676+
"name": "oauth.v2.user.access",
1677+
"description": "Exchanges a temporary OAuth verifier code for a user access token.",
1678+
"family": [
1679+
"oauth"
1680+
]
1681+
},
16751682
{
16761683
"name": "openid.connect.token",
16771684
"description": "Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.",

‎docs.slack.dev/methods/oauth.v2.user.access.json‎

Lines changed: 226 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,226 @@
1+
{
2+
"desc": "Exchanges a temporary OAuth verifier code for a user access token.",
3+
"http_method": "POST",
4+
"scope": {},
5+
"rate_limits": "t5",
6+
"args": {
7+
"type": "object",
8+
"discardAdditionalProperties": true,
9+
"properties": {
10+
"client_id": {
11+
"desc": "Issued when you created your application. If possible, avoid sending `client_id` and `client_secret` as parameters in your request and instead supply the Client ID and Client Secret using the HTTP Basic authentication scheme.",
12+
"example": "2141029472.691202649728",
13+
"logged": true,
14+
"type": "string"
15+
},
16+
"client_secret": {
17+
"desc": "Issued when you created your application. If possible, avoid sending `client_id` and `client_secret` as parameters in your request and instead supply the Client ID and Client Secret using the HTTP Basic authentication scheme.",
18+
"example": "e1b9e11dfcd19c1982d5de12921e17e8c",
19+
"type": "string"
20+
},
21+
"code": {
22+
"desc": "The `code` param returned via the OAuth callback.",
23+
"example": "4724469134.4644010092847.232b4e6d82c333b475fc30f5f5a341d294feb1a94392c2fd791f7ab7731a443d1a",
24+
"logged": true,
25+
"type": "string"
26+
},
27+
"code_verifier": {
28+
"desc": "The code_verifier param used to generate the code_challenge originally. Used for PKCE.",
29+
"example": "secret12345",
30+
"logged": false,
31+
"type": "string"
32+
},
33+
"redirect_uri": {
34+
"desc": "This must match the originally submitted URI (if one was sent).",
35+
"example": "http://example.com",
36+
"logged": true,
37+
"type": "string"
38+
},
39+
"grant_type": {
40+
"desc": "The `grant_type` param as described in the OAuth spec.",
41+
"example": "authorization_code",
42+
"logged": true,
43+
"type": "string"
44+
},
45+
"refresh_token": {
46+
"desc": "The `refresh_token` param as described in the OAuth spec.",
47+
"example": "xoxe-1-abcdefg",
48+
"logged": false,
49+
"type": "string"
50+
}
51+
}
52+
},
53+
"output": {
54+
"desc": "User access token and app installation information",
55+
"type": "object",
56+
"required": [
57+
"app_id",
58+
"token_type",
59+
"access_token",
60+
"user_id",
61+
"team",
62+
"enterprise",
63+
"is_enterprise_install"
64+
],
65+
"additionalProperties": false,
66+
"properties": {
67+
"access_token": {
68+
"type": "string",
69+
"desc": "A user access token."
70+
},
71+
"token_type": {
72+
"type": "string",
73+
"desc": "The type of access token.",
74+
"enum": [
75+
"user"
76+
]
77+
},
78+
"scope": {
79+
"type": "string",
80+
"desc": "Comma-separated list of scopes granted to the token."
81+
},
82+
"user_id": {
83+
"type": "string",
84+
"subtype": "user",
85+
"desc": "The user ID of the user corresponding to the token."
86+
},
87+
"app_id": {
88+
"type": "string",
89+
"subtype": "app",
90+
"desc": "ID of the app being installed or re-installed."
91+
},
92+
"is_enterprise_install": {
93+
"type": "boolean",
94+
"desc": "Boolean flag indicating whether the generated token is enterprise level token or not"
95+
},
96+
"expires_in": {
97+
"type": "integer",
98+
"desc": "Time until this credential expires, if it expires at all"
99+
},
100+
"refresh_token": {
101+
"type": "string",
102+
"desc": "Refresh token for this credential"
103+
},
104+
"team": {
105+
"anyOf": [
106+
{
107+
"type": "null"
108+
},
109+
{
110+
"type": "object",
111+
"desc": "Details about the team.",
112+
"additionalProperties": false,
113+
"required": [
114+
"id"
115+
],
116+
"properties": {
117+
"id": {
118+
"type": "string",
119+
"subtype": "team",
120+
"desc": "ID of the team into which the app is being installed or re-installed."
121+
},
122+
"name": {
123+
"desc": "Name of the team into which the app is being installed or re-installed.",
124+
"type": "string"
125+
}
126+
}
127+
}
128+
]
129+
},
130+
"enterprise": {
131+
"anyOf": [
132+
{
133+
"type": "null"
134+
},
135+
{
136+
"type": "object",
137+
"desc": "Details about the enterprise.",
138+
"additionalProperties": false,
139+
"required": [
140+
"id"
141+
],
142+
"properties": {
143+
"id": {
144+
"type": "string",
145+
"subtype": "team",
146+
"desc": "ID of the enterprise into which the app is being installed or re-installed."
147+
},
148+
"name": {
149+
"desc": "Name of the enterprise into which the app is being installed or re-installed.",
150+
"type": "string"
151+
}
152+
}
153+
}
154+
]
155+
}
156+
}
157+
},
158+
"errors": {
159+
"bad_client_secret": {
160+
"desc": "Value passed for `client_secret` was invalid."
161+
},
162+
"bad_redirect_uri": {
163+
"desc": "Value passed for `redirect_uri` did not match the `redirect_uri` in the original request."
164+
},
165+
"cannot_install_an_org_installed_app": {
166+
"desc": "Returned when the the org-installed app cannot be installed on a workspace."
167+
},
168+
"invalid_client_id": {
169+
"desc": "Value passed for `client_id` was invalid."
170+
},
171+
"invalid_code": {
172+
"desc": "Value passed for `code` was invalid."
173+
},
174+
"invalid_grant_type": {
175+
"desc": "Value passed for `grant_type` was invalid."
176+
},
177+
"invalid_refresh_token": {
178+
"desc": "The given refresh token is invalid."
179+
},
180+
"no_scopes": {
181+
"desc": "Missing `scope` in the request."
182+
},
183+
"no_user_scopes": {
184+
"desc": "Missing user `scope` in the auth request."
185+
},
186+
"not_implemented": {
187+
"desc": "Method not yet supported"
188+
},
189+
"oauth_authorization_url_mismatch": {
190+
"desc": "The OAuth flow was initiated on an incorrect version of the authorization url. The flow must be initiated via /oauth/v2/authorize ."
191+
},
192+
"preview_feature_not_available": {
193+
"desc": "Returned when the API method is not yet available on the team in context."
194+
},
195+
"user_email_unverified": {
196+
"desc": "The users email is unverified"
197+
}
198+
},
199+
"examples": {
200+
"success": {
201+
"url": "/api/oauth.v2.user.access",
202+
"description": "Successful token request with scopes for a user token.",
203+
"example": {
204+
"ok": true,
205+
"access_token": "xoxp-123456789...",
206+
"token_type": "user",
207+
"id_token": "eyJhbGciOiJSUzI1Ni...",
208+
"authed_user": {
209+
"id": "U12345",
210+
"scope": "openid,email,profile"
211+
},
212+
"team": {
213+
"id": "T012345"
214+
}
215+
}
216+
},
217+
"error": {
218+
"url": "/api/oauth.v2.user.access",
219+
"description": "Typical error response.",
220+
"example": {
221+
"ok": false,
222+
"error": "invalid_code"
223+
}
224+
}
225+
}
226+
}

‎methods/oauth/oauth.v2.user.access.json‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
{
2+
"group": "oauth",
3+
"name": "oauth.v2.user.access",
4+
"deprecated": false,
5+
"desc": "Exchanges a temporary OAuth verifier code for a user access token.",
6+
"args": {
7+
"client_id": {
8+
"required": null,
9+
"example": "2141029472.691202649728",
10+
"desc": "Issued when you created your application. If possible, avoid sending client_id and client_secret as parameters in your request and instead supply the Client ID and Client Secret using the HTTP Basic authentication scheme.",
11+
"type": "string"
12+
},
13+
"client_secret": {
14+
"required": null,
15+
"example": "e1b9e11dfcd19c1982d5de12921e17e8c",
16+
"desc": "Issued when you created your application. If possible, avoid sending client_id and client_secret as parameters in your request and instead supply the Client ID and Client Secret using the HTTP Basic authentication scheme.",
17+
"type": "string"
18+
},
19+
"code": {
20+
"required": null,
21+
"example": "4724469134.4644010092847.232b4e6d82c333b475fc30f5f5a341d294feb1a94392c2fd791f7ab7731a443d1a",
22+
"desc": "The code param returned via the OAuth callback.",
23+
"type": "string"
24+
},
25+
"code_verifier": {
26+
"required": null,
27+
"example": "secret12345",
28+
"desc": "The code_verifier param used to generate the code_challenge originally. Used for PKCE.",
29+
"type": "string"
30+
},
31+
"redirect_uri": {
32+
"required": null,
33+
"example": "http://example.com",
34+
"desc": "This must match the originally submitted URI (if one was sent).",
35+
"type": "string"
36+
},
37+
"grant_type": {
38+
"required": null,
39+
"example": "authorization_code",
40+
"desc": "The grant_type param as described in the OAuth spec.",
41+
"type": "string"
42+
},
43+
"refresh_token": {
44+
"required": null,
45+
"example": "xoxe-1-abcdefg",
46+
"desc": "The refresh_token param as described in the OAuth spec.",
47+
"type": "string"
48+
}
49+
},
50+
"response": {
51+
"examples": [
52+
"{\n \"ok\": true,\n \"access_token\": \"xoxp-123456789...\",\n \"token_type\": \"user\",\n \"id_token\": \"eyJhbGciOiJSUzI1Ni...\",\n \"authed_user\": {\n \"id\": \"U12345\",\n \"scope\": \"openid,email,profile\"\n },\n \"team\": {\n \"id\": \"T012345\"\n }\n}",
53+
"{\n \"ok\": false,\n \"error\": \"invalid_code\"\n}"
54+
]
55+
},
56+
"errors": {
57+
"access_denied": "Access to a resource specified in the request is denied.",
58+
"accesslimited": "Access to this method is limited on the current network.",
59+
"account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.",
60+
"bad_client_secret": "Value passed for `client_secret` was invalid.",
61+
"bad_redirect_uri": "Value passed for `redirect_uri` did not match the `redirect_uri` in the original request.",
62+
"cannot_install_an_org_installed_app": "Returned when the the org-installed app cannot be installed on a workspace.",
63+
"deprecated_endpoint": "The endpoint has been deprecated.",
64+
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
65+
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
66+
"fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.",
67+
"invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.",
68+
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
69+
"invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.",
70+
"invalid_client_id": "Value passed for `client_id` was invalid.",
71+
"invalid_code": "Value passed for `code` was invalid.",
72+
"invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.",
73+
"invalid_grant_type": "Value passed for `grant_type` was invalid.",
74+
"invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.",
75+
"invalid_refresh_token": "The given refresh token is invalid.",
76+
"is_bot": "This method cannot be called by a legacy bot.",
77+
"method_deprecated": "The method has been deprecated.",
78+
"missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.",
79+
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
80+
"no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.",
81+
"no_scopes": "Missing `scope` in the request.",
82+
"no_user_scopes": "Missing user `scope` in the auth request.",
83+
"not_allowed_token_type": "The token type used in this request is not allowed.",
84+
"not_authed": "No authentication token provided.",
85+
"not_implemented": "Method not yet supported",
86+
"oauth_authorization_url_mismatch": "The OAuth flow was initiated on an incorrect version of the authorization url. The flow must be initiated via /oauth/v2/authorize .",
87+
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
88+
"preview_feature_not_available": "Returned when the API method is not yet available on the team in context.",
89+
"ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.",
90+
"request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.",
91+
"service_unavailable": "The service is temporarily unavailable.",
92+
"team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.",
93+
"token_expired": "Authentication token has expired.",
94+
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.",
95+
"two_factor_setup_required": "Two factor setup is required.",
96+
"unknown_method": "This method is currently not available.",
97+
"user_email_unverified": "The users email is unverified"
98+
}
99+
}

0 commit comments

Comments
 (0)