Documentation

Slack extends OAuth2Provider

in package

• Application

implements CSRFToken

Slack v2 OAuth2

Tags

see

https://api.slack.com/authentication/oauth-v2

see

https://api.slack.com/authentication/sign-in-with-slack

see

https://api.slack.com/authentication/token-types

Table of Contents

Interfaces

CSRFToken

Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")

Constants

DEFAULT_SCOPES  = [self::SCOPE_IDENTITY_AVATAR, self::SCOPE_IDENTITY_BASIC, self::SCOPE_IDENTITY_EMAIL, self::SCOPE_IDENTITY_TEAM]

SCOPE_ADMIN  = 'admin'

SCOPE_BOT  = 'bot'

SCOPE_CHANNELS_HISTORY  = 'channels:history'

SCOPE_CHANNELS_READ  = 'channels:read'

SCOPE_CHANNELS_WRITE  = 'channels:write'

SCOPE_CHAT_WRITE_BOT  = 'chat:write:bot'

SCOPE_CHAT_WRITE_USER  = 'chat:write:user'

SCOPE_CLIENT  = 'client'

SCOPE_COMMANDS  = 'commands'

SCOPE_DND_READ  = 'dnd:read'

SCOPE_DND_WRITE  = 'dnd:write'

SCOPE_EMOJI_READ  = 'emoji:read'

SCOPE_FILES_READ  = 'files:read'

SCOPE_FILES_WRITE_USER  = 'files:write:user'

SCOPE_GROUPS_HISTORY  = 'groups:history'

SCOPE_GROUPS_READ  = 'groups:read'

SCOPE_GROUPS_WRITE  = 'groups:write'

SCOPE_IDENTIFY  = 'identify'

SCOPE_IDENTITY_AVATAR  = 'identity.avatar'

SCOPE_IDENTITY_BASIC  = 'identity.basic'

SCOPE_IDENTITY_EMAIL  = 'identity.email'

SCOPE_IDENTITY_TEAM  = 'identity.team'

SCOPE_IM_HISTORY  = 'im:history'

SCOPE_IM_READ  = 'im:read'

SCOPE_IM_WRITE  = 'im:write'

SCOPE_INCOMING_WEBHOOK  = 'incoming-webhook'

SCOPE_LINKS_READ  = 'links:read'

SCOPE_LINKS_WRITE  = 'links:write'

SCOPE_MPIM_HISTORY  = 'mpim:history'

SCOPE_MPIM_READ  = 'mpim:read'

SCOPE_MPIM_WRITE  = 'mpim:write'

SCOPE_PINS_READ  = 'pins:read'

SCOPE_PINS_WRITE  = 'pins:write'

SCOPE_POST  = 'post'

SCOPE_REACTIONS_READ  = 'reactions:read'

SCOPE_REACTIONS_WRITE  = 'reactions:write'

SCOPE_READ  = 'read'

SCOPE_REMINDERS_READ  = 'reminders:read'

SCOPE_REMINDERS_WRITE  = 'reminders:write'

SCOPE_SEARCH_READ  = 'search:read'

SCOPE_STARS_READ  = 'stars:read'

SCOPE_STARS_WRITE  = 'stars:write'

SCOPE_TEAM_READ  = 'team:read'

SCOPE_USERGROUPS_READ  = 'usergroups:read'

SCOPE_USERGROUPS_WRITE  = 'usergroups:write'

SCOPE_USERS_PROFILE_READ  = 'users.profile:read'

SCOPE_USERS_PROFILE_WRITE  = 'users.profile:write'

SCOPE_USERS_READ  = 'users:read'

SCOPE_USERS_READ_EMAIL  = 'users:read.email'

SCOPE_USERS_WRITE  = 'users:write'

MAGIC_PROPERTIES  = ['apiDocs', 'apiURL', 'applicationURL', 'serviceName', 'userRevokeURL']

Properties

$accessTokenURL  : string

$apiDocs  : string|null

$apiURL  : string

$applicationURL  : string|null

$authURL  : string

$clientCredentialsTokenURL  : string|null

An optional client credentials token endpoint in case the provider supports ClientCredentials.

$http  : ClientInterface

$logger  : LoggerInterface

$options  : OAuthOptions|SettingsContainerInterface

$refreshTokenURL  : string

An optional refresh token endpoint in case the provider supports TokenRefresh.

$requestFactory  : RequestFactoryInterface

$revokeURL  : string

an optional URL for application side token revocation

$serviceName  : string

the name of the provider/class (magic)

$storage  : OAuthStorageInterface

$streamFactory  : StreamFactoryInterface

$uriFactory  : UriFactoryInterface

$userRevokeURL  : string|null

Methods

__construct()  : mixed

OAuthProvider constructor.

__get()  : string|null

Magic getter for the properties specified in self::ALLOWED_PROPERTIES

getAccessToken()  : AccessToken

Obtains an OAuth2 access token with the given $code, verifies the $state if the provider implements the CSRFToken interface, and returns an AccessToken object

getAccessTokenFromStorage()  : AccessToken

Gets an access token from the current OAuthStorageInterface (shorthand/convenience)

getAuthURL()  : UriInterface

getClientCredentialsToken()  : AccessToken

getRequestAuthorization()  : RequestInterface

getStorage()  : OAuthStorageInterface

Returns the current OAuthStorageInterface

InvalidateAccessToken()  : bool

me()  : ResponseInterface

refreshAccessToken()  : AccessToken

request()  : ResponseInterface

Prepares an API request to $path with the given parameters, gets authorization, fires the request and returns a PSR-7 ResponseInterface with the corresponding API response

sendRequest()  : ResponseInterface

setLogger()  : static

Sets an optional PSR-3 LoggerInterface

setRequestFactory()  : static

Sets an optional PSR-17 RequestFactoryInterface

setStorage()  : static

Sets an optional OAuthStorageInterface

setStreamFactory()  : static

Sets an optional PSR-17 StreamFactoryInterface

setUriFactory()  : static

Sets an optional PSR-17 UriFactoryInterface

storeAccessToken()  : static

Sets an access token in the current OAuthStorageInterface (shorthand/convenience)

cleanBodyParams()  : array<string|int, mixed>

Cleans an array of body parameters

cleanQueryParams()  : array<string|int, mixed>

Cleans an array of query parameters

construct()  : void

A replacement constructor that you can call in extended classes, so that you don't have to implement the monstrous original `__construct()`

createAccessToken()  : AccessToken

Creates an access token with the provider set to $this->serviceName

getAccessTokenRequestBodyParams()  : array<string|int, mixed>

prepares the request body parameters for the access token request

getAuthURLRequestParams()  : array<string|int, mixed>

prepares the query parameters for the auth URL

getClientCredentialsTokenRequestBodyParams()  : array<string|int, mixed>

prepares the request body parameters for the client credentials token request

getRefreshAccessTokenRequestBodyParams()  : array<string|int, mixed>

prepares the request body parameters for the token refresh

getRequestBody()  : StreamInterface

Prepares the request body

getRequestHeaders()  : array<string|int, mixed>

Prepare request headers

getRequestTarget()  : string

Determine the request target from the given URI (path segment or URL) with respect to $apiURL, anything except host and path will be ignored, scheme will always be set to "https".

getRequestURL()  : string

Prepares the request URL

getTokenResponseData()  : array<string|int, mixed>

extracts the data from the access token response and returns an array with the key->value pairs contained

nonce()  : string

returns a 32 byte random string (in hexadecimal representation) for use as a nonce

parseTokenResponse()  : AccessToken

Parses the response from a request to the token endpoint

sendAccessTokenRequest()  : ResponseInterface

sends a request to the access/refresh token endpoint $url with the given $body as form data

sendClientCredentialsTokenRequest()  : ResponseInterface

sends a request to the client credentials endpoint, using basic authentication