ClientCredentialsInterface

Implement this interface to specify how the OAuth2 Server should verify client credentials

Full name: \OAuth2\Storage\ClientCredentialsInterface
Parent interfaces: \OAuth2\Storage\ClientInterface

Methods

checkClientCredentials

Make sure that the client credentials is valid.

public checkClientCredentials(mixed $client_id, mixed $client_secret = null): true

Parameters:

Parameter	Type	Description
`$client_id`	mixed	Client identifier to be check with.
`$client_secret`	mixed	(optional) If a secret is required, check that they've given the right one.

Return Value:

if the client credentials are valid, and MUST return FALSE if it isn't.

See Also:

http://tools.ietf.org/html/rfc6749#section-3.1 -

isPublicClient

Determine if the client is a "public" client, and therefore does not require passing credentials for certain grant types

public isPublicClient(mixed $client_id): true

Parameters:

Parameter	Type	Description
`$client_id`	mixed	Client identifier to be check with.

Return Value:

if the client is public, and FALSE if it isn't.

See Also:

http://tools.ietf.org/html/rfc6749#section-2.3 - * https://github.com/bshaffer/oauth2-server-php/issues/257 -

Inherited methods

getClientDetails

Get client details corresponding client_id.

public getClientDetails(mixed $client_id): array

OAuth says we should store request URIs for each registered client. Implement this function to grab the stored URI for a given client id.

Parameters:

Parameter	Type	Description
`$client_id`	mixed	Client identifier to be check with.

Return Value:

Client details. The only mandatory key in the array is "redirect_uri". This function MUST return FALSE if the given client does not exist or is invalid. "redirect_uri" can be space-delimited to allow for multiple valid uris. return array( "redirect_uri" => REDIRECT_URI, // REQUIRED redirect_uri registered for the client "client_id" => CLIENT_ID, // OPTIONAL the client id "grant_types" => GRANT_TYPES, // OPTIONAL an array of restricted grant types "user_id" => USER_ID, // OPTIONAL the user identifier associated with this client "scope" => SCOPE, // OPTIONAL the scopes allowed for this client );

getClientScope

Get the scope associated with this client

public getClientScope(mixed $client_id): string

Parameters:

Parameter	Type	Description
`$client_id`	mixed

Return Value:

the space-delineated scope list for the specified client_id

checkRestrictedGrantType

Check restricted grant types of corresponding client identifier.

public checkRestrictedGrantType(mixed $client_id, mixed $grant_type): true

If you want to restrict clients to certain grant types, override this function.

Parameters:

Parameter	Type	Description
`$client_id`	mixed	Client identifier to be check with.
`$grant_type`	mixed	Grant type to be check with

Return Value:

if the grant type is supported by this client identifier, and FALSE if it isn't.

Automatically generated on 2025-03-18