Importing users

To create multiple users in Maximo® Application Suite, use the template file to import new users and ensure that the format for the user information adheres to the import processing rules. After you import users, you can also use the template file to modify user information and delete users.

You can download the .csv template from the Suite administration user interface.
  1. In the Suite administration, select Users and then click the Import users icon.
  2. Download the .csv template.
  3. Enter users details.
  4. In the Import users, import the file.
  5. To modify user information or delete users, you can update the file and import the changes.

The following information describes the column names and values that you provide in the .csv template for each user. Each column corresponds to a field entry in the user record.

Identity

The following information describes the values that you specify to import the user's identity details.
id

The user ID is the internal identification for the user and is a required field. The default maximum length is 100 alphanumeric characters.

After the user record is created, this ID cannot be changed.

username

The username is the name that the user types to log in and is a required field. The default maximum length is 100 uppercase alphabetic characters.

The username can be the same as the user ID. The username can be changed.

displayName
The display name that is shown when the user is logged in. This field is a required field.

The default maximum length is 82 alphanumeric characters.

givenName
The given name of the user. The default maximum length is 30 alphanumeric characters.
familyName
The surname of the user. The default maximum length is 50 alphanumeric characters.
title
The title of the user, such as Mr. or Ms.

Password and authentication

The following information describes the values that you specify to import the user's password and authentication details.
generatePassword

Enter either TRUE or FALSE.

Enter TRUE to automatically generate a password. You can generate passwords only for new users. Passwords cannot be generated for current users.

sendPasswordToEmail

Enter either TRUE or FALSE.

Enter TRUE to email the password credentials to the user after the user record is created.

password
Enter NONE or specify a custom password.

If generatePassword is TRUE, then enter NONE for password. Otherwise, enter a custom password.

forcePasswordChange

Enter either TRUE or FALSE.

Enter TRUE if you want users to change their password during their first login.

issuer

The issuer is the authentication type and is a required field.

Enter local, ldap, or saml.

Starting in Maximo Application Suite 8.11, the issuer field is deprecated. For 8.11 and later versions, use the Identities field.

User entitlement and application access

The following information describes the values that you can specify to import the user's entitlement and application access details.
permissions__systemAdmin

Enter either TRUE or FALSE. This field is a required field.

Enter TRUE if the user needs system configuration permissions. A user with system configuration access has administrative privileges for the core Maximo Application Suite settings and can deploy applications, update configurations, and manage license files.

permissions__userAdmin

Enter either TRUE or FALSE. This field is a required field.

Enter TRUE if the user needs user management permissions. A user with user management access can create and manage users and assign entitlements and access levels.

entitlement__application
Enter one of the following values:
  • NONE
  • SELF_SERVICE
  • LIMITED
  • BASE
  • PREMIUM
This field is a required field.

If the user needs access to applications, specify the application entitlement for the user. For more information, see Application entitlement and roles

entitlement__admin
Enter one of the following values:
  • NONE
  • BASE
  • PREMIUM
This field is a required field.

Specify the administrator entitlement for the user. For more information, see Administration entitlement and access.

authorizedUser

Enter either TRUE or FALSE.

Enter TRUE if the user needs authorized access. AppPoints are permanently reserved for authorized users, so they can log in to Maximo Application Suite at any time.

Users who have administrator entitlement, such as BASE or PREMUIM in the entitlement__admin column, can be granted authorized access.

For more information, see Access type.

workspaceId

Specify the name of the workspace that you are adding the user to.

appId
Specify the name of the application that the user needs access to:
  • manage
  • monitor
  • health
  • visual inspections
  • assist
  • predict

If the user needs access to multiple applications, create another row and specify the value for the application.

appId__access

Enter either ADMIN, USER, or MANAGEUSER.

To give users administrator access to an application, specify ADMIN. A user needs an administration entitlement of BASE or PREMUIM in the entitlement__admin column to be granted the administrator role.

To give users regular user access rights to an application, specify USER.

To give users access to Maximo Manage, specify MANAGEUSER.

Contact information

The following information describes the values to import the user's contact information.
emails__value

The user's email address. The default maximum length is 100 alphanumeric characters.

emails__type
Indicates whether the email address is a work or home email address. Enter either HOME or WORK.
emails__primary

Enter either TRUE or FALSE. This field is a required field.

If the email address is the main address to contact the user, specify TRUE. If the users information includes multiple email addresses, one email address must be set to TRUE.

phoneNumbers__value
The user's phone number. The default maximum length is 20 alphanumeric characters.
phoneNumbers__type
Enter either WORK or MOBILE.
phoneNumbers__primary
Enter either TRUE or FALSE.

If the phone number is the main number to contact the user, specify TRUE. If the users information includes multiple phone numbers, one phone number must be set to TRUE.

addresses__streetAddress
The street address. The default maximum length is 169 alphanumeric characters.
addresses__locality
The name of the city. The default maximum length is 36 alphanumeric characters.
addresses__region
The name of the region. The default maximum length is 36 alphanumeric characters.
addresses__postalCode
The postcode. The default maximum length is 12 alphanumeric characters.
addresses__country
The country. The default maximum length is 36 alphanumeric characters.
addresses__primary
Enter either TRUE or FALSE.

If the address is the main address of the user, specify TRUE.

Account status information

The following information describes the values that you can specify to import the user's account status information.
status__active
Enter either TRUE or FALSE.

Enter TRUE to activate or FALSE to deactivate the user account.

status__activationUpdateReason
Enter in plain text that explains why the user account status is updated. The maximum is 512 characters, which include spaces.
status__expiresAt
Specify the date in YYYY-MM-DD format that the account is automatically deactivated.
status__inactivityTimeout
Specify the duration after which if the user does not log in, the account is automatically deactivated.

Enter alphanumeric text in the following format:
P[n]DT[n]H[n]M[n]S
or
P[n]W

For example, P4DT12H30M5S represents a duration of four days, twelve hours, thirty minutes, and five seconds.

Identities for seamless user authentication

Starting in 8.11, the following information describes the values that you specify to import identities for seamless user authentication.
local_user
Indicates that the user account is local within the system. This field is a required field.

Enter either TRUE or FALSE. Ensure that you use accurate values in the field.

identities_saml

The particular Security Assertion Markup Language (SAML) authentication configuration to use for the respective user.

Enter default-saml.

If this authentication is not required, leave this field empty or enter NONE.

identities_saml_id

The critical linkage between the user's system ID and their SAML-based login credentials.

Enter <user SAML ID>.saml

Use the specific SAML ID that is assigned to a user, for example Jsmith.saml.

identities_ldap

The type of Lightweight Directory Access Protocol (LDAP) authentication that is used for the user.

Enter default-ldap.

If this authentication is not required, leave this field empty or enter NONE.

Note: Maximo Application Suite supports LDAP as the default configuration.
identities_ldap_id

The bridge between the user's system identity and their LDAP-based login credentials.

Enter <user LDAP ID>.ldap.

Use the specific LDAP ID that is assigned to a user, for example Jsmith.ldap.

User deletion

If you need to delete users from Maximo Application Suite, specify TRUE in the delete column. The user record is removed from the Maximo Application Suite user registry. When you are adding users, specify FALSE.

Troubleshooting

If the import process has errors, you can download the processed file. The processed file provides the data that was not imported and includes an error message that explains the problem. For example, if an error is related to the issuer field, the following message is shown: 
Failed validating field: enum, reason: 'SAML' is not one of ['local', 'ldap', 'saml']
Fix the error and upload the file again.

If you cannot download the error file, check the importuser pod in the Maximo Application Suite core namespace.

If the importuser pod is not created or if the process does not start or shows a generic error, check the coreapi pod in the Maximo Application Suite core namespace.