Skip to content

Commit

Permalink
Migrate tutorial doc client creation to point at new developers site (#…
Browse files Browse the repository at this point in the history
…802)

* Migrate tutorial doc client creation to point at new developers site

* typos

* revise tutorial doc
  • Loading branch information
derek-globus authored Aug 14, 2023
1 parent 3828212 commit 2e7812c
Showing 1 changed file with 20 additions and 25 deletions.
45 changes: 20 additions & 25 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,41 +49,36 @@ Step 1: Create a Client
In order to complete an OAuth2 flow to get tokens, you must have a client or
"app" definition registered with Globus.

Navigate to the `Developer Site <https://developers.globus.org>`_ and select
"Register your app with Globus."
You will be prompted to login -- do so with the account you wish to use as your
app's administrator.
The following steps will walk you through creating a Native App to be used as your
Globus interaction client.

When prompted, create a Project. A Project is a collection of clients with a
shared list of administrators.
Projects let you share the administrative burden of a collection of apps.
1. Navigate to the `Developer Site <https://app.globus.org/settings/developers>`_

In the "Add" menu for your Project, select "Add new app". To follow this
tutorial, we will specify several values you should use.
2. Select "Register a thick client or script that will be installed and run by users on
their devices."

Enter the following pieces of information:
3. Create or Select a Project

- **Native App**: Check this Box
- **Redirects**: https://auth.globus.org/v2/web/auth-code
* A project is a collection of apps with a shared list of administrators.
* If you don't own any projects, you will automatically be prompted to create one.
* If you do, you will be prompted to either select an existing or create a new one.

and click "Create App".
4. Creating or selecting a project will prompt you for another login, sign in with an
account that administers your project.

.. warning::
5. Give your App a name; this is what users will see when they are asked to
authorize your app.

The **Native App** setting cannot be changed after a client is created.
If it is not selected during creation, you must create a replacement client.
6. Click "Register App". This will create your app and take you to a page
describing it.

Expand the dropdown for the new app, and you should see an array of
attributes of your client.
7. Copy the "Client UUID" from the page.

You will need the Client ID from this screen.
Feel free to think of this as your App's "username".
You can hardcode it into scripts, store it in a config file, or even put it
into a database.
It's non-secure information and you can treat it as such.
* This ID can be thought of as your App's "username". It is non-secure information
and as such, feel free to hardcode it into scripts.

In the rest of the tutorial we will assume in all code samples that it is
available in the variable, ``CLIENT_ID``.
In the rest of the tutorial we will assume in all code samples that the Client UUID is
available in the variable ``CLIENT_ID``.

.. _tutorial_step2:

Expand Down

0 comments on commit 2e7812c

Please sign in to comment.