SCIM files

You bulk load user data by uploading System for Cross-domain Identity Management (SCIM) files to Cloud Identity Portal.

SCIM files provide a platform-neutral schema for representing users in JSON format. For more information about SCIM, see System for Cross-domain Identity Management. The SCIM file contains an array of operations, each of which represents the creation of a user record. Operations are processed through the Cloud Identity Portal administration REST API. Each successful operation creates a new user record in Cloud Identity Portal. You can create up to 5000 operations per SCIM file, and you can upload as many files as you need. The format and contents of an example SCIM file are shown here.

{
	"operations": [
		{
			"method": "POST",
			"path": "/Users",
			"bulkId": "importtest1",
			"data": {
				"userName": "userimporttest1",
				"active": true,
				"password": "core1234",
				"emails": [{
					"value": "nomail@gmail.com",
					"type": "",
					"primary": "true"
				}],
				"name": {
					"familyName": "import",
					"middleName": "mid",
					"givenName": "ctest1"
				},
				"addresses": [{
					"streetAddress": "123 oak st",
					"locality": "fort worth",
					"region": "texas",
					"postalCode": "77077",
					"country": "USA",
					"type": "home",
					"primary": "true"
				}],
				"title": "title",
				"preferredLanguage": "en-US",
				"userType": "Contractor"
			}
		}, 
			{
			"method": "POST",
			"path": "/Users",
			"bulkId": "importtest1",
			"data": {
				"userName": "userimporttest2",
				"active": true,
				"password": "core1234",
				"emails": [{
					"value": "nomail2@gmail.com",
					"type": "",
					"primary": "true"
				}],
				"name": {
					"familyName": "import",
					"middleName": "mid",
					"givenName": "ctest2"
				},
				"addresses": [{
					"streetAddress": "123 oak st",
					"locality": "fort worth",
					"region": "texas",
					"postalCode": "77077",
					"country": "USA",
					"type": "home",
					"primary": "true"
				}],
				"title": "title",
				"preferredLanguage": "en-US",
				"userType": "Contractor"
			}
		}
	]
}
Table 1. Operation parameters
Parameter Type Required Description
method Yes The operation to be performed by the method. The operation is POST.
path Path Yes Specifies the path to the object to update. The path is /Users.
bulkId String Yes A transaction ID. A response status is associated with each transaction ID.
data Object Yes Contains attributes for the user.
userName String Yes Specifies the user name of the user. The user name must be unique.
active Boolean Yes Specifies whether the user record is an identity or an account. Set to true if you want the user to have a Cloud Identity Service account. Users cannot authenticate to Cloud Identity Service or access Self Service applications without an account. If set to false, the user record is created as an identity and not an account.
password String Optional A password to access Cloud Identity Service and Self Service applications.
emails Object Optional Contains email addresses for the user.
value String Optional A valid email address.
type String Optional Email type, for example personal, office, or social.
primary Boolean Optional Specifies whether the email is the primary email address for the user.
name Object Yes Contains name attributes for the user.
familyName String Yes The surname of the user.
middleName String Optional The middle name of the user.
givenName String Optional The given name of the user.
addresses Object Optional Contains postal addresses for the user.
streetAddress String Optional The site information for a postal address (the street, road, place, or avenue, and the number).
locality String Optional The name of a locality, such as a city, or county.
region String Optional The name of a geographic region, greater than the locality. For example, the full name of a state or province.
postalCode String Optional The codes that are used by the postal service to identify postal service zones.
country String Optional The name of a country.
type String Optional The address type, for example home or office.
primary String Optional Specifies whether the address is the primary address for the user.
title String Optional A personal title for a person, for example Mr, Ms, Dr, Prof, and Rev.
preferredLanguage String Optional The language code for the user. For example, en-us or fr-ca. If not specified, the preferred language set in LDAP is used. If no preferred language is set, then the default language of American English is used.
userType String Optional The name of the type of user, for example Contractor.