Import SAML Users with Rake Tasks

You can run a rake task to build import SAML user information from a JSON file into Faspex. Faspex also imports entries for existing SAML users and imports updates the users in Faspex with the new values. The rake task follows this syntax:

asctl faspex:rake users:import_saml_users RESOURCE=path/to/json_file_or_url

You must point the rake task to a local file or to a URL referencing a JSON file with the following format:

{"users": [
    { "username": "username", 
    "email": "email_address",
    "given_name": "first_name",
    "saml_configuration_id": saml_config_id },
    ...
]}

Attribute	Description
Username	The Faspex username associated with the SAML user.
Email	The email address associated with the account.
Given Name	The first name associated with the account.
SAML Configuration ID	The ID associated with the SAML configuration. The saml_id specifies the SAML configuration. For example, in the case of multiple SAML configurations, the first configuration is associated with the SAML ID "1", the next configuration "2", and so on. Note: You must first configure the SAML configuration in Faspex to associate the users with the correct SAML IdP through the SAML ID. For more information on configuring a SAML configuration, see Creating a SAML Configuration in Faspex.

An example entry for a user might look like the following:

{ "username": "johndoe", 
  "email": "johndoe@faspex.example.com",
  "given_name": "John",
  "saml_configuration_id": 1 }