Register

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

/api/v2/user/register

To create an Informatica Intelligent Cloud Services sub-organization, use the following URI.

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

String

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

Include in the org object.
Name for the new Informatica Intelligent Cloud Services organization.

address1

String

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.
City where the organization is located.

city

String

Include in the org object.
Additional address information for the organization

state

String

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

Include in the org object.
Country where the organization is located. Use the appropriate country code.
For more information, see Appendix A, Country codes.

country

String

Include in the org object.
Zip code where the organization is located.

timezone

String

Include in the org object.
Time zone of the user. Time zone honors Daylight Saving Time.
For more information, see Appendix A , Time zone codes.

employees

String

Include in the org object.
Time zone of the user. Time zone honors Daylight Saving Time.
For more information, see Appendix A , Time zone codes.

user

String

Include in the user object.
Email address for the organization administrator account.

name

String

Include in the user object.
Password for the organization administrator account.

password

String

Include in the user object.
Last name of the organization administrator.

firstName

String

Include in the user object.
Phone number for the organization administrator.

lastName

String

Include in the user object.
Email address that receives notification from Informatica Intelligent Cloud Services.

title

String

Include in the user object.
Time zone of the organization administrator. Time zone honors Daylight Saving Time.
Use the appropriate time zone code.
For more information, see Appendix A, Time zone codes.
If no valid time zone is passed, Informatica Intelligent Cloud Services uses America/Los_Angeles by default.

phone

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:""

email

Include in the user object.
Answer to the security question

timezone

securityQuestion

String

Include in the user object.
Answer to the security question.

securityAnswer

String

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.

forceChangePassword

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.

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.
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.

firstName

String

First name for the user accoun

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:""

securityAnswer

String

Answer to the security question.

roles

String

Object that contains roles 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.

email

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

Informatica Cloud Application Integration URL for the organization the user belongs to.

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 https://dm-us.informaticacloud.com/ma/api/v2/user/register 
Content-Type: application/json
Accept: application/json
{
    "@type" : "registration",
    "user" : {
        "@type" : "user",
        "name" : "[email protected]",
        "emails" : "[email protected]",
        "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.