AdminTokenService Class Reference

Inheritance diagram for AdminTokenService:

Public Member Functions
	__construct (TokenModelFactory $tokenModelFactory, UserModel $userModel, TokenCollectionFactory $tokenModelCollectionFactory, CredentialsValidator $validatorHelper)
	createAdminAccessToken ($username, $password)
	revokeAdminAccessToken ($adminId)

Detailed Description

Class to handle token generation for Admins

Definition at line 21 of file AdminTokenService.php.

Constructor & Destructor Documentation

__construct()

__construct	(	TokenModelFactory	$tokenModelFactory,
		UserModel	$userModel,
		TokenCollectionFactory	$tokenModelCollectionFactory,
		CredentialsValidator	$validatorHelper
	)

Initialize service

Parameters

TokenModelFactory	$tokenModelFactory
UserModel	$userModel
TokenCollectionFactory	$tokenModelCollectionFactory
\Magento\Integration\Model\CredentialsValidator	$validatorHelper

Definition at line 62 of file AdminTokenService.php.

      {
        $this->tokenModelFactory = $tokenModelFactory;
        $this->userModel = $userModel;
        $this->tokenModelCollectionFactory = $tokenModelCollectionFactory;
        $this->validatorHelper = $validatorHelper;
    }

Member Function Documentation

createAdminAccessToken()

createAdminAccessToken	(		$username,
			$password
	)

{Create access token for admin given the admin credentials.

Parameters

string	$username
string	$password

Returns

string Token created

Exceptions

}

Implements AdminTokenServiceInterface.

Definition at line 77 of file AdminTokenService.php.

    {
        $this->validatorHelper->validate($username, $password);
        $this->getRequestThrottler()->throttle($username, RequestThrottler::USER_TYPE_ADMIN);
        $this->userModel->login($username, $password);
        if (!$this->userModel->getId()) {
            $this->getRequestThrottler()->logAuthenticationFailure($username, RequestThrottler::USER_TYPE_ADMIN);
            /*
             * This message is same as one thrown in \Magento\Backend\Model\Auth to keep the behavior consistent.
             * Constant cannot be created in Auth Model since it uses legacy translation that doesn't support it.
             * Need to make sure that this is refactored once exception handling is updated in Auth Model.
             */
            throw new AuthenticationException(
                __(
                    'The account sign-in was incorrect or your account is disabled temporarily. '
                    . 'Please wait and try again later.'
                )
            );
        }
        $this->getRequestThrottler()->resetAuthenticationFailuresCount($username, RequestThrottler::USER_TYPE_ADMIN);
        return $this->tokenModelFactory->create()->createAdminToken($this->userModel->getId())->getToken();
    }

revokeAdminAccessToken()

revokeAdminAccessToken

(

$adminId

)

Revoke token by admin id.

The function will delete the token from the oauth_token table.

Parameters

int

$adminId

Returns

bool

Exceptions

Implements AdminTokenServiceInterface.

Definition at line 109 of file AdminTokenService.php.

    {
        $tokenCollection = $this->tokenModelCollectionFactory->create()->addFilterByAdminId($adminId);
        if ($tokenCollection->getSize() == 0) {
            throw new LocalizedException(__('This user has no tokens.'));
        }
        try {
            foreach ($tokenCollection as $token) {
                $token->delete();
            }
        } catch (\Exception $e) {
            throw new LocalizedException(__("The tokens couldn't be revoked."));
        }
        return true;
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/module-integration/Model/AdminTokenService.php