REST API Reference

Back Next

Organization management

Use this resource to request the details of your

Informatica Intelligent Cloud Services

organization or a related sub-organization. You can use this resource to update an organization or related sub-organization. You can also delete a sub-organization.

GET Request

To request the details of your organization, use the following URI:

/api/v2/org

To request the details of a sub-organization related to your organization, you can include the sub-organization ID or sub-organization name in the URI. Use one of the following URIs:

/api/v2/org/<sub-organization ID>

/api/v2/org/name/<sub-organization name>

If you use an organization name in the URI and the name includes a space, replace the space with

%20

. For example:

/api/v2/org/name/my%20suborg

GET Response

When you request the details of an organization,

Informatica Intelligent Cloud Services

returns the org object in list format.

If the organization is a parent organization in an organization hierarchy, the org object includes the IDs and names of all sub-organizations.

Returns the error object if errors occurred.

The

org

object includes the following attributes:

Field	Type	Description
id	String	Organization ID.
orgId	String	Organization ID.
name	String	Organization name.
description	String	Description of the organization.
createTime	Date/time	Time the organization was created.
updateTime	Date/time	Last time the organization was updated.
createdBy	String	ser who created the organization.
updatedBy	String	Last user who updated the organization.
parentOrgId	String	Organization ID for the parent organization. Returns 0 if the organization is a stand-alone or parent organization.
address1	String	Address for the organization.
address2	String	Additional address information for the organization.
address3	String	Additional address information for the organization.
city	String	City where the organization is based.
state	String	State where the organization is based. Returns a state code. For more information, see State codes.
zipcode	String	Postal code of the area where the organization is based.
timezone	String	Time zone of the organization. For more information, see Time zone codes.
country	String	Country where the organization is based. Returns a country code. For more information, see Country codes.
employees	String	Range of employees in the organization.
offerCode	String	Offer code assigned to Informatica Intelligent Cloud Services partners.
successEmails	String	Email address to receive notification of tasks that complete successfully.
warningEmails	String	Email address to receive notification of tasks that complete with errors.
errorEmails	String	Email address to receive notification of tasks that fail to complete.
campaignCode	String	Campaign code.
atlasProjectId	String	Atlas project ID.
zuoraAccountId	String	Zuora account ID.
spiUrl	String	This field is no longer applicable and has been deprecated.
devOrg	Boolean	Indicates the organization is a development organization. Returns 1 for a development organization. Returns 0 for a production organization.
maxLogRows	Int	Maximum number of rows to keep in the activity log.
minPasswordLength	Int	Minimum number of characters for a user account password.
minPasswordCharMix	Int	Mix of characters each password must contain. Passwords can contain a mix of the following character sets: lowercase letters, capital letters, numbers, and special characters. Returns one of the following values: 1. Contains at least one of the character sets. 2. Contains at least two of the character sets. 3. Contains at least three of the character sets. 4. Contains all four character sets.
passwordReuseInDays	Int	Number of days until a previous password can be used again. A value of 0 means a password can always be reused.
passwordExpirationInDays	Int	Number of days until a password expires. A value of 0 means a password will never expire.
subOrgLimit	Int	Number of sub-organizations allowed. If the limit has been customized, the REST API returns the custom limit. Otherwise, the REST API returns the limit associated with the edition.
restApiSessionLimit	Int	Number of concurrent REST API sessions allowed. If the limit has been customized, the REST API returns the custom limit. Otherwise, the REST API returns the limit associated with the edition.
parentOrgId	String	Organization ID of the parent organization. 0 indicates the organization is a stand-alone or parent organization.
jobExecUserProfile	String	Informatica Intelligent Cloud Services user account configured to run contact validation tasks.
orgUUID	String	Unique identifier for the organization.
subOrgs		Object that contains information for each sub-organization.
id	String	Included in subOrgs object. ID of the sub-organization.
name	String	Included in subOrgs object. Name of the sub-organization.

POST Request

You can update an

Informatica Intelligent Cloud Services

organization if the user that started the REST API session has the Admin role and belongs to either the organization that you want to update or the parent organization.

You can update a 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.

To update the details of a sub-organization related to your parent organization, use the organization ID in the following URI. To update the details of your organization, omit the optional ID.

/api/v2/org/<id>

When you update an organization through the REST API, the action is a full update. If a field isn't included in the request, the value resets to the default.

You cannot update the organization ID, offer code, or organization administrator user account created with the organization.

With this URI, you can use the following attributes in the

org

object:

Field	Type	Required	Description
name	String	Yes	Organization name.
address	String	Yes	Address of organization.
address2	String		Additional address information for the organization.
address3	String		Additional address information for the organization.
city	String	Yes	City where the organization is based.
state	String	Required when Country is US	State where the organization is based. Use the appropriate state code. Required when Country is set to US. For more information, see Appendix A , State codes.
zipcode	String	Required when Country is US	Postal code of the area where the organization is based. Required when Country is set to US
country	String	Yes	Country where the organization is based. Use the appropriate country code. For more information, see Appendix A , Country codes.
timezone	String		Time zone of the organization. Time zone honors Daylight Saving Time. For more information, see Appendix A , Time zone codes.
description	String		Description of the organization. Maximum length is 255 characters.
successEmails	String		Default email address for notification of successful job completion.
warningEmails	String		Default email addresses for warnings about job completion.
errorEmails	String		Default email address for notification about job failure.
employees	String	Yes	Range 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_"
offerCode	String		Offer code assigned to Informatica Intelligent Cloud Services partners.
passwordReuseInDays	Int		Number of days until a previous password can be used again. Maximum number of days is 730 (2 years). A value of 0 means a password can always be reused.
passwordExpirationInDays	Int		Number of days until the password expires. Maximum number of days is 180. A value of 0 means a password will never expire.

POST Response

If successful, returns the org request object for the organization that you created or updated.

Returns the error object if errors occur.

DELETE Request

You can delete an

Informatica Intelligent Cloud Services

sub-organization if the user that started the REST API session has the Admin role and belongs the parent organization.

To delete an

Informatica Intelligent Cloud Services

organization, use the organization ID with the following URI:

/api/v2/org/<id>

DELETE Response

Returns the 200 response code if the request is successful.

Returns the error object if errors occur.

POST Example

To update a sub-organization with an ID of 02340000, you might use the following request:

POST <serverUrl>/api/v2/org/02340000
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

<org>
  <name>Dev Org</name>
  <address1>333 Main Street</address1>
  <city>City</city>
  <state>MD</state>
  <zipcode>90001</zipcode>
  <country>US</country>  
  <timezone>America/Chicago</timezone>
</org>

A successful request returns the org request object for the sub-organization that you updated.

Organizations

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage