SAML Attribute Guide

Use this workbook to define user-friendly names for data items used in the Security Assertion Markup Language (SAML) single sign-on feature for student self-service.

Workbook Description

The file name for this workbook is SAML_ATTRIBUTE.csv.

Configuration Workbooks are delivered in the form of Excel spreadsheets. In these spreadsheets, every configurable field is represented as a spreadsheet column and there are as many spreadsheet rows as needed for that particular configuration. Here are the column descriptions:

• Field Name.
• Column: Spreadsheet column associated with the field.
• Required?: Denote if you're required to populate the field or not.
• Field Type and Accepted Values:
  • String: These are usually alphanumeric.
  • Integer: Numeric, a whole number.
  • Double: Numeric with places to the right of the decimal.
  • Enumeration: List of values.
  • Boolean: True or False, Yes or No.
  • Groovy script: A logical query using groovy script.
  • Date: yyyy-mm-dd format.
• Description.

Field Name	Column	Required	Field Type and Accepted Values	Description
Data_Item	A	Y	String Alphanumeric ASCII text, up to 255 characters. Example Values: First Name Last Name	Fixed list of SAML Assertion attributes.
SAML_Atribute_Name	B	Y	String Alphanumeric ASCII text, up to 255 characters. Example Values: FirstName LastName	Customer defined SAML attribute name

Enable the Configuration in the UI

You do not have to complete any setup in the user interface to enable this configuration.

Required Permissions

You must have a role with this General Permission through Roles Management to enable and view the configuration in the UI: Administration.

See Set General Permissions Matrix.

Configuration in the User Interface

The configuration is visible in the Student Service User Interface for users with an Admin role.

1. Navigate to Settings > SAML Attribute Name Mapping.

2. Select the data item to modify.

3. Enter an Attribute Name or Friendly Name and click Save.