library/oauth2/src/OAuth2/OpenID/ResponseType/AuthorizationCodeInterface.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

<?php

namespace OAuth2\OpenID\ResponseType;

use OAuth2\ResponseType\AuthorizationCodeInterface as BaseAuthorizationCodeInterface;

/**
 *
 * @author Brent Shaffer <bshafs at gmail dot com>
 */
interface AuthorizationCodeInterface extends BaseAuthorizationCodeInterface
{
    /**
     * Handle the creation of the authorization code.
     *
     * @param $client_id                Client identifier related to the authorization code
     * @param $user_id                  User ID associated with the authorization code
     * @param $redirect_uri             An absolute URI to which the authorization server will redirect the
     *                                  user-agent to when the end-user authorization step is completed.
     * @param $scope        OPTIONAL    Scopes to be stored in space-separated string.
     * @param $id_token     OPTIONAL    The OpenID Connect id_token.
     *
     * @see http://tools.ietf.org/html/rfc6749#section-4
     * @ingroup oauth2_section_4
     */
    public function createAuthorizationCode($client_id, $user_id, $redirect_uri, $scope = null, $id_token = null);
}