vendor/bshaffer/oauth2-server-php/src/OAuth2/ResponseType/AccessTokenInterface.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

<?php

namespace OAuth2\ResponseType;

/**
 * @author Brent Shaffer <bshafs at gmail dot com>
 */
interface AccessTokenInterface extends ResponseTypeInterface
{
    /**
     * Handle the creation of access token, also issue refresh token if supported / desirable.
     *
     * @param mixed  $client_id           - client identifier related to the access token.
     * @param mixed  $user_id             - user ID associated with the access token
     * @param string $scope               - OPTONAL scopes to be stored in space-separated string.
     * @param bool   $includeRefreshToken - if true, a new refresh_token will be added to the response
     *
     * @see http://tools.ietf.org/html/rfc6749#section-5
     * @ingroup oauth2_section_5
     */
    public function createAccessToken($client_id, $user_id, $scope = null, $includeRefreshToken = true);

    /**
     * Handle the revoking of refresh tokens, and access tokens if supported / desirable
     *
     * @param $token
     * @param $tokenTypeHint
     * @return mixed
     *
     * @todo v2.0 include this method in interface. Omitted to maintain BC in v1.x
     */
    //public function revokeToken($token, $tokenTypeHint);
}