Skip to content

Commit eeb9403

Browse files
committed
Comment applied
1 parent a444ca3 commit eeb9403

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

docs/topics/api/accounts.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ A developer is defined as a user who is listed as a developer or owner of one or
5353
If you authenticate and access your own account by specifing your own ``user_id`` the following additional fields are returned.
5454
You can always access your account, regardless of whether you are a developer or not.
5555
If you have ``Users:Edit`` permission you will see these extra fields for all user accounts.
56-
If you have ``Users:Lookup`` permission (but not ``Users:Edit``) you will see all fields from
57-
the :ref:`account object <account-object>` plus ``email``, but not the other privileged fields below.
56+
If you have ``Users:Lookup`` permission (but not ``Users:Edit``) you will see the
57+
:ref:`lookup account object <account-object-lookup>` instead.
5858

5959
.. http:get:: /api/v5/accounts/account/(int:user_id|string:username)/
6060
@@ -116,14 +116,17 @@ This endpoint looks up one or more accounts by email address.
116116
Since multiple accounts can share the same email address, the response is always a list.
117117
Deleted accounts are excluded from results.
118118

119-
The response includes all :ref:`account object <account-object>` fields plus ``email``,
120-
but excludes sensitive fields such as ``last_login_ip`` and ``permissions``.
121-
122119
.. http:get:: /api/v5/accounts/account/lookup/
123120
124-
:query string email: The email address to look up.
121+
.. _account-object-lookup:
122+
123+
Returns a list of :ref:`account objects <account-object>` with the following additional field.
124+
Sensitive fields from the :ref:`self object <account-object-self>` such as ``last_login_ip``
125+
and ``permissions`` are not included.
125126

126-
Returns a list of :ref:`account objects <account-object>` augmented with ``email``.
127+
:>json string email: Email address used by the user to login and create this account.
128+
129+
:query string email: The email address to look up.
127130

128131
:statuscode 200: account(s) found.
129132
:statuscode 400: ``email`` query parameter is missing.

0 commit comments

Comments
 (0)