ElyBy-Mirror/oauth2-server
1
0
Fork 0
mirror of https://github.com/elyby/oauth2-server.git synced 2024-12-22 21:19:46 +05:30
Code Issues Packages Projects Releases Wiki Activity
d9e18e4cbb
oauth2-server/repository-interface-client.md
Dave Marshall f12b879a8b Fixes word in docs
2017-03-15 14:14:48 +00:00

1.0 KiB
Raw Blame History

layout title permalink
default ClientRepositoryInterface documentation /client-repository-interface/

Client Repository Interface

getClientEntity() : ClientEntityInterface

This method is called to validate a client's credentials.

The client secret may or may not be provided depending on the request sent by the client. The boolean $mustValidateSecret parameter will indicate whether or not the client secret must be validated. If the client is confidential (i.e. is capable of securely storing a secret) and $mustValidateSecret === true then the secret must be validated.

You can use the grant type to determine if the client is permitted to use the grant type.

If the client's credentials are validated you should return an instance of \League\OAuth2\Server\Entities\Interfaces\ClientEntityInterface

There are two traits you can use to help you implement some of the ClientEntityInterface methods:

  • \League\OAuth2\Server\Entities\Traits\ClientTrait
  • \League\OAuth2\Server\Entities\Traits\EntityTrait