{"id":75707,"date":"2023-05-16T14:19:37","date_gmt":"2023-05-16T18:19:37","guid":{"rendered":"https:\/\/jumpcloud.com\/?post_type=support&#038;p=75707"},"modified":"2024-08-28T12:39:13","modified_gmt":"2024-08-28T16:39:13","slug":"create-custom-user-attributes","status":"publish","type":"support","link":"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes","title":{"rendered":"Create Custom User Attributes"},"content":{"rendered":"\n<p>JumpCloud&#8217;s Custom Attributes enable you to create and store additional data about your users, beyond the standard attributes available for every user. Custom attributes are extensible through the API and can be used with the <a href=\"https:\/\/jumpcloud.com\/support\/integrate-with-Workday\">Workday directory integration<\/a> and SAML Single Sign On (SSO).&nbsp;Custom attributes can also be used to automatically assign users to <a href=\"https:\/\/jumpcloud.com\/support\/configure-dynamic-user-groups\">dynamic user groups<\/a>.<\/p>\n\n\n\n<p>Custom attributes currently aren\u2019t supported for LDAP or RADIUS.&nbsp;<\/p>\n\n\n\n<div class=\"wp-block-cgb-notification-card-wysiwyg notification-card tip\"><div class=\"notification-card-content\"><div class=\"notification-card-icon\"><p><img decoding=\"async\" src=\"\/wp-content\/themes\/jumpcloud\/assets\/images\/gutenberg-blocks\/tip-icon.png\" \/><\/p><\/div><div class=\"notification-card-copy is-type-body-default\"><div><strong class=\"notification-card-type\">Tip:<\/strong> \n<ul>\n<li>You can create custom attributes for user groups, where users who are assigned to the user group inherit the custom attributes. See <a href=\"https:\/\/jumpcloud.com\/support\/group-inherited-user-attributes\">Group Inherited User Attributes<\/a> to learn more.&nbsp;<\/li>\n\n\n\n<li>You can also manage custom user attributes through the JumpCloud API as a modifiable property for System Users. See&nbsp;<a href=\"https:\/\/docs.jumpcloud.com\/api\/index.html\" target=\"_blank\" rel=\"noreferrer noopener\">JumpCloud API documentation<\/a> for more information and examples.<\/li>\n<\/ul>\n <\/div><\/div><\/div><\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"h-creating-and-managing-custom-attributes-in-the-admin-portal\">Creating and Managing Custom Attributes in the Admin Portal<\/h2>\n\n\n\n<p>You can create and manage custom attributes from the Admin Portal and by adding, modifying, deleting, and querying this information through JumpCloud&#8217;s API.&nbsp;<\/p>\n\n\n\n<ol>\n<li>Log in to the <a href=\"https:\/\/console.jumpcloud.com\/\">JumpCloud Admin Portal<\/a>.<\/li>\n\n\n\n<li>Go to&nbsp;<strong>USER MANAGEMENT&nbsp;<\/strong>&gt;&nbsp;<strong>Users<\/strong>.<\/li>\n\n\n\n<li>Click the green&nbsp;<strong>+<\/strong>&nbsp;symbol at the top-left to create a new user, or select an existing user.<\/li>\n\n\n\n<li>From the <strong>Details<\/strong> tab, scroll down to&nbsp;<strong>Custom Attributes<\/strong>.<\/li>\n\n\n\n<li>Click&nbsp;<strong>add new custom attribute<\/strong>:\n<ul>\n<li><strong>Attribute Name<\/strong> &#8211; contains a string defining the attribute\u2019s display name. The name string must be fewer than 32 characters, must be unique, and can only contain letters and numbers, no special characters<\/li>\n\n\n\n<li><strong>Attribute<\/strong>&nbsp;<strong>Value<\/strong> &#8211; contains a string to insert the attribute\u2019s value. The Value string has no character restrictions<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>Click&nbsp;<strong>add new custom attribute<\/strong>&nbsp;to add another custom attribute, or click&nbsp;<strong>Save<\/strong> <strong>User<\/strong>.<\/li>\n<\/ol>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"h-creating-and-managing-attributes-with-the-powershell-module\">Creating and Managing Attributes with the PowerShell Module<\/h2>\n\n\n\n<p>You can use the JumpCloud PowerShell module to create and add attributes to existing users, as well as create new users with custom attributes.<\/p>\n\n\n\n<div class=\"wp-block-cgb-notification-card-wysiwyg notification-card tip\"><div class=\"notification-card-content\"><div class=\"notification-card-icon\"><p><img decoding=\"async\" src=\"\/wp-content\/themes\/jumpcloud\/assets\/images\/gutenberg-blocks\/tip-icon.png\" \/><\/p><\/div><div class=\"notification-card-copy is-type-body-default\"><div><strong class=\"notification-card-type\">Tip:<\/strong> \n<p>Need to install the module? The module can be installed on Mac, Windows, and Linux in a&nbsp;<a href=\"https:\/\/github.com\/TheJumpCloud\/support\/wiki\/Installing-the-JumpCloud-PowerShell-Module\" target=\"_blank\" rel=\"noreferrer noopener\">few quick steps<\/a><em>.<\/em><\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h-to-add-custom-attributes-to-an-existing-user\">To add custom attributes to an existing user<\/h3>\n\n\n\n<p>To add a custom attribute to an existing user, issue the following command:<\/p>\n\n\n\n<div class=\"wp-block-cgb-code-block code-block\"><div class=\"code-block-snippet is-type-body-default\">\n<p>Set-JcUser &#8220;JC_USERNAME&#8221; -NumberOfCustomAttributes 1 -Attribute1_name &#8220;ATTRIBUTE_NAME&#8221; -Attribute1_value &#8220;VALUE&#8221;<\/p>\n<\/div><\/div>\n\n\n\n<p>You can also add multiple attributes to a user by modifying the <kbd>-NumberOfCustomAttributes<\/kbd><code> <\/code>value:<\/p>\n\n\n\n<div class=\"wp-block-cgb-code-block code-block\"><div class=\"code-block-snippet is-type-body-default\">\n<p>Set-JcUser Mr.User -NumberOfCustomAttributes 2 -Attribute1_name &#8220;Prefix1&#8221; -Attribute1_value &#8220;Mr.&#8221; -Attribute2_name &#8220;Prefix2&#8221; -Attribute2_value &#8220;Sir&#8221;<\/p>\n<\/div><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h-to-add-custom-attributes-to-multiple-users\">To add custom attributes to multiple users<\/h3>\n\n\n\n<p>The same PowerShell command can be paired with <kbd>Get-JcUserGroupMember<\/kbd> to update multiple users that are part of a user group. Replace <kbd>Group_Of_Users<\/kbd> with the name of your user group, and replace <kbd>Attribute1_name<\/kbd> and <kbd>Attribute1_value<\/kbd> with the custom attribute information:<\/p>\n\n\n\n<div class=\"wp-block-cgb-code-block code-block\"><div class=\"code-block-snippet is-type-body-default\">\n<p>Get-JcUserGroupMember &#8220;Group_Of_Users&#8221; | Set-JcUser -NumberOfCustomAttributes 1 -Attribute1_name &#8220;ATTRIBUTE_NAME&#8221; -Attribute1_value &#8220;VALUE&#8221;<br><\/p>\n<\/div><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h-to-create-new-users-with-custom-attributes\">To create new users with custom attributes<\/h3>\n\n\n\n<p>To create a new user and add a custom attribute in the same operation, use the following command:<\/p>\n\n\n\n<div class=\"wp-block-cgb-code-block code-block\"><div class=\"code-block-snippet is-type-body-default\">\n<p>New-JCUser -firstname Mr -lastname User -username Mr.User -email mr.user@customattributes.com -NumberOfCustomAttributes 1 -Attribute1_name &#8220;Prefix&#8221; -Attribute1_value &#8220;Mr.&#8221;<\/p>\n<\/div><\/div>\n\n\n\n<p>You can also create users in bulk with custom attributes by using a CSV file and the command <kbd>Update-JCUsersFromCSV<\/kbd>. See the following articles for more information:<\/p>\n\n\n\n<ul>\n<li><a href=\"https:\/\/support.jumpcloud.com\/support\/s\/article\/updating-users-from-a-csv-file-2019-08-21-10-36-47\">Updating Users From a CSV File<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/github.com\/TheJumpCloud\/support\/wiki\/Update-JCUsersFromCSV\">Update JCUsersFromCSV &#8211; GitHub<\/a><\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"h-using-custom-attributes-with-sso-apps\">Using Custom Attributes with SSO Apps<\/h2>\n\n\n\n<p>After adding custom attributes to your users, you can include them within the SAML assertion message when a user connects to SSO applications by adding the <a href=\"https:\/\/jumpcloud.com\/support\/sso-application-connector-fields#attributes\">custom attribute<\/a> to your SSO app connector.<\/p>\n\n\n\n<p>The expected <strong>Service Provider Attribute Name<\/strong> format should be found within your application\u2019s Service Provider documentation.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"h-using-custom-attributes-with-dynamic-user-groups\">Using Custom Attributes with Dynamic User Groups<\/h2>\n\n\n\n<p>When configuring <a href=\"https:\/\/jumpcloud.com\/support\/configure-dynamic-user-groups#configuring-dynamic-user-groups\">dynamic user groups<\/a>, admins can add custom attributes to the group&#8217;s membership conditions. The attribute values must match exactly, including case, with the custom attribute values located in the <strong>Custom Attributes<\/strong> section of the users&#8217; <strong>Details <\/strong>tab. Custom attributes are only available at the user level, not at the group level.<\/p>\n\n\n\n<p>A maximum of five custom attributes can be used.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>JumpCloud&#8217;s Custom Attributes enable you to create and store additional data about your users, beyond the standard attributes available for [&hellip;]<\/p>\n","protected":false},"author":206,"featured_media":0,"template":"","meta":{"_acf_changed":false,"_oasis_is_in_workflow":0,"_oasis_original":0,"_oasis_task_priority":"","inline_featured_image":false,"footnotes":""},"support_category":[2932,2850],"support_tag":[],"coauthors":[2842],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v22.9 (Yoast SEO v22.9) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Create Custom User Attributes - JumpCloud<\/title>\n<meta name=\"description\" content=\"Learn how to create custom user attributes to create and store additional user data.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Create Custom User Attributes\" \/>\n<meta property=\"og:description\" content=\"Learn how to create custom user attributes to create and store additional user data.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes\" \/>\n<meta property=\"og:site_name\" content=\"JumpCloud\" \/>\n<meta property=\"article:modified_time\" content=\"2024-08-28T16:39:13+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2024\/07\/202405-MISC-JumpCloudHelpCenter-SiteDisplay-min-2.png\" \/>\n\t<meta property=\"og:image:width\" content=\"890\" \/>\n\t<meta property=\"og:image:height\" content=\"525\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n\t<meta name=\"twitter:label2\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data2\" content=\"pamkellman\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes\",\"url\":\"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes\",\"name\":\"Create Custom User Attributes - JumpCloud\",\"isPartOf\":{\"@id\":\"https:\/\/jumpcloud.com\/#website\"},\"datePublished\":\"2023-05-16T18:19:37+00:00\",\"dateModified\":\"2024-08-28T16:39:13+00:00\",\"description\":\"Learn how to create custom user attributes to create and store additional user data.\",\"breadcrumb\":{\"@id\":\"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/jumpcloud.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Support\",\"item\":\"https:\/\/jumpcloud.com\/support\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Custom User Attributes\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/jumpcloud.com\/#website\",\"url\":\"https:\/\/jumpcloud.com\/\",\"name\":\"JumpCloud\",\"description\":\"Daily insights on directory services, IAM, LDAP, identity security, SSO, system management (Mac, Windows, Linux), networking, and the cloud.\",\"publisher\":{\"@id\":\"https:\/\/jumpcloud.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/jumpcloud.com\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/jumpcloud.com\/#organization\",\"name\":\"JumpCloud\",\"url\":\"https:\/\/jumpcloud.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png\",\"contentUrl\":\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png\",\"width\":598,\"height\":101,\"caption\":\"JumpCloud\"},\"image\":{\"@id\":\"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Create Custom User Attributes - JumpCloud","description":"Learn how to create custom user attributes to create and store additional user data.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes","og_locale":"en_US","og_type":"article","og_title":"Create Custom User Attributes","og_description":"Learn how to create custom user attributes to create and store additional user data.","og_url":"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes","og_site_name":"JumpCloud","article_modified_time":"2024-08-28T16:39:13+00:00","og_image":[{"width":890,"height":525,"url":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2024\/07\/202405-MISC-JumpCloudHelpCenter-SiteDisplay-min-2.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes","Written by":"pamkellman"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes","url":"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes","name":"Create Custom User Attributes - JumpCloud","isPartOf":{"@id":"https:\/\/jumpcloud.com\/#website"},"datePublished":"2023-05-16T18:19:37+00:00","dateModified":"2024-08-28T16:39:13+00:00","description":"Learn how to create custom user attributes to create and store additional user data.","breadcrumb":{"@id":"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/jumpcloud.com\/support\/create-custom-user-attributes"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/jumpcloud.com\/support\/create-custom-user-attributes#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/jumpcloud.com\/"},{"@type":"ListItem","position":2,"name":"Support","item":"https:\/\/jumpcloud.com\/support"},{"@type":"ListItem","position":3,"name":"Create Custom User Attributes"}]},{"@type":"WebSite","@id":"https:\/\/jumpcloud.com\/#website","url":"https:\/\/jumpcloud.com\/","name":"JumpCloud","description":"Daily insights on directory services, IAM, LDAP, identity security, SSO, system management (Mac, Windows, Linux), networking, and the cloud.","publisher":{"@id":"https:\/\/jumpcloud.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/jumpcloud.com\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/jumpcloud.com\/#organization","name":"JumpCloud","url":"https:\/\/jumpcloud.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/","url":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png","contentUrl":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png","width":598,"height":101,"caption":"JumpCloud"},"image":{"@id":"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/75707"}],"collection":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support"}],"about":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/types\/support"}],"author":[{"embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/users\/206"}],"version-history":[{"count":3,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/75707\/revisions"}],"predecessor-version":[{"id":115094,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/75707\/revisions\/115094"}],"wp:attachment":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/media?parent=75707"}],"wp:term":[{"taxonomy":"support_category","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support_category?post=75707"},{"taxonomy":"support_tag","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support_tag?post=75707"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/coauthors?post=75707"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}