diff --git a/api-reference/quickstart.mdx b/api-reference/quickstart.mdx index 176c12b0..52167c70 100644 --- a/api-reference/quickstart.mdx +++ b/api-reference/quickstart.mdx @@ -54,8 +54,7 @@ To run this quickstart, you will need: 2. Click **Generate New Key**. 3. Enter some meaningful display name for the key, and then click **Continue**. - 4. Next to the new key's name, click the **Copy** icon. The key's value is copied to your system's clipboard. - If you lose this key, simply return to the list and click **Copy** again. + 4. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one. - Python 3.9 or higher installed on your local machine. - A Python virtual environment is recommended for isolating and versioning Python project code dependencies on your local machine, diff --git a/api-reference/troubleshooting/api-key-url.mdx b/api-reference/troubleshooting/api-key-url.mdx index 6f18c9ad..aea4652b 100644 --- a/api-reference/troubleshooting/api-key-url.mdx +++ b/api-reference/troubleshooting/api-key-url.mdx @@ -60,9 +60,9 @@ If you do not have this URL, email Unstructured Support at [support@unstructured for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace). - b. Click **Generate API Key**.
+ b. Click **Generate New Key**.
c. Follow the on-screen instructions to finish generating the key.
- d. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.
+ d. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one.
For the API URL, note the value of the Unstructured API URL that you want to call. To access these API URLs: diff --git a/snippets/general-shared-text/first-time-api-destination-connector.mdx b/snippets/general-shared-text/first-time-api-destination-connector.mdx index c15b682d..f0a76aa1 100644 --- a/snippets/general-shared-text/first-time-api-destination-connector.mdx +++ b/snippets/general-shared-text/first-time-api-destination-connector.mdx @@ -17,9 +17,9 @@ For a **Business** account, before you click **API Keys**, make sure you have selected the organizational workspace you want to create an API key for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace). - 2. Click **Generate API Key**.
+ 2. Click **Generate New Key**.
3. Follow the on-screen instructions to finish generating the key.
- 4. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.
+ 4. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one.
After you create the destination connector, add it along with a [source connector](/api-reference/workflow/sources/overview) to a [workflow](/api-reference/workflow/overview#workflows). diff --git a/snippets/general-shared-text/first-time-api-source-connector.mdx b/snippets/general-shared-text/first-time-api-source-connector.mdx index e47856cd..473a3ffb 100644 --- a/snippets/general-shared-text/first-time-api-source-connector.mdx +++ b/snippets/general-shared-text/first-time-api-source-connector.mdx @@ -17,9 +17,9 @@ For a **Business** account, before you click **API Keys**, make sure you have selected the organizational workspace you want to create an API key for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace). - 2. Click **Generate API Key**.
+ 2. Click **Generate New Key**.
3. Follow the on-screen instructions to finish generating the key.
- 4. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.
+ 4. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one.
After you create the source connector, add it along with a [destination connector](/api-reference/workflow/destinations/overview) to a [workflow](/api-reference/workflow/overview#workflows). diff --git a/snippets/general-shared-text/get-started-simple-api-only.mdx b/snippets/general-shared-text/get-started-simple-api-only.mdx index 71ce4047..2d2dcedd 100644 --- a/snippets/general-shared-text/get-started-simple-api-only.mdx +++ b/snippets/general-shared-text/get-started-simple-api-only.mdx @@ -23,4 +23,4 @@ b. Click **Generate API Key**.
c. Follow the on-screen instructions to finish generating the key.
- d. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.
\ No newline at end of file + d. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one.
\ No newline at end of file diff --git a/ui/account/api-key-url.mdx b/ui/account/api-key-url.mdx index 5e8690c5..7118480e 100644 --- a/ui/account/api-key-url.mdx +++ b/ui/account/api-key-url.mdx @@ -33,19 +33,12 @@ or jobs in your Unstructured account, or to manage your Unstructured account. 2. On the sidebar, click **API Keys**. 3. On the **API Keys** tab, click **Generate New Key**. 4. Enter some descriptive name for the API key, and then click **Save**. - -The new API key is created and appears in the list of available API keys. - -The only setting you can change for this new API key is its [status](#enable-or-disable-an-existing-api-key). You cannot change its -name, value, or any other settings. +5. The generated API key is displayed. Copy this API key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this API key, you must generate a new one. ## Get an existing API key's value -1. If you are not already signed in, sign in to your Unstructured account. -2. On the sidebar, click **API Keys**. -3. On the **API Keys** tab, in the list of available keys, click the **Copy** icon for the target key. The key's value is copied to your system's clipboard. - -If you lose this API key's value, simply repeat this procedure. +After you create an API key and then close its creation confirmation dialog, you can no longer get that API key's value. +You must [create a new API key](#create-a-new-api-key) instead. If you are concerned that an unauthorized user or other entity might have this API key's value, you should [permanently delete](#permanently-delete-an-existing-api-key) this key. diff --git a/ui/account/workspaces.mdx b/ui/account/workspaces.mdx index 68018ebc..ae54a182 100644 --- a/ui/account/workspaces.mdx +++ b/ui/account/workspaces.mdx @@ -217,8 +217,7 @@ An API key can be used only with the workspace for which it was created. 6. In the top navigation bar, click **API Keys**. 7. Click **Generate New Key**. 8. Enter some name for the key, and click **Continue**. -9. To get the key's value, in the list of available keys, click the **Copy** icon next to the newly created key. The key's value is - copies to your system's clipboard. +9. The generated API key is displayed. Copy this API key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this API key, you must generate a new one. ## Delete an API key for a workspace diff --git a/welcome.mdx b/welcome.mdx index 4e79ed51..c1cb8dcd 100644 --- a/welcome.mdx +++ b/welcome.mdx @@ -91,9 +91,9 @@ transformation results for files that are stored locally. for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace). - b. Click **Generate API Key**.
+ b. Click **Generate New Key**.
c. Follow the on-screen instructions to finish generating the key.
- d. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.
+ d. The generated key is displayed. Copy this key to a secure location, as you will not be able to access it again after you close the dialog. If you lose this key, you must generate a new one.
3. Now that you have your Unstructured API key, choose one of the following options to continue: