Skip to content

Commit db36e22

Browse files
committed
Add disambiguation to Service Accounts doc
This new section is meant to make it clearer what a Client is, and that the term has two different meanings from two different domains.
1 parent 1d2881f commit db36e22

File tree

1 file changed

+18
-0
lines changed
  • docs/user_guide/usage_patterns/service_accounts

1 file changed

+18
-0
lines changed

docs/user_guide/usage_patterns/service_accounts/index.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,21 @@ these tokens appropriately.
3535

3636
registering_a_service_account
3737
using_client_app/index
38+
39+
40+
Disambiguation: "Clients" vs "Client Identities" vs "Service Accounts"
41+
----------------------------------------------------------------------
42+
43+
There are two different meanings for the word "client", from different domains.
44+
45+
Conventionally, a library's adapter for a web API is a "client".
46+
In the SDK, we primarily use the word "client" to refer to these API connectors,
47+
as in ``TransferClient``, ``GroupsClient``, etc.
48+
49+
OAuth2 calls an application registered with the service a "client".
50+
A "Client Identity" is a Globus Auth concept which uses this meaning of
51+
"client".
52+
53+
As a result of this ambiguity, this documentation will prefer to refer to
54+
"Client Identities" as "Service Accounts", which is the term which is used in
55+
other Globus documentation and the web interface.

0 commit comments

Comments
 (0)