Difference between revisions of "Single Sign-On (SSO)"
IVSWikiBlue (talk | contribs) |
IVSWikiBlue (talk | contribs) |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 16: | Line 16: | ||
{{Aside - Helpful | content = As of VALT 6, the metadata file from the IdP will be required for configuring SSO.}} | {{Aside - Helpful | content = As of VALT 6, the metadata file from the IdP will be required for configuring SSO.}} | ||
<dl> | <dl> | ||
| + | <dt>Account Name Attribute</dt> | ||
| + | <dd class="singleLineHeight">This refers to the attribute that the IdP will send VALT for the account username.</dd> | ||
| + | <dd class="singleLineHeight"><em>This must be a unique identitfier.</em></dd> | ||
| + | {{Aside - Warning | hue = 50 | content = If users already have accounts in VALT, please ensure the IdP can pass an attribute that matches the existing username.}} | ||
<dt>Identity Provider (IdP) URL</dt> | <dt>Identity Provider (IdP) URL</dt> | ||
<dd class="singleLineHeight">This refers to the service or application that manages and authenticates user identities, which VALT will use to verify login credentials.</dd> | <dd class="singleLineHeight">This refers to the service or application that manages and authenticates user identities, which VALT will use to verify login credentials.</dd> | ||
| Line 23: | Line 27: | ||
<dd class="singleLineHeight">This URL leads to the IdP's logout page, where users can safely end their sessions, ensuring a secure sign-out process from VALT.</dd> | <dd class="singleLineHeight">This URL leads to the IdP's logout page, where users can safely end their sessions, ensuring a secure sign-out process from VALT.</dd> | ||
<dt>Certificate in .cer format</dt> | <dt>Certificate in .cer format</dt> | ||
| − | <dd class="singleLineHeight">VALT requires a digital certificate in .cer format from the | + | <dd class="singleLineHeight">VALT requires a digital certificate in .cer format from the IdP to establish a secure, encrypted communication channel.</dd> |
</dl> | </dl> | ||
| Line 36: | Line 40: | ||
<dl> | <dl> | ||
<dt>Name</dt> | <dt>Name</dt> | ||
| − | <dd class="singleLineHeight"> | + | <dd class="singleLineHeight">Arbitrary descriptive name for the mapping rule.</dd> |
<dd><em>Used only in this section of VALT.</em></dd> | <dd><em>Used only in this section of VALT.</em></dd> | ||
<dt>Attribute</dt> | <dt>Attribute</dt> | ||
| − | <dd class="singleLineHeight"> | + | <dd class="singleLineHeight">FriendyName of the attribute being sent from the IdP for group information.</dd> |
<dt>User Value<dt> | <dt>User Value<dt> | ||
| − | <dd class="singleLineHeight">The value of the | + | <dd class="singleLineHeight">The value of the attribute that we will use to map users to a particular group.</dd> |
<dt>Group to Add</dt> | <dt>Group to Add</dt> | ||
| − | <dd class="singleLineHeight">The group | + | <dd class="singleLineHeight">The VALT group that the user will be placed in when there is a match for the "User Value" field.</dd> |
</dl> | </dl> | ||
| Line 56: | Line 60: | ||
<dd class="singleLineHeight">This specifies the user attribute (such as username or email) that VALT displays within the application.</dd> | <dd class="singleLineHeight">This specifies the user attribute (such as username or email) that VALT displays within the application.</dd> | ||
<dd class="singleLineHeight"><em>Helpful when people are not easy to recognize by the username field</em>.</dd> | <dd class="singleLineHeight"><em>Helpful when people are not easy to recognize by the username field</em>.</dd> | ||
| − | <dt> | + | <dt>PIN</dt> |
<dd class="singleLineHeight">This specifies the code used for authentication into [[BEAM]].</dd> | <dd class="singleLineHeight">This specifies the code used for authentication into [[BEAM]].</dd> | ||
<dd class="singleLineHeight"><em>Without one set, no pin is needed to enter BEAM</em>.</dd> | <dd class="singleLineHeight"><em>Without one set, no pin is needed to enter BEAM</em>.</dd> | ||
| Line 84: | Line 88: | ||
<dd class="singleLineHeight">false</dd> | <dd class="singleLineHeight">false</dd> | ||
</dl> | </dl> | ||
| + | |||
| + | {{hr}} | ||
| + | |||
| + | [[VALT SSO| ⤺ Back to VALT SSO Main Page]] | ||
}} | }} | ||
Latest revision as of 10:48, 6 November 2024
SSO Configuration
⚠VALT is compatible with SAML 2.0.
✎To access SSO on your system, you may need to reach out to our support team. IVS Support
The Basics
Before configuring SSO in VALT, please make sure you've completed our SSO Check List.
You can also schedule a SSO Discovery at our booking site under Schedule a Support Session. There, we will discuss the prerequisites for configuring your VALT server to utilize SSO Authentication.
Required Information from IdP
🕮As of VALT 6, the metadata file from the IdP will be required for configuring SSO.
- Account Name Attribute
- This refers to the attribute that the IdP will send VALT for the account username.
- This must be a unique identitfier.
- Identity Provider (IdP) URL
- This refers to the service or application that manages and authenticates user identities, which VALT will use to verify login credentials.
- Remote Sign-In URL
- This is the URL provided by the IdP where users are redirected to initiate the login process.
- Remote Sign-Out URL
- This URL leads to the IdP's logout page, where users can safely end their sessions, ensuring a secure sign-out process from VALT.
- Certificate in .cer format
- VALT requires a digital certificate in .cer format from the IdP to establish a secure, encrypted communication channel.
⚠If users already have accounts in VALT, please ensure the IdP can pass an attribute that matches the existing username.
User Mapping
User mapping is used to map users to groups. This mapping is done through the attributes and values being passed from the IdP. VALT's SSO uses a 1:1 mapping for groups.
Required
- Name
- Arbitrary descriptive name for the mapping rule.
- Used only in this section of VALT.
- Attribute
- FriendyName of the attribute being sent from the IdP for group information.
- User Value
- The value of the attribute that we will use to map users to a particular group.
- Group to Add
- The VALT group that the user will be placed in when there is a match for the "User Value" field.
Optional Items
VALT is also able to map custom attributes to some of the following fields for a user. Below are the user account fields that can be assigned through SSO.
- Display Name Attribute
- This specifies the user attribute (such as username or email) that VALT displays within the application.
- Helpful when people are not easy to recognize by the username field.
- PIN
- This specifies the code used for authentication into BEAM.
- Without one set, no pin is needed to enter BEAM.
- Card Number
- This specifies the card number associated with a user.
- Only applies to customers with VALT Card Reader.
- The users email can also be pulled into the system.
- If the VALT application is not connected to mail server, this field is not used for anything.
Additional Settings
Shibboleth needs the following settings configured to function with VALT.
- signAssertions:
- true
- signResponses:
- true
- encryptNameIDs:
- true
- encryptAssertions:
- false
⤺ Back to VALT SSO Main Page
