diff --git a/docs/plugins/ManagePlugins.mdx b/docs/plugins/ManagePlugins.mdx index 304bfd811..4c31faa69 100644 --- a/docs/plugins/ManagePlugins.mdx +++ b/docs/plugins/ManagePlugins.mdx @@ -111,8 +111,8 @@ Details on how to configure a specific plugin please find in the [Integration se * [integration with E-mail server](/plugins/EmailServer) * [integration with LDAP](/reportportal-configuration/authorization/LDAP) * [integration with Active directory](/reportportal-configuration/authorization/ActiveDirectory) -* [integration with Okta SAML](/reportportal-configuration/authorization/SAMLProvider/OktaSAML) -* [integration with Azure SAML](/reportportal-configuration/authorization/SAMLProvider/AzureSAML) +* [integration with Okta SAML](../reportportal-configuration/authorization/SamlProviders/OktaSaml.mdx) +* [integration with Azure SAML](../reportportal-configuration/authorization/SamlProviders/AzureSaml.mdx) > **Use case 1:** > diff --git a/docs/reportportal-configuration/IntegrationViaPlugin.mdx b/docs/reportportal-configuration/IntegrationViaPlugin.mdx index 94528ac39..28bf1990e 100644 --- a/docs/reportportal-configuration/IntegrationViaPlugin.mdx +++ b/docs/reportportal-configuration/IntegrationViaPlugin.mdx @@ -15,8 +15,8 @@ Users can enhance ReportPortal by adding additional integrations with: * [E-mail server](/plugins/EmailServer) * [LDAP](/reportportal-configuration/authorization/LDAP) * [Active Directory](/reportportal-configuration/authorization/ActiveDirectory) -* [Okta SAML](/reportportal-configuration/authorization/SAMLProvider/OktaSAML) -* [Azure SAML](/reportportal-configuration/authorization/SAMLProvider/AzureSAML) +* [Okta SAML](./authorization/SamlProviders/OktaSaml.mdx) +* [Azure SAML](./authorization/SamlProviders/AzureSaml.mdx) diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/OktaSAML.mdx b/docs/reportportal-configuration/authorization/SAMLProvider/OktaSAML.mdx deleted file mode 100644 index 7997e6617..000000000 --- a/docs/reportportal-configuration/authorization/SAMLProvider/OktaSAML.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_label: Okta SAML ---- - -# Okta SAML - -SAML plugin is available in ReportPortal on the Plugins page. - -***If you have a pre-created Internal user, you can't log in by SAML using their credentials (Email or Name).*** - -:::important -Before starting, please, read about the [SAML provider](/reportportal-configuration/authorization/SAMLProvider/). -::: - - - -To set up access with SAML: - -1. Log in to the ReportPortal as an ADMIN user -2. Then open the list on the right of the user's image. -3. Click the 'Administrative' link -4. Click the 'Plugins' from the left-hand sidebar -5. Click on the'SAML' tab. -6. Click on Add new integration -7. The next fields should be present: - -```javascript -'Identity provider name ID*': text -'Provider name*': text -'Metadata URL*': URL -'RP callback URL': URL - RP host/uat -'Email attribute*': text -'Name attributes mode' : -'Last name attribute' text -'First name attribute' text -or -'Full name attribute' : text - ``` - -Mandatory fields are marked with red. -Click the 'Submit' button. -All users of SAML will have access to the ReportPortal instance. -Just click on the button 'Login with SAML' and choose a needed integration from the drop-down - - -On Okta side you should to specify SSO URL and audience URI. - -The format for SSO URL is: - -```java -http (https)://
/uat/saml/sp/SSO/alias/report-portal-sp -``` -The audience URI is: - -```java -report.portal.sp.id -``` - - - -“RP callback URL” field is an optional field to provide a redirect base path right in SAML integration settings. Fill in the field in format “RP host/uat”. The format for url is the next: - -``` -https://reportportal.com/uat -``` -Once you have submitted an integration with “RP callback URL”, the URL will be applied to all SAML integrations. diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/AzureSAML.mdx b/docs/reportportal-configuration/authorization/SamlProviders/AzureSaml.mdx similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/AzureSAML.mdx rename to docs/reportportal-configuration/authorization/SamlProviders/AzureSaml.mdx diff --git a/docs/reportportal-configuration/authorization/SamlProviders/OktaSaml.mdx b/docs/reportportal-configuration/authorization/SamlProviders/OktaSaml.mdx new file mode 100644 index 000000000..0f8dd7754 --- /dev/null +++ b/docs/reportportal-configuration/authorization/SamlProviders/OktaSaml.mdx @@ -0,0 +1,202 @@ +--- +sidebar_label: Okta SAML +--- + +# Okta SAML + +:::important +Before starting, please read about the [SAML provider](Overview.mdx). +::: + +This guide will help you to configure the connection between ReportPortal and Okta. + +There is no comprehensive guide for Okta configuration, but you can use it as +a reference for the general steps. To get more information about Okta configuration, +read the [official documentation](https://developer.okta.com/docs/guides/saml-application-setup/overview/). + +SAML plugin is available in ReportPortal on the Plugins page. + +## Requirements + +1. Okta account +2. ReportPortal instance +3. Access to the ReportPortal instance and Okta account +4. Available connection between Okta and ReportPortal. + +## Configuration Okta + +### Step 1: Create a new App Integration + +#### Go to the Okta dashboard + + + +Click on the `Applications` in the sidebar menu and click on the +`Create App Integration` button. + +#### Choose integration type + + + +Pick `SAML 2.0` and click `Next`. + +#### Fill the general settings + + + +In the `App name` field, enter the application's name. Click `Next`. + +### Step 2: Configure SAML + +#### Fill in the SAML settings + + + +In the `Single sign-on URL` field, enter the following URL: + +```url +https:///uat/saml/sp/SSO/alias/report-portal-sp +``` +In my case, I deployed ReportPortal on the local machine, so I used the following URL: + +```url +http://192.168.49.2/uat/saml/sp/SSO/alias/report-portal-sp +``` + +In the `Audience URI (SP Entity ID)` field, enter the following identifier: + +``` +report.portal.sp.id +``` + +You can change this identifier when you deploy ReportPortal. More information +about the identifier you can find in the [SAML Overview](Overview.mdx#identifier). + +In the `Name ID format` field, select `EmailAddress`. You can use the UNSPECIFIED format as well. +More information about the Name ID format you can find in the [SAML Overview](Overview.mdx#reportportal-configuration). + +#### Fill in the Attribute Statements + + + +Add the following attributes: + +- `user.email` with the value `email` +- `user.firstName` with the value `firstName` +- `user.lastName` with the value `lastName` + +Click `Next`. + +#### Provide feedback + + + +In my case, I picked the `I'm an Okta customer adding an internal app` option +and picked in the `App type` field that 'This is an internal app that we have created'. + +Click `Finish`. + + +#### Copy metadata URL + + + +After the App Integration is created, you will see the `Settings` tab with the +`Sign on methods` section. + +Copy the ' Metadata URL ' in the `SAML 2.0` section. You will need it to +configure the ReportPortal SAML plugin. + +### Step 3: Assign users + + + +:::note +You can't provision a user from Okta to ReportPortal if you already have +a pre-created internal user in ReportPortal with the same email and a different +login. Read more about [JIT provisioning](Overview.mdx#user-jit-provisioning) +::: + +You can add a user by clicking on the `Assignments` tab and then clicking on +the `Assign` button. + +In my case, a user with the email `baba_yaga@continental.com` doesn't exist in +the deployed ReportPortal instance. + +## ReportPortal configuration + +### Step 1: Open the SAML plugin + + + +Log-in to the ReportPortal by Admin account and go to the `Administration` -> `Plugins` -> `SAML`. + +### Step 2: Add a new integration + + + +Click on the `Add integration` button. + +### Step 3: Fill in the form + + + +#### Identity provider name ID + +In the `Identity provider name ID` field, enter the +`urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` if you chose the +`EmailAddress` format for the `Name ID format` in the Okta configuration. +If you choose the `UNSPECIFIED` format, keep this field empty. + +You can find more information about the Name ID format in thes +[SAML Overview](Overview.mdx#reportportal-configuration). + +#### Provider name + +In the `Provider name` field, enter any name you want. In my case, I used `Okta`. + + +#### Metadata URL + +In the `Metadata URL` field, paste the copied Okta metadata URL. + +#### Attribute mapping + +You need to map the attributes from the Okta configuration to the ReportPortal. + +1. Enter the `email` attribute name in the' Email' field. +2. In the `First name` field, enter the `firstName` attribute name. +3. In the `Last name` field, enter the `lastName` attribute name. + +#### RP callback URL + +In the `RP callback URL` field, enter the URL: + +```url +https:///uat +``` + +In my case, I used the following URL: `http://192.168.49.2/uat`. + +#### Create the integration + + + +After you fill in the form and clicked on the `Create` button, you will see the +new integration in the list. + +### Step 4: Test the integration + + + +Log-out from the ReportPortal and go to login page. You will see the +`Login with SAML` button. + + + +Click on the butto, and you will be redirected to the Okta login page. + + + +After successful login, SAML plugin will create the user to the ReportPortal +and you can see the user in the `Users` section on the `Administration` page. \ No newline at end of file diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/index.mdx b/docs/reportportal-configuration/authorization/SamlProviders/Overview.mdx similarity index 58% rename from docs/reportportal-configuration/authorization/SAMLProvider/index.mdx rename to docs/reportportal-configuration/authorization/SamlProviders/Overview.mdx index 10aac5433..6b20dd20d 100644 --- a/docs/reportportal-configuration/authorization/SAMLProvider/index.mdx +++ b/docs/reportportal-configuration/authorization/SamlProviders/Overview.mdx @@ -1,19 +1,47 @@ --- -sidebar_label: SAML Provider +sidebar_label: Overview +sidebar_position: 1 --- -# SAML provider - -***If you have a pre-created Internal user, you can't log in by SAML using their credentials (Email or Name).*** +# SAML Overview This plugin allows you to configure a connection with a SAML provider. -Integration with SAML will allow you to login into ReportPortal using SSO instead of tedious manual user creation. +Integration with SAML will allow you to log in to ReportPortal using SSO +instead of tedious manual user creation. + +The plugin provides a mechanism for exchanging information between ReportPortal +and the SAML provider, such as the possibility of logging in to ReportPortal +with SAML credentials. + +## User JIT provisioning + +:::note +If you have a pre-created Internal user, you can't login by SAML using their +credentials (Email or Name). +::: -The plugin provides a mechanism to exchange information between ReportPortal and SAML provider, such as the possibility to login to ReportPortal with SAML credentials. +Just-in-time (JIT) provisioning is a feature that creates a user account in +ReportPortal when a user logs in for the first time. This feature is available +for SAML integrations. + +However, you can't provision a user from SAML Provider to ReportPortal if you +already have a pre-created internal user in ReportPortal with the same email +and different login. The login must be the email name without the domain part. +For instance, if the email is `john_weak@babayaga.com` the login should be +`john_weak`. +In the opposite case, the user cannot log in to ReportPortal. +You can fix it by changing the login name or email or deleting the user from +the ReportPortal. ## SAML provider requirements +:::tip +There are detailed manuals for the configuration of +[Azure SAML](AzureSaml.mdx) +and [Okta SAML](OktaSaml.mdx). +::: + - SAML 2.0 version - HTTP-POST Binding - URL to download [SAML IdP Metadata](https://en.wikipedia.org/wiki/SAML_metadata#Identity_provider_metadata) @@ -22,12 +50,7 @@ The plugin provides a mechanism to exchange information between ReportPortal and - email - first name - last name - - full name (instead first and last name) - -:::tip -There are detailed manuals for configuration of [Azure SAML](/reportportal-configuration/authorization/SAMLProvider/) and [Okta SAML](/reportportal-configuration/authorization/SAMLProvider/OktaSAML). -::: - + - full name (instead of first and last name) ## Add integration @@ -41,7 +64,8 @@ ReportPortal contains the SAML Plugin by default. ### Identity provider configuration #### ReportPortal SSO initial URL -You need to provide a URL for a SAML Provider to deliver SAML data for the identity federation. +You have to provide a URL for a SAML provider to deliver SAML data to the +identity federation. ```url https:///uat/saml/sp/SSO/alias/report-portal-sp @@ -49,10 +73,12 @@ https:///uat/saml/sp/SSO/alias/report-portal-sp #### Identifier -Set up identifier (aka Audience Restriction, aka Entity ID) for application as `report.portal.sp.id`. -You can specify personal Entity id when you deploy the Authorization service by environment variable `RP_AUTH_SAML_ENTITYID`. +Set up identifier (aka Audience Restriction, aka Entity ID) for application as +`report.portal.sp.id`. +When you deploy the authorization service, you can specify your entity ID using +the environment variable `RP_AUTH_SAML_ENTITYID`. -#### Custom attribute as claims in token +#### Custom attributes The IDp app user profile must provide attributes like this: @@ -62,7 +88,8 @@ The IDp app user profile must provide attributes like this: - user.lastName ``` -Also, Make sure there is a mapping created according to the values that you use in the ReportPortal SAML plugin like this: +Also, Make sure there is a mapping created according to the values that you use +in the ReportPortal SAML plugin like this: ``` - user.email -> Email @@ -72,32 +99,28 @@ Also, Make sure there is a mapping created according to the values that you use ### ReportPortal configuration - + ***Identity provider name ID (Optional)*** -**Identity provider name ID** (aka name identifier formats) controls how the users at identity providers are mapped to users at service providers. +**Identity provider name ID** (aka name identifier formats) controls how the +users at identity providers are mapped to users at service providers. -We support next formats: +We support the following formats: -UNSPECIFIED - used by default +1. `UNSPECIFIED` - used by default ```urn urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified ``` -EMAIL +2. `EMAIL` ```urn urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ``` -PERSISTENT - -```urn -urn:oasis:names:tc:SAML:2.0:nameid-format:persistent -``` - ***Provider name*** - Provider name associated with IDP. ***Metadata URL*** - URL that provides data with information about SAML Provider. @@ -110,9 +133,10 @@ urn:oasis:names:tc:SAML:2.0:nameid-format:persistent ``` -***ReportPortal Callback URL (Optional)*** - This field provides a redirect base path. +***ReportPortal Callback URL*** - This field provides a redirect base path. -Once you have submitted an integration with “RP callback URL”, the URL will be applied to all SAML integrations. +Once you submit an integration with the "RP callback URL," the URL will be +applied to all SAML integrations. ```url https:///uat diff --git a/docs/reportportal-configuration/authorization/SamlProviders/_category_.json b/docs/reportportal-configuration/authorization/SamlProviders/_category_.json new file mode 100644 index 000000000..f4026c028 --- /dev/null +++ b/docs/reportportal-configuration/authorization/SamlProviders/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "SAML Providers", + "link": { + "type": "generated-index" + } +} diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/OktaSAML.png b/docs/reportportal-configuration/authorization/SamlProviders/img/OktaSAML.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/OktaSAML.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/OktaSAML.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/OktaSide.png b/docs/reportportal-configuration/authorization/SamlProviders/img/OktaSide.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/OktaSide.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/OktaSide.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/SAMLPlugin.png b/docs/reportportal-configuration/authorization/SamlProviders/img/SAMLPlugin.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/SAMLPlugin.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/SAMLPlugin.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML1.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML1.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML1.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML1.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML10.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML10.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML10.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML10.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML11.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML11.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML11.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML11.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML12.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML12.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML12.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML12.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML13.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML13.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML13.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML13.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML14.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML14.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML14.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML14.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML15.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML15.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML15.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML15.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML16.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML16.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML16.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML16.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML17.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML17.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML17.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML17.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML18.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML18.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML18.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML18.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML19.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML19.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML19.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML19.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML2.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML2.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML2.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML2.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML20.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML20.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML20.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML20.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML21.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML21.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML21.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML21.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML22.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML22.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML22.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML22.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML23.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML23.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML23.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML23.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML24.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML24.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML24.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML24.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML3.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML3.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML3.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML3.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML4.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML4.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML4.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML4.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML5.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML5.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML5.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML5.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML6.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML6.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML6.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML6.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML7.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML7.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML7.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML7.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML8.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML8.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML8.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML8.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML9.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML9.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/AzureSAML9.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/AzureSAML9.png diff --git a/docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/SAMLIntegration.png b/docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/SAMLIntegration.png similarity index 100% rename from docs/reportportal-configuration/authorization/SAMLProvider/img/azure-saml/SAMLIntegration.png rename to docs/reportportal-configuration/authorization/SamlProviders/img/azure-saml/SAMLIntegration.png diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-1.0.jpg b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-1.0.jpg new file mode 100644 index 000000000..8744da334 Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-1.0.jpg differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-1.1.jpg b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-1.1.jpg new file mode 100644 index 000000000..db15f50fd Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-1.1.jpg differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-1.2.jpg b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-1.2.jpg new file mode 100644 index 000000000..a439962b0 Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-1.2.jpg differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.0.jpg b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.0.jpg new file mode 100644 index 000000000..a9cf00aa4 Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.0.jpg differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.1.jpg b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.1.jpg new file mode 100644 index 000000000..68275c0e6 Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.1.jpg differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.2.jpg b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.2.jpg new file mode 100644 index 000000000..444ab5713 Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.2.jpg differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.3.jpg b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.3.jpg new file mode 100644 index 000000000..b82f6786d Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-2.3.jpg differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-3.0.jpg b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-3.0.jpg new file mode 100644 index 000000000..1d2eeb2ad Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-3.0.jpg differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.0.png b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.0.png new file mode 100644 index 000000000..a6edd8583 Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.0.png differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.1.png b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.1.png new file mode 100644 index 000000000..9dba9c491 Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.1.png differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.2.png b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.2.png new file mode 100644 index 000000000..eb5a7fab1 Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.2.png differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.3.png b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.3.png new file mode 100644 index 000000000..c6e34700f Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.3.png differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.4.png b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.4.png new file mode 100644 index 000000000..6906c61d9 Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.4.png differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.5.png b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.5.png new file mode 100644 index 000000000..daf308bf3 Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.5.png differ diff --git a/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.6.png b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.6.png new file mode 100644 index 000000000..850e6b849 Binary files /dev/null and b/docs/reportportal-configuration/authorization/SamlProviders/img/okta-saml/okta-step-4.6.png differ diff --git a/docs/reportportal-configuration/authorization/_category_.json b/docs/reportportal-configuration/authorization/_category_.json new file mode 100644 index 000000000..4a0ac24f7 --- /dev/null +++ b/docs/reportportal-configuration/authorization/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "Authorization", + "link": { + "type": "generated-index" + } +} diff --git a/docs/reportportal-configuration/authorization/index.md b/docs/reportportal-configuration/authorization/index.md deleted file mode 100644 index 40c7061f1..000000000 --- a/docs/reportportal-configuration/authorization/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -sidebar_label: Authorization ---- - -# Authorization - -ReportPortal Admin can configure an easy authorization on the instance. From the box we provide OAuth with: - -* [Active Directory](/reportportal-configuration/authorization/ActiveDirectory) -* [GitHub](/reportportal-configuration/authorization/GitHub) -* [LDAP](/reportportal-configuration/authorization/LDAP) -* [SAML](/reportportal-configuration/authorization/SAMLProvider)