Skip to content

Commit a75751c

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 a75751c

File tree

1 file changed

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

1 file changed

+19
-0
lines changed

docs/user_guide/usage_patterns/service_accounts/index.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,25 @@ these tokens appropriately.
2929
Put another way: having client credentials is *necessary but not sufficient*
3030
for this kind of usage.
3131

32+
33+
Disambiguation: "Clients" vs "Client Identities" vs "Service Accounts"
34+
----------------------------------------------------------------------
35+
36+
There are two different meanings for the word "client", from different domains.
37+
38+
Conventionally, a library's adapter for a web API is a "client".
39+
In the SDK, we primarily use the word "client" to refer to these API connectors,
40+
as in ``TransferClient``, ``GroupsClient``, etc.
41+
42+
OAuth2 calls an application registered with the service a "client".
43+
A "Client Identity" is a Globus Auth concept which uses this meaning of
44+
"client".
45+
46+
As a result of this ambiguity, this documentation will prefer to refer to
47+
"Client Identities" as "Service Accounts", which is the term which is used in
48+
other Globus documentation and the web interface.
49+
50+
3251
.. toctree::
3352
:caption: Using Service Accounts with the SDK
3453
:maxdepth: 1

0 commit comments

Comments
 (0)