AuthleteApiImpl implements AuthleteApi
An implementation of the \Authlete\Api\AuthleteApi interface.
Interfaces, Classes and Traits
- AuthleteApi
- Authlete API.
Table of Contents
- __construct() : mixed
- Constructor.
- authorization() : AuthorizationResponse
- Call Authlete's /api/auth/authorization API.
- authorizationFail() : AuthorizationFailResponse
- Call Authlete's /api/auth/authorization/fail API.
- authorizationIssue() : AuthorizationIssueResponse
- Call Authlete's /api/auth/authorization/issue API.
- backchannelAuthentication() : BackchannelAuthenticationResponse
- Call Authlete's /api/backchannel/authentication API.
- backchannelAuthenticationComplete() : BackchannelAuthenticationCompleteResponse
- Call Authlete's /api/backchannel/authentication/complete API.
- backchannelAuthenticationFail() : BackchannelAuthenticationFailResponse
- Call Authlete's /api/backchannel/authentication/fail API.
- backchannelAuthenticationIssue() : BackchannelAuthenticationIssueResponse
- Call Authlete's /api/backchannel/authentication/issue API.
- createClient() : Client
- Create a client (= call Authlete's /api/client/create API).
- createService() : Service
- Create a service (= call Authlete's /api/service/create API).
- deleteClient() : mixed
- Delete a client (= call Authlete's /api/client/delete/{clientId} API).
- deleteClientAuthorization() : mixed
- Delete all existing access tokens issued to the client application by the end-user (= call Authlete's /api/client/authorization/delete/{clientId} API).
- deleteGrantedScopes() : mixed
- Delete DB records about the set of scopes that an end-user has granted to a client application (= call Authlete's /api/client/granted_scopes/delete/{clientId} API).
- deleteService() : mixed
- Delete a service (= call Authlete's /api/service/delete/{apiKey} API).
- deviceAuthorization() : DeviceAuthorizationResponse
- Call Authlete's /api/device/authorization API.
- deviceComplete() : DeviceCompleteResponse
- Call Authlete's /api/device/complete API.
- deviceVerification() : DeviceVerificationResponse
- Call Authlete's /api/device/verification API.
- getClient() : Client
- Get information about a client (= call Authlete's /api/client/get/{clientId} API).
- getClientAuthorizationList() : AuthorizedClientListResponse
- Get the list of client applications authorized by the end-user (= call Authlete's /api/client/authorization/get/list API).
- getClientList() : mixed
- Get a list of clients (= call Authlete's /api/client/get/list API).
- getGrantedScopes() : GrantedScopesGetResponse
- Get the set of scopes that an end-user has granted to a client application (= call Authlete's /api/client/granted_scopes/get/{clientId} API).
- getService() : Service
- Get information about a service (= call Authlete's /api/service/get/{apiKey} API).
- getServiceConfiguration() : string
- Get the configuration of the service in JSON format that complies with OpenID Connect Discovery 1.0 (= call Authlete's /api/service/configuration API).
- getServiceJwks() : string
- Get the JWK Set of a service (= call Authlete's /api/service/jwks/get API).
- getServiceList() : ServiceListResponse
- Get a list of services that belong to the service owner (= call Authlete's /api/service/get/list API).
- getSettings() : Settings
- The settings of this AuthleteApi implementation.
- introspection() : IntrospectionResponse
- Call Authlete's /api/auth/introspection API.
- pushAuthorizationRequest() : PushedAuthReqResponse
- Call Authlete's /api/pushed_auth_req API.
- refreshClientSecret() : ClientSecretRefreshResponse
- Refresh the client secret of a client (= call Authlete's /api/client/secret/refresh/{clientId} API).
- revocation() : RevocationResponse
- Call Authlete's /api/auth/revocation API.
- standardIntrospection() : StandardIntrospectionResponse
- Call Authlete's /api/auth/introspection/standard API.
- token() : TokenResponse
- Call Authlete's /api/auth/token API.
- tokenCreate() : TokenCreateResponse
- Call Authlete's /api/auth/token/create API.
- tokenDelete() : mixed
- Delete an access token (= call Authlete's /api/auth/token/delete/{token} API).
- tokenFail() : TokenFailResponse
- Call Authlete's /api/auth/token/fail API.
- tokenIssue() : TokenIssueResponse
- Call Authlete's /api/auth/token/issue API.
- tokenUpdate() : TokenUpdateResponse
- Call Authlete's /api/auth/token/update API.
- updateClient() : Client
- Update a client (= call Authlete's /api/client/update/{clientId} API).
- updateClientAuthorization() : ApiResponse
- Update attributes of all existing access tokens issued to the client application by the end-user (= call Authlete's /api/client/authorization/update/{clientId} API).
- updateClientSecret() : ClientSecretUpdateResponse
- Update the client secret of a client (= call Authlete's /api/client/secret/update/{clientId} API).
- updateService() : Service
- Update a service (= call Authlete's /api/service/update/{apiKey} API).
- userInfo() : UserInfoResponse
- Call Authlete's /api/auth/userinfo API.
- userInfoIssue() : UserInfoIssueResponse
- Call Authlete's /api/auth/userinfo/issue API.
Methods
__construct()
Constructor.
public
__construct(AuthleteConfiguration $configuration) : mixed
Parameters
- $configuration : AuthleteConfiguration
-
An object that implements the
AuthleteConfigurationinterface.
Return values
mixed —authorization()
Call Authlete's /api/auth/authorization API.
public
authorization(AuthorizationRequest $request) : AuthorizationResponse
Parameters
- $request : AuthorizationRequest
Return values
AuthorizationResponse —Response from the API.
authorizationFail()
Call Authlete's /api/auth/authorization/fail API.
public
authorizationFail(AuthorizationFailRequest $request) : AuthorizationFailResponse
Parameters
- $request : AuthorizationFailRequest
Return values
AuthorizationFailResponse —Response from the API.
authorizationIssue()
Call Authlete's /api/auth/authorization/issue API.
public
authorizationIssue(AuthorizationIssueRequest $request) : AuthorizationIssueResponse
Parameters
- $request : AuthorizationIssueRequest
Return values
AuthorizationIssueResponse —Response from the API.
backchannelAuthentication()
Call Authlete's /api/backchannel/authentication API.
public
backchannelAuthentication(BackchannelAuthenticationRequest $request) : BackchannelAuthenticationResponse
Parameters
- $request : BackchannelAuthenticationRequest
Return values
BackchannelAuthenticationResponse —Response from the API.
backchannelAuthenticationComplete()
Call Authlete's /api/backchannel/authentication/complete API.
public
backchannelAuthenticationComplete(BackchannelAuthenticationCompleteRequest $request) : BackchannelAuthenticationCompleteResponse
Parameters
- $request : BackchannelAuthenticationCompleteRequest
Return values
BackchannelAuthenticationCompleteResponse —Response from the API.
backchannelAuthenticationFail()
Call Authlete's /api/backchannel/authentication/fail API.
public
backchannelAuthenticationFail(BackchannelAuthenticationFailRequest $request) : BackchannelAuthenticationFailResponse
Parameters
- $request : BackchannelAuthenticationFailRequest
Return values
BackchannelAuthenticationFailResponse —Response from the API.
backchannelAuthenticationIssue()
Call Authlete's /api/backchannel/authentication/issue API.
public
backchannelAuthenticationIssue(BackchannelAuthenticationIssueRequest $request) : BackchannelAuthenticationIssueResponse
Parameters
- $request : BackchannelAuthenticationIssueRequest
Return values
BackchannelAuthenticationIssueResponse —Response from the API.
createClient()
Create a client (= call Authlete's /api/client/create API).
public
createClient(Client $client) : Client
Parameters
- $client : Client
Return values
Client —Information about the client that was newly created.
createService()
Create a service (= call Authlete's /api/service/create API).
public
createService(Service $service) : Service
Parameters
- $service : Service
Return values
Service —Information about the service that was newly created.
deleteClient()
Delete a client (= call Authlete's /api/client/delete/{clientId} API).
public
deleteClient(int|string $clientId) : mixed
Parameters
- $clientId : int|string
Return values
mixed —deleteClientAuthorization()
Delete all existing access tokens issued to the client application by the end-user (= call Authlete's /api/client/authorization/delete/{clientId} API).
public
deleteClientAuthorization(int|string $clientId, string $subject) : mixed
Parameters
- $clientId : int|string
- $subject : string
Return values
mixed —deleteGrantedScopes()
Delete DB records about the set of scopes that an end-user has granted to a client application (= call Authlete's /api/client/granted_scopes/delete/{clientId} API).
public
deleteGrantedScopes(int|string $clientId, string $subject) : mixed
Parameters
- $clientId : int|string
- $subject : string
Return values
mixed —deleteService()
Delete a service (= call Authlete's /api/service/delete/{apiKey} API).
public
deleteService(int|string $apiKey) : mixed
Parameters
- $apiKey : int|string
Return values
mixed —deviceAuthorization()
Call Authlete's /api/device/authorization API.
public
deviceAuthorization(DeviceAuthorizationRequest $request) : DeviceAuthorizationResponse
Parameters
- $request : DeviceAuthorizationRequest
Return values
DeviceAuthorizationResponse —Response from the API.
deviceComplete()
Call Authlete's /api/device/complete API.
public
deviceComplete(DeviceCompleteRequest $request) : DeviceCompleteResponse
Parameters
- $request : DeviceCompleteRequest
Return values
DeviceCompleteResponse —Response from the API.
deviceVerification()
Call Authlete's /api/device/verification API.
public
deviceVerification(DeviceVerificationRequest $request) : DeviceVerificationResponse
Parameters
- $request : DeviceVerificationRequest
Return values
DeviceVerificationResponse —Response from the API.
getClient()
Get information about a client (= call Authlete's /api/client/get/{clientId} API).
public
getClient(int|string $clientId) : Client
Parameters
- $clientId : int|string
Return values
Client —Information about the client.
getClientAuthorizationList()
Get the list of client applications authorized by the end-user (= call Authlete's /api/client/authorization/get/list API).
public
getClientAuthorizationList(ClientAuthorizationGetListRequest $request) : AuthorizedClientListResponse
Parameters
- $request : ClientAuthorizationGetListRequest
Return values
AuthorizedClientListResponse —The list of client applications.
getClientList()
Get a list of clients (= call Authlete's /api/client/get/list API).
public
getClientList([string $developer = null ], int $start[, int $end = 5 ]) : mixed
Parameters
- $developer : string = null
- $start : int
- $end : int = 5
Return values
mixed —getGrantedScopes()
Get the set of scopes that an end-user has granted to a client application (= call Authlete's /api/client/granted_scopes/get/{clientId} API).
public
getGrantedScopes(int|string $clientId, string $subject) : GrantedScopesGetResponse
Parameters
- $clientId : int|string
- $subject : string
Return values
GrantedScopesGetResponse —Scopes granted to the client application by the end-user.
getService()
Get information about a service (= call Authlete's /api/service/get/{apiKey} API).
public
getService(int|string $apiKey) : Service
Parameters
- $apiKey : int|string
Return values
Service —Information about the service.
getServiceConfiguration()
Get the configuration of the service in JSON format that complies with OpenID Connect Discovery 1.0 (= call Authlete's /api/service/configuration API).
public
getServiceConfiguration([bool $pretty = true ]) : string
Parameters
- $pretty : bool = true
Return values
string —The configuration of the service in JSON format.
getServiceJwks()
Get the JWK Set of a service (= call Authlete's /api/service/jwks/get API).
public
getServiceJwks([bool $pretty = false ][, bool $includePrivateKeys = false ]) : string
Parameters
- $pretty : bool = false
- $includePrivateKeys : bool = false
Return values
string —JSON representation of the JWK Set of the service.
getServiceList()
Get a list of services that belong to the service owner (= call Authlete's /api/service/get/list API).
public
getServiceList(int $start[, int $end = 5 ]) : ServiceListResponse
Parameters
- $start : int
- $end : int = 5
Return values
ServiceListResponse —A list of services.
getSettings()
The settings of this AuthleteApi implementation.
public
getSettings() : Settings
Return values
Settings —The settings of this AuthleteApi implementation.
introspection()
Call Authlete's /api/auth/introspection API.
public
introspection(IntrospectionRequest $request) : IntrospectionResponse
Parameters
- $request : IntrospectionRequest
Return values
IntrospectionResponse —Response from the API.
pushAuthorizationRequest()
Call Authlete's /api/pushed_auth_req API.
public
pushAuthorizationRequest(PushedAuthReqRequest $request) : PushedAuthReqResponse
Parameters
- $request : PushedAuthReqRequest
Return values
PushedAuthReqResponse —Response from the API.
refreshClientSecret()
Refresh the client secret of a client (= call Authlete's /api/client/secret/refresh/{clientId} API).
public
refreshClientSecret(int|string $clientId) : ClientSecretRefreshResponse
Parameters
- $clientId : int|string
Return values
ClientSecretRefreshResponse —The client secret.
revocation()
Call Authlete's /api/auth/revocation API.
public
revocation(RevocationRequest $request) : RevocationResponse
Parameters
- $request : RevocationRequest
Return values
RevocationResponse —Response from the API.
standardIntrospection()
Call Authlete's /api/auth/introspection/standard API.
public
standardIntrospection(StandardIntrospectionRequest $request) : StandardIntrospectionResponse
Parameters
- $request : StandardIntrospectionRequest
Return values
StandardIntrospectionResponse —Response from the API.
token()
Call Authlete's /api/auth/token API.
public
token(TokenRequest $request) : TokenResponse
Parameters
- $request : TokenRequest
Return values
TokenResponse —Response from the API.
tokenCreate()
Call Authlete's /api/auth/token/create API.
public
tokenCreate(TokenCreateRequest $request) : TokenCreateResponse
Parameters
- $request : TokenCreateRequest
Return values
TokenCreateResponse —Response from the API.
tokenDelete()
Delete an access token (= call Authlete's /api/auth/token/delete/{token} API).
public
tokenDelete(string $token) : mixed
Parameters
- $token : string
Return values
mixed —tokenFail()
Call Authlete's /api/auth/token/fail API.
public
tokenFail(TokenFailRequest $request) : TokenFailResponse
Parameters
- $request : TokenFailRequest
Return values
TokenFailResponse —Response from the API.
tokenIssue()
Call Authlete's /api/auth/token/issue API.
public
tokenIssue(TokenIssueRequest $request) : TokenIssueResponse
Parameters
- $request : TokenIssueRequest
Return values
TokenIssueResponse —Response from the API.
tokenUpdate()
Call Authlete's /api/auth/token/update API.
public
tokenUpdate(TokenUpdateRequest $request) : TokenUpdateResponse
Parameters
- $request : TokenUpdateRequest
Return values
TokenUpdateResponse —Response from the API.
updateClient()
Update a client (= call Authlete's /api/client/update/{clientId} API).
public
updateClient(Client $client) : Client
Parameters
- $client : Client
Return values
Client —Information about the updated client.
updateClientAuthorization()
Update attributes of all existing access tokens issued to the client application by the end-user (= call Authlete's /api/client/authorization/update/{clientId} API).
public
updateClientAuthorization(int|string $clientId, ClientAuthorizationUpdateRequest $request) : ApiResponse
Parameters
- $clientId : int|string
- $request : ClientAuthorizationUpdateRequest
Return values
ApiResponse —The result of the API call.
updateClientSecret()
Update the client secret of a client (= call Authlete's /api/client/secret/update/{clientId} API).
public
updateClientSecret(int|string $clientId, string $clientSecret) : ClientSecretUpdateResponse
Parameters
- $clientId : int|string
- $clientSecret : string
Return values
ClientSecretUpdateResponse —The client secret.
updateService()
Update a service (= call Authlete's /api/service/update/{apiKey} API).
public
updateService(Service $service) : Service
Parameters
- $service : Service
Return values
Service —Information about the updated service.
userInfo()
Call Authlete's /api/auth/userinfo API.
public
userInfo(UserInfoRequest $request) : UserInfoResponse
Parameters
- $request : UserInfoRequest
Return values
UserInfoResponse —Response from the API.
userInfoIssue()
Call Authlete's /api/auth/userinfo/issue API.
public
userInfoIssue(UserInfoIssueRequest $request) : UserInfoIssueResponse
Parameters
- $request : UserInfoIssueRequest
Return values
UserInfoIssueResponse —Response from the API.