Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 11790ed

Browse files
committed
fix sso content
1 parent 67335df commit 11790ed

File tree

5 files changed

+103
-113
lines changed

5 files changed

+103
-113
lines changed

sp-oncall/admin/sso/single-sign-sso.rst

Lines changed: 7 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ Configure Single Sign-On for Splunk On-Call
1010
.. toctree::
1111
:hidden:
1212

13-
sp-sso-okta
14-
sp-sso-google
15-
sp-sso-adfs
13+
Configure SSO for Okta<sp-sso-okta>
14+
Configure SSO for Google<sp-sso-google>
15+
Configure SSO for ADFS<sp-sso-adfs>
16+
Configure SSO for other IDPs<sp-sso-other>
1617
sp-sso-users
1718

1819
.. raw:: html
@@ -36,7 +37,7 @@ If your IDP does not have SAML capability, please contact Splunk On-Call Support
3637
.. raw:: html
3738

3839
<embed>
39-
<h2>Administrator setup<a name="admin-setup" class="headerlink" href="#admin-setup" title="Permalink to this headline">¶</a></h2>
40+
<h2>Configure SSO: Admin guides<a name="admin-setup" class="headerlink" href="#admin-setup" title="Permalink to this headline">¶</a></h2>
4041
</embed>
4142

4243
Instructions to complete the SSO configuration with Splunk On-Call and your IDP are provided for:
@@ -50,46 +51,7 @@ Instructions to complete the SSO configuration with Splunk On-Call and your IDP
5051
.. raw:: html
5152

5253
<embed>
53-
<h3>OneLogin<a name="sso-onelogin-spoc" class="headerlink" href="#sso-onelogin-spoc" title="Permalink to this headline">¶</a></h3>
54+
<h2>Sign in to Splunk On-Call through SSO: User guide<a name="user-guide" class="headerlink" href="#user-guide" title="Permalink to this headline">¶</a></h2>
5455
</embed>
5556

56-
If you are configuring SSO for OneLogin, the Default relay state is:
57-
58-
https://portal.victorops.com/auth/sso/<<org-slug-here>>
59-
60-
61-
.. raw:: html
62-
63-
<embed>
64-
<h3>Azure Active Directory (SAML-based sign-on)<a name="sso-azure-spoc" class="headerlink" href="#sso-azure-spoc" title="Permalink to this headline">¶</a></h3>
65-
</embed>
66-
67-
If you are configuring SSO for Azure Active Directory, use the following values:
68-
69-
- Identifier: :samp:`https://victorops.com`
70-
- Reply URL: :samp:`https://sso.victorops.com/sp/ACS.saml2`
71-
- Sign on URL: :samp:`https://portal.victorops.com/auth/sso/<<org-slug-here>>`
72-
- Relay State: :samp:`https://portal.victorops.com/auth/sso/<<org-slug-here>>`
73-
74-
75-
.. raw:: html
76-
77-
<embed>
78-
<h3>AWS IAM Identity Center - SAML<a name="sso-aws-spoc" class="headerlink" href="#sso-aws-spoc" title="Permalink to this headline">¶</a></h3>
79-
</embed>
80-
81-
If you are configuring SSO for AWS IAM Identity Center:
82-
83-
#. In the IAM Identity Center console find the :guilabel:`Applications` tab.
84-
#. Select :guilabel:`Add Application` and look for VictorOps.
85-
#. In the configuration settings ensure you set the fields as follows:
86-
87-
- Important: Ensure the Session Duration is set to 1hour.
88-
89-
.. image:: /_images/spoc/sso-aws1.png
90-
:width: 100%
91-
:alt: Application properties page.
92-
93-
.. image:: /_images/spoc/sso-aws2.png
94-
:width: 100%
95-
:alt: Application metadata page.
57+
See :ref:`sp-sso-users`.

sp-oncall/admin/sso/sp-sso-google.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _single-sign-sso-google:
1+
.. _sso-google-spoc:
22

33
************************************************************************
4-
Configure Single Sign-On for Splunk On-Call
4+
Configure Single Sign-On for Splunk On-Call using Google Apps
55
************************************************************************
66

77
.. meta::
@@ -35,9 +35,8 @@ To configure SSO for Splunk On-Call using Google Apps:
3535
:alt: Splunk On-Call SSO Google Apps Setup 5
3636

3737
#. In the :guilabel:`Service Provider Details` step, enter the following values:
38-
- in the :guilabel:`ACS URL` field: :samp:`https://sso.victorops.com:443/sp/ACS.saml2`
39-
- in the :guilabel:`Entity ID` field: :samp:`victorops.com`
40-
- in the :guilabel:`Start URL` field, enter the following with the correct Organization Slug at the end: :samp:`https://portal.victorops.com/auth/sso/<<org-slug-here>>.`
41-
38+
- In the :guilabel:`ACS URL` field: :samp:`https://sso.victorops.com:443/sp/ACS.saml2`
39+
- In the :guilabel:`Entity ID` field: :samp:`victorops.com`
40+
- In the :guilabel:`Start URL` field, enter the following with the correct Organization Slug at the end: :samp:`https://portal.victorops.com/auth/sso/<<org-slug-here>>.`
4241

4342
#. Skip the attribute mapping step and select :guilabel:`Finish`.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
.. _sso-other-spoc:
2+
3+
*****************************************************************************************
4+
Configure Single Sign-On for Splunk On-Call: Other IDPs
5+
*****************************************************************************************
6+
7+
.. _sso-onelogin-spoc:
8+
9+
Configure OneLogin Single Sign-On for Splunk On-Call
10+
=====================================================
11+
12+
If you are configuring SSO for OneLogin, the default relay state is: ``https://portal.victorops.com/auth/sso/<org-slug-here>``
13+
14+
.. _sso-azure-spoc:
15+
16+
Configure Azure Active Directory Single Sign-On for Splunk On-Call
17+
======================================================================
18+
19+
If you are configuring SSO for Azure Active Directory, use the following values:
20+
21+
- Identifier: :samp:`https://victorops.com`
22+
- Reply URL: :samp:`https://sso.victorops.com/sp/ACS.saml2`
23+
- Sign on URL: :samp:`https://portal.victorops.com/auth/sso/<<org-slug-here>>`
24+
- Relay State: :samp:`https://portal.victorops.com/auth/sso/<<org-slug-here>>`
25+
26+
.. _sso-aws-spoc:
27+
28+
Configure AWS IAM Identity Center - SAML Sign-On for Splunk On-Call
29+
======================================================================
30+
31+
If you are configuring SSO for AWS IAM Identity Center:
32+
33+
#. In the IAM Identity Center console find the :guilabel:`Applications` tab.
34+
#. Select :guilabel:`Add Application` and look for VictorOps.
35+
#. In the configuration settings ensure you set the fields as follows:
36+
* :guilabel:`Application start URL`: :samp:`https://portal.victorops.com/auth/sso/ssoconfigtester`
37+
* :guilabel:`Relay state`: :samp:`https://portal.victorops.com/auth/sso/ssoconfigtester`
38+
* :guilabel:`Session duration`: 1 hour
39+
* :guilabel:`Application metadata`: Select :guilabel:`Manually type your metadata values`
40+
* :guilabel:`Application ACS URL`: :samp:`https://sso.victorops.com/sp/ACS.saml2`
41+
* :guilabel:`Application SAML audience`: :samp:`victorops.com`
42+
43+
.. image:: /_images/spoc/sso-aws1.png
44+
:width: 75%
45+
:alt: Application properties page.
46+
47+
.. image:: /_images/spoc/sso-aws2.png
48+
:width: 75%
49+
:alt: Application metadata page.

sp-oncall/admin/sso/sp-sso-users.rst

Lines changed: 42 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -7,94 +7,75 @@ Sign in to Splunk On-Call with SSO
77
.. meta::
88
:description: Signing into Splunk On-Call with SSO, in the Web UI or on mobile.
99

10+
Splunk On-Call user can use this topic for steps to log in to Splunk On-Call with SSO. To enable single sign-on (SSO) for your organization see :ref:`single-sign-sso`.
1011

11-
12-
13-
Requirements
14-
==================
15-
16-
This integration is compatible with the following versions of Splunk On-Call:
17-
18-
- Full-Stack
19-
20-
To enable single sign-on (SSO) for your organization, you will need to provide an updated metadata file and your IDP. If you are
21-
interested in setting up SSO, please contact :ref:`Splunk On-Call Support <spoc-support>`.
22-
23-
24-
25-
Instructions for Users
12+
Obtain your organization slug
2613
===============================
2714

28-
Organization Slug: The phrase "Organization Slug" refers to the slugified version of your organization's name in Splunk On-Call. This process changes your organization name to a lowercase URL-friendly version with no spaces or punctuation, though it may contain dashes. Your Organization Slug can be found at the end of the URL when you are
29-
logged into the Splunk On-Call portal via a web browser.
30-
31-
Contact your Splunk On-Call administrator or reach out to Splunk On-Call Support if you are having trouble finding your Organization Slug.
15+
Your organization has a URL-friendly "organization slug" in Splunk On-Call. Find your organization slug at the end of the URL when you are logged into the Splunk On-Call portal in a web browser. Contact your Splunk On-Call administrator or reach out to Splunk On-Call Support if you are having trouble finding your organization slug.
3216

33-
A user's login experience on the Splunk On-Call platform will be slightly different after enabling Single Sign-On for your organization. If your organization has not explicitly disabled traditional authentication, users will be able to login as normal with their Splunk On-Call credentials or login via SSO. If traditional authentication has been disabled, users will encounter an error message directing them to login via SSO if they attempt to login with their Splunk On-Call credentials.
34-
35-
Web Client UI
36-
=================
37-
38-
The SSO login form can be found at this URL: https://portal.victorops.com/auth/sso
39-
40-
Alternatively, you can create a link or bookmark to skip the typing and bypass the form by appending your company ID to the SSO URL, like this: https://portal.victorops.com/auth/sso/<org-slug-here>
17+
.. _sso-linking:
4118

42-
Either of these routes will direct the user's browser to your identity provider, where they will be required to authenticate and are then sent back to the Splunk On-Call timeline.
19+
First-time SSO log in
20+
========================
4321

44-
Mobile Applications
45-
=========================
22+
If your organization is using SSO you need to complete a one-time linking process between your SSO provider and your Splunk On-Call account. This process creates a link between your external user ID and your Splunk On-Call user ID. If you haven't received an email invitation with the subject “Your invitation to Splunk On-Call”, contact your Splunk On-Call administrator and ask them to send you an invitation.
4623

47-
The Splunk On-Call client for your mobile device will also present a link on the login screen, offering the option to use your SSO credentials.
24+
#. When you receive an email to activate your Splunk On-Call account, create your username and password and complete the account set up process. You will be directed into the Splunk On-Call platform.
25+
#. You need to log out and select :guilabel:`Sign in via SSO”` on the log in page to complete the one-time link process. Verify that you have logged out of Splunk On-Call in every browser you are using and your IDP.
26+
#. You are prompted to :guilabel:`Enter your Org Slug`.
4827

49-
iOS or Android SSO Login
50-
-------------------------
28+
.. image:: /_images/spoc/sso.png
29+
:width: 80%
30+
:alt: Enter your org slug to connect your user ID.
5131

52-
On the login screen, select :guilabel:`Sign in with Enterprise SSO`. This link will take you to a form prompting for your Organization Slug. After you enter your company's Organization Slug, you are redirected to your
53-
IDP login page in a mobile browser. Once you log in through the IDP you are automatically logged into Splunk On-Call.
32+
#. You are redirected to your IDP page where you log in using your SSO credentials.
5433

55-
.. _sso-linking:
34+
.. image:: /_images/spoc/sso-org2.png
35+
:width: 80%
36+
:alt: Log in with your SSO credentials.
5637

57-
First-Time SSO Login
58-
========================
38+
#. Enter your Splunk On-Call username and password. You will only need to enter your Splunk On-Call username and password once.
5939

60-
If your organization is using SSO you will need to do a one-time linking process between your SSO provider and your Splunk On-Call account. This will create a link between your external user ID and your Splunk On-Call user ID. If you have not received an email invitation with the subject “Your invitation to Splunk On-Call”, contact your Splunk On-Call administrator and ask them to send you an invitation.
40+
You are redirected to the Splunk On-Call platform and have finished the one-time SSO linking process.
6141

62-
#. When you receive an email to activate your Splunk On-Call account, create your username and password and complete the account set up process. You will be directed into the Splunk On-Call platform.
63-
#. You need to log out and select :guilabel:`Sign in via SSO”` on the login page to perform the one-time link. Verify that you have logged out of Splunk On-Call in every browser you are using and your IDP.
64-
#. You are prompted to :guilabel:`Enter your Org Slug`.
42+
How to break your SSO linkage
43+
-------------------------------
6544

45+
If you are receiving an error when trying to log in to Splunk On-Call through SSO you may need to break the linkage between your Splunk On-Call username and password and your SSO provider.
6646

67-
.. image:: /_images/spoc/sso.png
68-
:width: 100%
69-
:alt: Enter your org slug to connect your user ID.
47+
To break the linkage, ensure you are signed in to your IDP and then paste the following link into the address bar of your browser: :samp:`https://portal.victorops.com/do-defederation`. If the link between your Splunk On-Call credentials and your SSO provider is successfully broken, you will see the following message.
7048

71-
#. You are redirected to your IDP page where you log in using your SSO credentials.
49+
.. image:: /_images/spoc/sso-org3.png
50+
:width: 80%
51+
:alt: VictorOps broken SSO linkage screen
7252

53+
.. note:: You might have to paste the defederation link into your browser multiple times before the message appears.
7354

74-
.. image:: /_images/spoc/sso-org2.png
75-
:width: 100%
76-
:alt: Log in with your SSO credentials.
7755

78-
#. Enter your Splunk On-Call username and password. You will only need to enter your Splunk On-Call username and password once, and then we will not ask for it again.
56+
To re-associate your Splunk On-Call username and password with your SSO provider, repeat the linking steps in :ref:`sso-linking`.
7957

80-
You are redirected to the Splunk On-Call platform and have finished the one-time SSO linking process.
58+
Your login experience
59+
=========================
8160

61+
Your log in experience on the Splunk On-Call platform is different after enabling Single Sign-On for your organization. If your organization has not explicitly disabled traditional authentication, you will be able to log in as normal with your Splunk On-Call credentials or log in through SSO. If traditional authentication has been disabled, you will see an error message to login through SSO if you attempt to login with your Splunk On-Call credentials.
8262

83-
How to break your SSO linkage
84-
==========================================
63+
Web Client UI
64+
----------------
8565

86-
If you are receiving an error when trying to log into Splunk On-Call through SSO you may need to break the linkage between your Splunk On-Call username and password and your SSO provider.
66+
The SSO log in form can be found at this URL: https://portal.victorops.com/auth/sso
8767

88-
To break the linkage, ensure you are signed in to your IDP and then paste the following link into the address bar of your browser: :samp:`https://portal.victorops.com/do-defederation` . If the link between your Splunk On-Call credentials and your SSO provider is successfully broken, you will see the error, shown below.
68+
Alternatively, you can create a link or bookmark to bypass the SSO form. To do so, append your organization slug to the SSO URL, like this: ``https://portal.victorops.com/auth/sso/<org-slug-here>``
8969

90-
.. note:: You may have to paste the defederation link into your browser multiple times before the below error message will appear.
70+
Either of these routes will direct your browser to your identity provider, where you are required to authenticate and are then sent back to the Splunk On-Call timeline.
9171

72+
Mobile Applications
73+
----------------------
9274

93-
.. image:: /_images/spoc/sso-org3.png
94-
:width: 100%
95-
:alt: VictorOps broken SSO linkage screen
75+
The Splunk On-Call client for your mobile device also presents a link on the log in screen offering the option to use your SSO credentials.
9676

97-
To re-associate your Splunk On-Call username and password with your SSO provider, repeat the linking steps in :ref:`sso-linking`.
77+
iOS or Android SSO log in
78+
-------------------------
9879

99-
If you have any questions or experience any issues, contact Splunk On-Call Support.
80+
On the log in screen, select :guilabel:`Sign in with Enterprise SSO`. This link takes you to a form prompting you for your organization slug. After you enter your company's organization slug, you are redirected to your IDP log-in page in a mobile browser. Once you log in through the IDP you are automatically logged into Splunk On-Call.
10081

sp-oncall/alerts/alerts-main.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ Manage alerts
2323
incident-fields-glossary
2424
maintenance-mode
2525
notification-alert-aggregation
26-
team-dashboard
2726
team-escalation-policy
2827
multiple-escalation-policies
2928
war-room

0 commit comments

Comments
 (0)