[Notification] We're upgrading the JumpCloud Support Center the week of September 30th.

Support Center

Configuring User Attributes for SAML Connectors

This KB provides you with the information you need to successfully configure user attributes for SAML connectors. 

This KB Includes:

Configuring User Attributes 

To start configuring user attributes:

  1. Log in to the JumpCloud Admin Portal: https://console.jumpcloud.com.
  2. Go to Applications.
  3. Click ( + ) to configure a new application.
  4. Search for the application you want to connect to JumpCloud.
  5. Click configure to the right of the application’s name. 
  6. Click add attribute to add an attribute. To remove an attribute, click ( - ). 

You can include attributes for standard user detail attributes or for custom attributes. For example, you can include standard attributes for users’ employee ID and department, or you can include a custom attribute for users’ application ID. Standard attributes are configured in the User Panel Details tab's User Information and Employee Information sections. To learn how to configure user attributes and custom user attributes see User Attributes. Custom attributes are configured in the User Panel Details tab's Custom Attributes section. See Custom User Attributes.

For user attributes, the Name of the attribute is the service provider’s name of the attribute, such as surName. The Value of the user attribute is the name of the coinciding attribute that JumpCloud includes in assertions, such as lastname.

For custom user attributes, the value is the name you give the custom attribute in JumpCloud.

User Attributes That May Be Supported by SAML Connectors

Attribute Name Attribute appears on the following User Panel Details tab for a user in the UI
email User Information
username User Information
firstname User Information
middlename User Information
lastname User Information
displayname User Information
fullname

When this attribute is included in the SAML connector, JumpCloud sends users’ firstname and lastname as a single attribute in assertions.

This attribute is not found on a User Details tab.

company Employment Information
costCenter Employment Information
department Employment Information
employeeIdentifier Employment Information
employeeType Employment Information
jobTitle Employment Information
location Employment Information
addresses Employment Information, Personal Employee Information
See Adding Collections of User Attributes.
phoneNumbers Employment Information, Personal Employee Information
See Adding Collections of User Attributes.


Adding Collections of User Attributes

You can add collections of user attributes for attributes that have more than one type. The following attributes have more than one type:

  • phone numbers
  • addresses

Phone Number Attributes

Phone number attributes have the following types:

  • work
  • work_mobile
  • work_fax
  • home
  • mobile

The Name of the attribute is the service provider’s name of the phone number attribute, such as mobilePhone. The Value of the phone number attributes is the name of the coinciding attribute that JumpCloud includes in assertions, such as phoneNumbers.mobile.




In the UI you can only create attributes for the previously listed types. However, in the API you can include any type with a maximum character length of 1024. For example, phoneNumbers.beach_house_phone.

Address Attributes

Address attributes have multiple types and components. 

Address attributes have the following types:

  • home
  • work

Address attributes have the following components:

  • poBox
  • extendedAddress
  • streetAddress
  • locality - component for city
  • region - component for state
  • postalCode - component for postal / zip code
  • country

The Name of the attribute is the service provider’s name of the address attribute, such as workCountry. The Value of the phone number attributes is the name of the coinciding attribute that JumpCloud includes in assertions, such as addresses.work.country.

In the UI you can only create attributes for the previously listed types. However, in the API you can include any type with a maximum character length of 1024. For example, addresses.beach_house.

 

Last Updated: Aug 19, 2019 02:27PM MDT

Related Articles
desk-forwarding@jumpcloud.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete