Slack.Web.Openid.Connect (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.

Get the identity of a user who has authorized Sign in with Slack.

Functions

token(optional_params \\ %{})

Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.

API reference

Rate limit: Tier 4: 100+ per minute
Scopes: No scopes required

View on docs.slack.dev ↗

Optional Params

  • client_id - Issued when you created your application. ex: 2141029472.691202649728
  • client_secret - Issued when you created your application. ex: e1b9e11dfcd19c1982d5de12921e17e8c
  • code - The code param returned via the OAuth callback. ex: 4724469134.4644010092847.232b4e6d82c333b475fc30f5f5a341d294feb1a94392c2fd791f7ab7731a443d1a
  • code_verifier - PKCE code verifier (RFC 7636). Required when the authorization request included a code_challenge. ex: dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
  • grant_type - The grant_type param as described in the OAuth spec. Acceptable values: authorization_code refresh_token ex: authorization_code
  • redirect_uri - This must match the originally submitted URI (if one was sent). ex: http://example.com
  • refresh_token - The refresh_token param as described in the OAuth spec. ex: xoxe-1-abcdefg

Errors the API can return:

  • bad_client_secret - The value passed for client_secret was invalid.
  • bad_redirect_uri - The value passed for redirect_uri did not match the redirect_uri in the original request.
  • cannot_install_an_org_installed_app - An org-installed app cannot be installed on a workspace.
  • invalid_client - Client authentication failed (unknown client_id or bad client_secret).
  • invalid_client_id - The value passed for client_id was invalid.
  • invalid_code - The value passed for code was invalid.
  • invalid_grant - The authorization code is invalid, expired, revoked, or the PKCE code_verifier does not match.
  • invalid_grant_type - The value passed for grant_type was invalid.
  • invalid_refresh_token - The given refresh token is invalid.
  • invalid_request - The request is missing a required parameter or includes an invalid parameter value.
  • oauth_authorization_url_mismatch - The OAuth flow was initiated on an incorrect version of the authorization URL. The flow must be initiated via /openid/connect/authorize .
  • preview_feature_not_available - The API method is not yet available on the team.
  • unsupported_grant_type - The grant_type is not supported by this endpoint.

See the Common Errors guide for errors returned by every Web API method.

user_info(optional_params \\ %{})

Get the identity of a user who has authorized Sign in with Slack.

API reference

Rate limit: Tier 3: 50+ per minute
Scopes:

View on docs.slack.dev ↗

See the Common Errors guide for errors returned by every Web API method.