REST API Reference

Back Next

Creating sub-organizations

Use this resource to create an

Informatica Intelligent Cloud Services

sub-organization. For

Informatica Intelligent Cloud Services

partners only.

You can create an

Informatica Intelligent Cloud Services

sub-organization if your organization has the appropriate license and if the user that started the REST API session has the Admin role in the parent organization.

register POST Request

To create an

Informatica Intelligent Cloud Services

sub-organization, use the following URI.

/api/v2/user/register

Use the session ID from the login response in the request header. Use the serverUrl from the login response as the base URL.

You can use the following attributes in a registration object:

Field	Type	Required	Description
org			Attribute that defines an Informatica Intelligent Cloud Services organization.
offerCode	String		Include in the org object. Offer code assigned to Informatica Intelligent Cloud Services partners.
name	String	Yes	Include in the org object. Name for the new Informatica Intelligent Cloud Services organization.
address1	String	Yes	Include in the org object. Address where the organization is located.
address2	String		Include in the org object. Additional address information for the organization.
address3	String		Include in the org object. Additional address information for the organization.
city	String	Yes	Include in the org object. City where the organization is located.
state	String	Yes	Include in the org object. State where the organization is located. Use the appropriate state code. Required for the United States. For more information, see Appendix A, State codes.
zipcode	String	Yes	Include in the org object. Postal code where the organization is located.
country	String	Yes	Include in the org object. Country where the organization is located. Use the appropriate country code. For more information, see Appendix A, Country codes.
timezone	String		Include in the org object. Informatica Intelligent Cloud Services uses America/Los_Angeles as the default time zone. After you create the sub-organization, you can use the org resource to change the time zone or you can change the time zone in Administrator .
employees	String	Yes	Include in the org object. Number of employees in the organization. Use one of the following ranges: "0_10" "11_25" "26_50" "51_100" "101_500" "501_1000" "1001_5000" "5001_"
user			Attribute that defines the organization administrator user account.
name	String	Yes	Include in the user object. Email address for the organization administrator account.
password	String	Yes	Include in the user object. Password for the organization administrator account.
firstName	String	Yes	Include in the user object. First name of the organization administrator.
lastName	String	Yes	Include in the user object. Last name of the organization administrator.
title	String	Yes	Include in the user object. Title of the organization administrator.
phone	String	Yes	Include in the user object. Phone number for the organization administrator.
emails	String	Yes	Include in the user object. Email address that receives notification from Informatica Intelligent Cloud Services .
timezone	String		Include in the user object. Time zone of the organization administrator. Informatica Intelligent Cloud Services uses America/Los_Angeles as the default time zone. After you create the sub-organization, you can use the org resource to change the time zone or you can change the time zone in Administrator .
securityQuestion	String		Include in the user object. Security question. Use one of the following codes to select the security question: SPOUSE_MEETING_CITY FIRST_JOB_CITY CHILDHOOD_FRIEND MOTHER_MAIDEN_NAME PET_NAME CHILDHOOD_NICKNAME CUSTOM_QUESTION:"<question>"
securityAnswer	String		Include in the user object. Answer to the security question.
forceChangePassword	Boolean		Include in the user object. Determines if the user must reset the password after the user logs in for the first time. Includes the following values: True. The user must reset the password. False. The user is not forced to reset the password.
optOutOfEmails	Boolean		Include in the user object. Whether the user opts in or out of receiving marketing communication from Informatica. TRUE indicates that the user does not want to receive marketing communication.
registrationCode	String		Registration code.
sendEmail	Boolean		When registration completes, sends an email to the user email address with temporary login information. Use TRUE to send an email.

POST Response

Returns the user object if the request is successful. Returns the error object if errors occur.

The user object includes the following attributes.

Field	Type	Description
id	String	User ID.
orgId	String	ID of the organization the user belongs to. 22 characters. Organizations that were created in legacy Informatica Cloud might have an organization ID of 6 characters.
orgUuid	String	Unique identifier for the organization.
name	String	Informatica Intelligent Cloud Services user name.
description	String	Description of the user.
createTime	String	When the user account was created.
updateTime	String	When the user account was last updated
createdBy	String	Informatica Intelligent Cloud Services user who created the user account.
updatedBy	String	Informatica Intelligent Cloud Services user who last updated the user account.
sfUsername	String	Salesforce user name. Included when user is configured to authenticate through Salesforce.
password	String	Salesforce user password. Included when user is configured to authenticate through Salesforce.
firstName	String	First name for the user account.
lastName	String	Last name for the user account.
title	String	Title of the user.
phone	String	Phone number for the user.
securityQuestion	String	Security question. Returns one of the following codes: SPOUSE_MEETING_CITY FIRST_JOB_CITY CHILDHOOD_FRIEND MOTHER_MAIDEN_NAME PET_NAME CHILDHOOD_NICKNAME CUSTOM_QUESTION:"<question>"
securityAnswer	String	Answer to the security question.
roles		Object that includes a role object for each role assigned to the user.
name	String	Included in role object. Role name. Returns one of the following codes: Service Consumer Designer Admin
description	String	Included in role object. Role description.
emails	String	Email address to be notified when the user changes the account password.
timezone	String	Time zone of the user. Time zone honors Daylight Saving Time. For more information, see Time zone codes.
serverUrl	String	Informatica Intelligent Cloud Services URL for the organization the user belongs to. Use the serverUrl as a base for most version 2 REST API resource URIs.
spiUrl	String	This field is no longer applicable and has been deprecated.
uuId	String	Unique identifier for the user.
icSessionId	String	Informatica Intelligent Cloud Services session ID for version 2 REST API session. Use in most version 2 REST API request headers.
forceChangePassword	Boolean	Determines if the user must reset the password after the user logs in for the first time. Includes the following values: True. The user must reset the password. False. The user is not forced to reset the password.

POST Examples

To register an organization in JSON, you might use the following request:

POST <serverUrl>/api/v2/user/register 
Content-Type: application/json
Accept: application/json
{
    "@type" : "registration",
    "user" : {
        "@type" : "user",
        "name" : "useremail@company.com",
        "emails" : "useremail@company.com",
        "firstName" : "firstName",
        "lastName" : "lastName",
        "title" : "jobTitle",
        "phone" : "(0)1234 567 890",
        "timezone" : null,
        "forceChangePassword" : "true"
        "optOutOfEmails" : "true"
    },
    "org" : {
        "@type" : "org",
        "offerCode" : "PPC30daytrial", 
        "campaignCode" : "PPC",
        "name" : "myOrg",
        "address1" : "1 Main St",
        "city" : "Mycity",
        "state" : "CA",
        "zipcode" : "90210",
        "country" : "US",
        "employees" : "5001_"
    },
    "registrationCode" : "ics-standard", 
    "sendEmail" : true
}

A successful request returns the user object that was created, which includes the organization ID for the organization that was created.

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Creating sub-organizations

Creating sub-organizations

register POST Request

POST Response

POST Examples