Nextcloud PHP API (master)

IAccountManager
in

Access user profile information

Tags
since
15.0.0

Table of Contents

Constants

ALLOWED_PROPERTIES  : mixed = [self::PROPERTY_ADDRESS, self::PROPERTY_AVATAR,...
The list of allowed properties
ALLOWED_SCOPES  : mixed = [self::SCOPE_PRIVATE, self::SCOPE_LOCAL, self::...
The list of allowed scopes
COLLECTION_EMAIL  : mixed = 'additional_mail'
NOT_VERIFIED  : mixed = '0'
PROPERTY_ADDRESS  : mixed = 'address'
PROPERTY_AVATAR  : mixed = 'avatar'
PROPERTY_BIOGRAPHY  : mixed = 'biography'
PROPERTY_BIRTHDATE  : mixed = 'birthdate'
PROPERTY_BLUESKY  : mixed = 'bluesky'
PROPERTY_DISPLAYNAME  : mixed = 'displayname'
PROPERTY_DISPLAYNAME_LEGACY  : mixed = 'display-name'
PROPERTY_EMAIL  : mixed = 'email'
PROPERTY_FEDIVERSE  : mixed = 'fediverse'
PROPERTY_HEADLINE  : mixed = 'headline'
PROPERTY_ORGANISATION  : mixed = 'organisation'
PROPERTY_PHONE  : mixed = 'phone'
PROPERTY_PROFILE_ENABLED  : mixed = 'profile_enabled'
PROPERTY_PRONOUNS  : mixed = 'pronouns'
PROPERTY_ROLE  : mixed = 'role'
PROPERTY_TWITTER  : mixed = 'twitter'
PROPERTY_WEBSITE  : mixed = 'website'
SCOPE_FEDERATED  : mixed = 'v2-federated'
Contact details visible locally, through public link access and on trusted federated servers.
SCOPE_LOCAL  : mixed = 'v2-local'
Contact details visible locally and through public link access on local instance
SCOPE_PRIVATE  : mixed = 'v2-private'
Contact details visible locally only
SCOPE_PUBLISHED  : mixed = 'v2-published'
Contact details visible locally, through public link access, on trusted federated servers and published to the public lookup server.
VERIFICATION_IN_PROGRESS  : mixed = '1'
VERIFIED  : mixed = '2'

Methods

getAccount()  : IAccount
Get the account data for a given user
searchUsers()  : array<string|int, mixed>
Search for users based on account data
updateAccount()  : void
Update the account data with for the user

Constants

ALLOWED_PROPERTIES

The list of allowed properties

public mixed ALLOWED_PROPERTIES = [self::PROPERTY_ADDRESS, self::PROPERTY_AVATAR, self::PROPERTY_BIOGRAPHY, self::PROPERTY_BIRTHDATE, self::PROPERTY_DISPLAYNAME, self::PROPERTY_EMAIL, self::PROPERTY_FEDIVERSE, self::PROPERTY_HEADLINE, self::PROPERTY_ORGANISATION, self::PROPERTY_PHONE, self::PROPERTY_PROFILE_ENABLED, self::PROPERTY_PRONOUNS, self::PROPERTY_ROLE, self::PROPERTY_TWITTER, self::PROPERTY_BLUESKY, self::PROPERTY_WEBSITE]
Tags
since
25.0.0

ALLOWED_SCOPES

The list of allowed scopes

public mixed ALLOWED_SCOPES = [self::SCOPE_PRIVATE, self::SCOPE_LOCAL, self::SCOPE_FEDERATED, self::SCOPE_PUBLISHED]
Tags
since
25.0.0

COLLECTION_EMAIL

public mixed COLLECTION_EMAIL = 'additional_mail'
Tags
since
22.0.0

PROPERTY_ADDRESS

public mixed PROPERTY_ADDRESS = 'address'
Tags
since
15.0.0

PROPERTY_AVATAR

public mixed PROPERTY_AVATAR = 'avatar'
Tags
since
15.0.0

PROPERTY_BIOGRAPHY

public mixed PROPERTY_BIOGRAPHY = 'biography'
Tags
since
23.0.0

PROPERTY_BIRTHDATE

public mixed PROPERTY_BIRTHDATE = 'birthdate'
Tags
since
30.0.0

PROPERTY_BLUESKY

public mixed PROPERTY_BLUESKY = 'bluesky'
Tags
since
32.0.0

PROPERTY_DISPLAYNAME

public mixed PROPERTY_DISPLAYNAME = 'displayname'
Tags
since
15.0.0

PROPERTY_DISPLAYNAME_LEGACY

only added for backwards compatibility with provisioning_api UsersController::getCurrentUser

public mixed PROPERTY_DISPLAYNAME_LEGACY = 'display-name'
Tags
since
27.0.0

PROPERTY_EMAIL

public mixed PROPERTY_EMAIL = 'email'
Tags
since
15.0.0

PROPERTY_FEDIVERSE

public mixed PROPERTY_FEDIVERSE = 'fediverse'
Tags
since
26.0.0

PROPERTY_HEADLINE

public mixed PROPERTY_HEADLINE = 'headline'
Tags
since
23.0.0

PROPERTY_ORGANISATION

public mixed PROPERTY_ORGANISATION = 'organisation'
Tags
since
23.0.0

PROPERTY_PHONE

public mixed PROPERTY_PHONE = 'phone'
Tags
since
15.0.0

PROPERTY_PROFILE_ENABLED

public mixed PROPERTY_PROFILE_ENABLED = 'profile_enabled'
Tags
since
23.0.0

PROPERTY_PRONOUNS

public mixed PROPERTY_PRONOUNS = 'pronouns'
Tags
since
31.0.0

PROPERTY_ROLE

public mixed PROPERTY_ROLE = 'role'
Tags
since
23.0.0

PROPERTY_TWITTER

public mixed PROPERTY_TWITTER = 'twitter'
Tags
since
15.0.0

PROPERTY_WEBSITE

public mixed PROPERTY_WEBSITE = 'website'
Tags
since
15.0.0

SCOPE_FEDERATED

Contact details visible locally, through public link access and on trusted federated servers.

public mixed SCOPE_FEDERATED = 'v2-federated'
Tags
since
21.0.1

SCOPE_LOCAL

Contact details visible locally and through public link access on local instance

public mixed SCOPE_LOCAL = 'v2-local'
Tags
since
21.0.1

SCOPE_PRIVATE

Contact details visible locally only

public mixed SCOPE_PRIVATE = 'v2-private'
Tags
since
21.0.1

SCOPE_PUBLISHED

Contact details visible locally, through public link access, on trusted federated servers and published to the public lookup server.

public mixed SCOPE_PUBLISHED = 'v2-published'
Tags
since
21.0.1

VERIFICATION_IN_PROGRESS

public mixed VERIFICATION_IN_PROGRESS = '1'
Tags
since
15.0.0

Methods

searchUsers()

Search for users based on account data

public searchUsers(string $property, array<string|int, string> $values) : array<string|int, mixed>
Parameters
$property : string
  • property or property collection name – since NC 22 the implementation MAY add a fitting property collection into the search even if a property name was given e.g. email property and email collection)
$values : array<string|int, string>
Tags
since
21.0.0
Return values
array<string|int, mixed>

updateAccount()

Update the account data with for the user

public updateAccount(IAccount $account) : void
Parameters
$account : IAccount
Tags
since
21.0.1
throws
InvalidArgumentException

Message is the property that was invalid

On this page

Search results