-
Notifications
You must be signed in to change notification settings - Fork 8
[INT-4120] IAM - Notion - connection guide #264
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| --- | ||
| title: "Notion" | ||
| description: "Follow these steps to connect Notion via the StackOne Hub successfully." | ||
| --- | ||
|
|
||
| import IntegrationFooter from "/snippets/integration-footer.mdx"; | ||
|
|
||
| <Warning> | ||
| Ensure that your Notion account has **Workspace owner** or **Workspace admin** privileges. | ||
| </Warning> | ||
|
|
||
| If you've been directed to StackOne to integrate with Notion, the following steps will help you understand the process and any necessary actions to configure a successful integration. | ||
|
|
||
| ## Log in to Notion | ||
|
|
||
| Log in to your Notion account. | ||
|
|
||
| <Frame> | ||
| <img className='rounded-md' style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Log in to Notion" src="/images/notion/iam_image1.png" /> | ||
| </Frame> | ||
|
|
||
|
|
||
| ## Create your Notion API Key | ||
|
|
||
| <Steps> | ||
| <Step title="Navigate to Integrations"> | ||
| Go to your Notion Profile Integrations page at https://www.notion.so/profile/integrations and click **New integration**. | ||
|
|
||
| <Frame> | ||
| <img className='rounded-md' style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Navigate to API Keys" src="/images/notion/iam_image2.png" /> | ||
| </Frame> | ||
| </Step> | ||
| <Step title="Enter Integration Details"> | ||
| Enter/select the following fields: | ||
| - **Integration Name**: A name for your integration | ||
| - **Associated workspace**: The Notion Workspace that this integration will have access to | ||
| - **Type**: Select *Internal* | ||
|
|
||
| Click **Save** to continue. | ||
|
|
||
| <Frame> | ||
| <img className='rounded-md' style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Create a new API Key" src="/images/notion/iam_image3.png" /> | ||
| </Frame> | ||
| </Step> | ||
| <Step title="Copy your API Key"> | ||
| A popup will appear displaying that the integration has been created successfully. Click **Configure integration settings** to continue. | ||
|
|
||
| Your **API Key** will be available to copy under *Internal Integration Secret*. **Copy** this value and store it safely to be used in a later step. | ||
|
|
||
| <Frame> | ||
| <img className='rounded-md' style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Copy your API Key" src="/images/notion/iam_image4.png" /> | ||
| </Frame> | ||
| </Step> | ||
| <Step title="Select API Key Capabilities"> | ||
| Under *Capabilities* > *User Capabilities* ensure that "Read user information including email addresses" is selected. This is the only capability required for this integration. | ||
|
|
||
| Click **Save** to continue. | ||
|
|
||
| <Frame> | ||
| <img className='rounded-md' style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Select API Key Scopes" src="/images/notion/iam_image5.png" /> | ||
| </Frame> | ||
| </Step> | ||
|
|
||
| </Steps> | ||
| ## Create your Notion SCIM Token (optional) | ||
|
|
||
| A SCIM Token is needed for retrieving User Roles via this integration, but is only available for Notion Enterprise customers with SCIM Provisioning enabled. | ||
|
|
||
| For more information on this and obtaining a SCIM Token, please refer to the [Notion SCIM Provisioning documentation](https://www.notion.com/help/provision-users-and-groups-with-scim). | ||
|
jerann marked this conversation as resolved.
|
||
|
|
||
| ## Connecting with StackOne | ||
|
|
||
| Upon reaching the Link Account page, enter the credential(s) from the previous steps: | ||
| - **API Key** | ||
| - **SCIM Token** (optional) | ||
|
|
||
| Proceed by clicking the Connect button. | ||
|
|
||
| <Frame> | ||
| <img className='rounded-md' style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Enter Credentials" src="/images/notion/iam_image6.png" /> | ||
| </Frame> | ||
|
|
||
| <IntegrationFooter /> | ||
|
|
||
| ## Available data | ||
|
|
||
| This integration has the following [IAM Resources](https://docs.stackone.com/reference/getting-started-with-your-api) available from the provider: | ||
| <ul> | ||
| <li>Users</li> | ||
| <li>Roles</li> | ||
| </ul> | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.