Import users for the specified tenant from a comma separated value (CSV) file.

post https://{tenanturl}/v2.0/CSV/importUsers

See https://tools.ietf.org/html/rfc4180, Common Format and MIME Type for Comma-Separated Values (CSV) Files.
The first line in the CSV file must contain the names as the column headers. Use the /CSV/headerNames API to get the list of header names.
Only one CSV import request can be running for the specified tenant.
If the default password is not specified, a random password will be generated and an email is sent with their password.
The maximum file size is 10MB.
When setting a value for the urn:ietf:params:scim:schemas:extension:ibm:2.0:User:linkedAccounts column, the value should be as follows: <externalId>@<realm>
When setting a value for the urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value or urn:ietf:params:scim:schemas:extension:ibm:2.0:User:delegate columns, the value may be specified by name or ID. For example, testuser or 50GSYHD4C3.
Multiple-value attribute values are specified with a '|' delimiter which may be overridden with the optional multiValueDelimiter query parameter.
Attribute values that contain a special character (i.e. comma) must be enclosed in double quotes.

Entitlement required: manageUserGroups (Manage users and groups) or manageAllUserGroups (Synchronize users and groups) or manageUserStandardGroups (Manage users and standard groups), or manageUsers (Manage all users), or manageUsersInStandardGroups (Manage users in standard groups).
Note: You only need one entitlement, but you can have more than one.

Query Params

themeId

string

The identifier of the theme that you want to apply.

notifyType

string

An optional query parameter that denotes the notification type. If not present, the EMAIL notification is used. Specify NONE if no notification to the user is required. If no default password is specified, then the EMAIL notification is used since a random password will be generated.

failOnError

string

An optional query parameter that specifies the maximum number of errors allowed before stopping the import request. A negative value is interpreted as 0. A value of 0 indicates that the import request will not be stopped on error.

multiValueDelimiter

string

An optional query parameter that overrides the multiple-value attribute values delimiter.

Body Params

defaultPassword

string

The default password that is set for the users that are being imported.

description

string

A description for this import request.

file

required

The CSV file to upload

Headers

usershouldnotneedtoresetpassword

string

Defaults to false

If set to true, the user is not required to change the password after login.
Only honored if the user's password is provided.

Responses

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://tenant_url/v2.0/CSV/importUsers \
3
     --header 'accept: application/json' \
4
     --header 'content-type: multipart/form-data' \
5
     --header 'usershouldnotneedtoresetpassword: false'

Choose an example:

application/json

202The request was accepted for processing, but the processing has not been completed.

400The request is invalid.

413The payload is too large.

500An internal server error occurred.