auth

Documentation

Overview

Package auth is a lightweight wrapper over the "auth" methods in Slack's Web API: https://api.slack.com/methods?filter=auth.

Index

• type API
  • func (a API) Test(ctx context.Context, args []sdktypes.Value, kwargs map[string]sdktypes.Value) (sdktypes.Value, error)
• type TestResponse
  • func TestWithToken(ctx context.Context, secrets sdkservices.Secrets, scope, oauthToken string) (*TestResponse, error)

Types

type API

type API struct {
	Secrets sdkservices.Secrets
	Scope   string
}

func (API) Test

func (a API) Test(ctx context.Context, args []sdktypes.Value, kwargs map[string]sdktypes.Value) (sdktypes.Value, error)

Test checks the caller's authentication & identity. Based on: https://api.slack.com/methods/auth.test. Required Slack app scopes: none.

type TestResponse

type TestResponse struct {
	api.SlackResponse

	URL                 string `json:"url,omitempty"`
	Team                string `json:"team,omitempty"`
	User                string `json:"user,omitempty"`
	TeamID              string `json:"team_id,omitempty"`
	UserID              string `json:"user_id,omitempty"`
	BotID               string `json:"bot_id,omitempty"`
	EnterpriseID        string `json:"enterprise_id,omitempty"`
	IsEnterpriseInstall bool   `json:"is_enterprise_install,omitempty"`
}

https://api.slack.com/methods/auth.test#examples

func TestWithToken

func TestWithToken(ctx context.Context, secrets sdkservices.Secrets, scope, oauthToken string) (*TestResponse, error)

TestWithToken is only used internally, when the context doesn't store a module and a connection token: when it's used by the OAuth redirect handler.