Nextcloud PHP API (stable18)

ICredentialsManager

Store and retrieve credentials for external services

Tags
since
8.2.0

Table of Contents

delete()  : int
Delete a set of credentials
erase()  : int
Erase all credentials stored for a user
retrieve()  : mixed
Retrieve a set of credentials
store()  : mixed
Store a set of credentials

Methods

delete()

Delete a set of credentials

public delete(string $userId, string $identifier) : int
Parameters
$userId : string

empty string for system-wide credentials

$identifier : string
Tags
since
8.2.0
Return values
int

rows removed

erase()

Erase all credentials stored for a user

public erase(string $userId) : int
Parameters
$userId : string
Tags
since
8.2.0
Return values
int

rows removed

retrieve()

Retrieve a set of credentials

public retrieve(string $userId, string $identifier) : mixed
Parameters
$userId : string

empty string for system-wide credentials

$identifier : string
Tags
since
8.2.0
Return values
mixed

store()

Store a set of credentials

public store(string $userId, string $identifier, mixed $credentials) : mixed
Parameters
$userId : string

empty string for system-wide credentials

$identifier : string
$credentials : mixed
Tags
since
8.2.0
Return values
mixed

Search results