\Pydio\Core\ServicesApiKeysService

Class ApiKeysService

Summary

Methods
Properties
Constants
generatePairForAuthfront()
generatePairForAdminTask()
findPairForAdminTask()
revokePairForAdminTask()
requestHasValidHeadersForAdminTask()
loadDataForPair()
revokeTokens()
listPairsForUser()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
getStore()
No private properties found
N/A

Methods

generatePairForAuthfront()

generatePairForAuthfront(  $userId, string  $deviceId = "", string  $deviceUA = "", string  $deviceIP = "") : array

Parameters

$userId
string $deviceId
string $deviceUA
string $deviceIP

Throws

\Pydio\Core\Exception\PydioException
\Exception

Returns

array

generatePairForAdminTask()

generatePairForAdminTask(  $adminTaskId,   $userId = "", string  $restrictToIP = "") : array

Parameters

$adminTaskId
$userId
string $restrictToIP

Throws

\Pydio\Core\Exception\PydioException
\Exception

Returns

array

findPairForAdminTask()

findPairForAdminTask(  $adminTaskId,   $userId = "") : array|null

Parameters

$adminTaskId
$userId

Throws

\Pydio\Core\Exception\PydioException

Returns

array|null

revokePairForAdminTask()

revokePairForAdminTask(string  $adminTaskId, string  $userId = "") : integer

Parameters

string $adminTaskId
string $userId

Throws

\Pydio\Core\Exception\PydioException

Returns

integer —

number of deleted keys

requestHasValidHeadersForAdminTask()

requestHasValidHeadersForAdminTask(  $serverData,   $adminTaskId,   $userId = "") : boolean

Parameters

$serverData
$adminTaskId
$userId

Returns

boolean

loadDataForPair()

loadDataForPair(  $token, string  $checkPrivate = "") : boolean

Parameters

$token
string $checkPrivate

Throws

\Pydio\Core\Exception\PydioException

Returns

boolean

revokeTokens()

revokeTokens(  $userId,   $token = "") : integer

Parameters

$userId
$token

Throws

\Pydio\Core\Exception\PydioException

Returns

integer

listPairsForUser()

listPairsForUser(  $userId) : array

Parameters

$userId

Throws

\Pydio\Core\Exception\PydioException

Returns

array