Skip to content

Commit 1d2881f

Browse files
committed
Rename the 'Service Accounts' user guide section
To follow our structure of concept/noun naming for the categories in the usage patterns section.
1 parent 5657458 commit 1d2881f

File tree

5 files changed

+21
-19
lines changed

5 files changed

+21
-19
lines changed

docs/user_guide/usage_patterns/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ transfers.
2929

3030
data_transfer/index
3131
sessions_and_consents/index
32-
client_identities/index
32+
service_accounts/index

docs/user_guide/usage_patterns/client_identities/index.rst renamed to docs/user_guide/usage_patterns/service_accounts/index.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
.. _userguide_client_identities:
1+
.. _userguide_service_accounts:
22

3-
Using Client Identities
4-
=======================
3+
Service Accounts
4+
================
55

66
Some clients registered in Globus may operate as independent "service accounts",
77
distinct actors with their own identities.
8-
This is useful for a wide range of automation tasks, in which users want to
9-
leverage Globus APIs, but without handling login flows and user credentials.
10-
11-
To make use of Client Identities in this way, the client must be registered as a
12-
"service account", capable of performing a *client credentials grant* to get
13-
its tokens.
8+
These are also referred to as "client identities" because the actor in question
9+
is the client itself.
10+
Service accounts useful for a wide range of automation tasks, in which users
11+
want to leverage Globus APIs, but without handling login flows and user
12+
credentials.
13+
14+
To make use of clients in this way, the client must be registered as a Service
15+
Account, capable of performing a *client credentials grant* to get its tokens.
1416
Once it is so registered, such a client will have an ID and secret, which can be
1517
passed into interfaces in the SDK.
1618
The client credentials (ID and secret) are used to get tokens to power
@@ -19,7 +21,7 @@ these tokens appropriately.
1921

2022
.. note::
2123

22-
In order to be used as a Client Identity, a client must have an ID and secret.
24+
In order to be used as a Service Account, a client must have an ID and secret.
2325
However, not every client with an ID and secret supports this usage! Clients
2426
may be registered with various different OAuth2 grant types enabled, and some
2527
clients have an ID and secret but are used to authenticate user logins!
@@ -28,8 +30,8 @@ these tokens appropriately.
2830
for this kind of usage.
2931

3032
.. toctree::
31-
:caption: Using Client Identities with the SDK
33+
:caption: Using Service Accounts with the SDK
3234
:maxdepth: 1
3335

34-
registering_a_client_identity
36+
registering_a_service_account
3537
using_client_app/index

docs/user_guide/usage_patterns/client_identities/registering_a_client_identity.rst renamed to docs/user_guide/usage_patterns/service_accounts/registering_a_service_account.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
.. _userguide_register_client_identity:
1+
.. _userguide_register_service_account:
22

3-
Registering a Client Identity
3+
Registering a Service Account
44
=============================
55

6-
In order to be used as a Client Identity or "service account", a client must
6+
In order to be used as a Service Account or "Client Identity", a client must
77
be registered in Globus Auth under the correct type.
88

99
This is similar to the
1010
:ref:`getting started documentation on registering an app <tutorial_register_app>`,
1111
but using some different settings.
1212

13-
Creating the Client Identity
14-
----------------------------
13+
Creating the Client
14+
-------------------
1515

1616
The following steps will walk you through how to register a client for use as a
1717
service account.

docs/user_guide/usage_patterns/client_identities/using_client_app/client_app_ls.py renamed to docs/user_guide/usage_patterns/service_accounts/using_client_app/client_app_ls.py

File renamed without changes.

docs/user_guide/usage_patterns/client_identities/using_client_app/index.rst renamed to docs/user_guide/usage_patterns/service_accounts/using_client_app/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Instantiating a ClientApp
1515

1616
Constructing an app takes three required parameters,
1717

18-
- a human readable name to identify your app in HTTP requests and token caching (e.g., My Cool Weathervane).
18+
- a human readable name to identify your app in HTTP requests and token caching (e.g., "My Cool Weathervane").
1919
- this does not need match the name you supplied during client registration.
2020
- the client ID
2121
- the client secret

0 commit comments

Comments
 (0)