feat(oauth): add GetOpenIDConnectUserInfo

Closes #967.

Author: nlopes

CHANGELOG.md

@@ -35,6 +35,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- **`GetOpenIDConnectUserInfo` / `GetOpenIDConnectUserInfoContext`** — Returns identity
+  information about the user associated with the token via `openid.connect.userInfo`.
+  Complements the existing `GetOpenIDConnectToken` method. ([#967])
 - **HTTP response headers** — Slack API response headers (e.g. `X-OAuth-Scopes`,
   `X-Accepted-OAuth-Scopes`, `X-Ratelimit-*`) are now accessible. `AuthTestResponse`
   exposes a `Header` field directly. For all other methods, use

oauth.go

@@ -177,6 +177,74 @@ func RefreshOAuthV2TokenContext(ctx context.Context, client httpClient, clientID
 	return response, response.Err()
 }
 
+// OpenIDConnectUserInfoResponse contains the response from openid.connect.userInfo.
+//
+// Some of the fields in the response to this method are preceded with https://slack.com/.
+// These fields are Slack-specific, and they're from the perspective of Slack.
+type OpenIDConnectUserInfoResponse struct {
+	Ok bool `json:"ok"`
+
+	Sub string `json:"sub"`
+
+	UserID string `json:"https://slack.com/user_id"`
+	TeamID string `json:"https://slack.com/team_id"`
+
+	Email             string `json:"email"`
+	EmailVerified     bool   `json:"email_verified"`
+	DateEmailVerified int64  `json:"date_email_verified"`
+
+	Name       string `json:"name"`
+	Picture    string `json:"picture"`
+	GivenName  string `json:"given_name"`
+	FamilyName string `json:"family_name"`
+	Locale     string `json:"locale"`
+
+	TeamName     string `json:"https://slack.com/team_name"`
+	TeamDomain   string `json:"https://slack.com/team_domain"`
+	TeamImage34  string `json:"https://slack.com/team_image_34"`
+	TeamImage44  string `json:"https://slack.com/team_image_44"`
+	TeamImage68  string `json:"https://slack.com/team_image_68"`
+	TeamImage88  string `json:"https://slack.com/team_image_88"`
+	TeamImage102 string `json:"https://slack.com/team_image_102"`
+	TeamImage132 string `json:"https://slack.com/team_image_132"`
+	TeamImage230 string `json:"https://slack.com/team_image_230"`
+
+	// `TeamImageDefault` indicates whether the image is a default one (true), or someone
+	// uploaded their own (false).
+	TeamImageDefault bool `json:"https://slack.com/team_image_default"`
+
+	UserImage24       string `json:"https://slack.com/user_image_24"`
+	UserImage32       string `json:"https://slack.com/user_image_32"`
+	UserImage48       string `json:"https://slack.com/user_image_48"`
+	UserImage72       string `json:"https://slack.com/user_image_72"`
+	UserImage192      string `json:"https://slack.com/user_image_192"`
+	UserImage512      string `json:"https://slack.com/user_image_512"`
+	UserImage1024     string `json:"https://slack.com/user_image_1024"`
+	UserImageOriginal string `json:"https://slack.com/user_image_original"`
+
+	SlackResponse
+}
+
+// GetOpenIDConnectUserInfo returns the user info for the token.
+// For more details, see GetOpenIDConnectUserInfoContext documentation.
+func (api *Client) GetOpenIDConnectUserInfo() (*OpenIDConnectUserInfoResponse, error) {
+	return api.GetOpenIDConnectUserInfoContext(context.Background())
+}
+
+// GetOpenIDConnectUserInfoContext returns identity information about the user associated with the token.
+// Slack API docs: https://docs.slack.dev/reference/methods/openid.connect.userInfo
+func (api *Client) GetOpenIDConnectUserInfoContext(ctx context.Context) (*OpenIDConnectUserInfoResponse, error) {
+	values := url.Values{
+		"token": {api.token},
+	}
+	response := &OpenIDConnectUserInfoResponse{}
+	err := api.postMethod(ctx, "openid.connect.userInfo", values, response)
+	if err != nil {
+		return nil, err
+	}
+	return response, response.Err()
+}
+
 // GetOpenIDConnectToken exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.
 // For more details, see GetOpenIDConnectTokenContext documentation.
 func GetOpenIDConnectToken(client httpClient, clientID, clientSecret, code, redirectURI string) (resp *OpenIDConnectResponse, err error) {

oauth_test.go

@@ -0,0 +1,60 @@
+package slack
+
+import (
+	"net/http"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func getOpenIDConnectUserInfo(rw http.ResponseWriter, r *http.Request) {
+	rw.Header().Set("Content-Type", "application/json")
+	rw.Write([]byte(`{
+		"ok": true,
+		"sub": "U0R7JM",
+		"https://slack.com/user_id": "U0R7JM",
+		"https://slack.com/team_id": "T0R7GR",
+		"email": "krane@slack-corp.com",
+		"email_verified": true,
+		"date_email_verified": 1622128723,
+		"name": "krane",
+		"picture": "https://secure.gravatar.com/....png",
+		"given_name": "Bront",
+		"family_name": "Kansen",
+		"locale": "en-US",
+		"https://slack.com/team_name": "Slack Corp",
+		"https://slack.com/team_domain": "slackcorp",
+		"https://slack.com/user_image_24": "...",
+		"https://slack.com/user_image_32": "...",
+		"https://slack.com/user_image_48": "...",
+		"https://slack.com/user_image_72": "...",
+		"https://slack.com/user_image_192": "...",
+		"https://slack.com/user_image_512": "...",
+		"https://slack.com/team_image_default": true
+	}`))
+}
+
+func TestGetOpenIDConnectUserInfo(t *testing.T) {
+	http.HandleFunc("/openid.connect.userInfo", getOpenIDConnectUserInfo)
+
+	once.Do(startServer)
+	api := New("testing-token", OptionAPIURL("http://"+serverAddr+"/"))
+
+	resp, err := api.GetOpenIDConnectUserInfo()
+	require.NoError(t, err)
+
+	assert.Equal(t, "U0R7JM", resp.Sub)
+	assert.Equal(t, "U0R7JM", resp.UserID)
+	assert.Equal(t, "T0R7GR", resp.TeamID)
+	assert.Equal(t, "krane@slack-corp.com", resp.Email)
+	assert.True(t, resp.EmailVerified)
+	assert.Equal(t, int64(1622128723), resp.DateEmailVerified)
+	assert.Equal(t, "krane", resp.Name)
+	assert.Equal(t, "Bront", resp.GivenName)
+	assert.Equal(t, "Kansen", resp.FamilyName)
+	assert.Equal(t, "en-US", resp.Locale)
+	assert.Equal(t, "Slack Corp", resp.TeamName)
+	assert.Equal(t, "slackcorp", resp.TeamDomain)
+	assert.True(t, resp.TeamImageDefault)
+}