phpBB API Documentation
Interface

phpbb\auth\provider\oauth\service\service_interface

interface service_interface

OAuth service interface

Methods

get_auth_scope()

Returns an array of the scopes necessary for auth

get_external_service_provider()

Returns the external library service provider once it has been set

get_service_credentials()

Returns an array containing the service credentials belonging to requested service.

perform_auth_login()

Returns the results of the authentication in json format

perform_token_auth()

Returns the results of the authentication in json format Use this function when the user already has an access token

set_external_service_provider(ServiceInterface $service_provider)

Sets the external library service provider

Details

at line 26
public get_auth_scope()

Returns an array of the scopes necessary for auth

at line 33
public get_external_service_provider()

Returns the external library service provider once it has been set

at line 46
public get_service_credentials()

Returns an array containing the service credentials belonging to requested service.

at line 55
public perform_auth_login()

Returns the results of the authentication in json format

at line 65
public perform_token_auth()

Returns the results of the authentication in json format Use this function when the user already has an access token

at line 72
public set_external_service_provider(ServiceInterface $service_provider)

Sets the external library service provider

Parameters

ServiceInterface $service_provider