Enterprise Data Catalog REST API Reference > Data Provision APIs > Data Provision REST APIs
  

Data Provision REST APIs

You can use the following Data Provision REST APIs to list, create, and delete data provisioning actions:
Data Provision REST API
Description
GET provision/connections
Lists the connections configured in an Informatica Intelligent Cloud Services organization
GET provision/connections/{id}
Lists the connections configured in an Informatica Intelligent Cloud Services organization for a connection ID
POST provision/connections/{id}/test
Creates a test connection
GET provision/connections/config
Lists the connection configuration option for all the supported types
GET provision/connections/config/{type}
Lists the connection configuration options for a supported type
GET provision/info
Lists whether data provisioning is available to user
GET provision/preview
Lists the preview data of a data object
GET provision/provisionableResources
Lists the resources that support data provisioning
GET provision/resources
Lists all the resources with connection details
GET provision/resources/{resourceName}
Lists the connections configured for a resource
PUT provision/resources/{resourceName}
Creates or updates the connection configuration for a resource
DELETE provision/resources/{resourceName}
Deletes the connection for a resource
GET provision/task
Lists all provisioning tasks
POST provision/task
Submits a provisioning task
GET provision/task/{id}
Lists the provisioning tasks for a task ID
DELETE provision/task/{id}
Deletes a provisioning task
GET provision/users
Lists the list of configured Informatica Intelligent Cloud Services users in the enterprise
PUT provision/users
Configures or updates the credentials of all the Informatica Intelligent Cloud Services users
PUT provision/users/{id}
Configures or updates the credentials of an Informatica Intelligent Cloud Services user
DELETE provision/users/{id}
Deletes an Informatica Intelligent Cloud Services user
POST provision/users/validate
Validates and returns the Informatica Intelligent Cloud Services user details

List Configured Connections

/provision/connections
API to list all the configured connections in Informatica Intelligent Cloud Services.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/connections
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
icsUsername
Required
The user name to log in to Informatica Intelligent Cloud Services.
Query
String
runTimeEnvId
Optional
The runtime environment ID to filter the connections.
Query
String
connType
Optional
Choose one of the following supported Informatica Intelligent Cloud Services connection types to filter the connections:
  • - Oracle
  • - SqlServer
  • - Amazon S3
  • - Tableau Online
Query
String

Response Codes

Code
Reason
200
Listed Informatica Intelligent Cloud Service connections.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/connections?icsUsername=testuser1" -H "accept: application/json"

List the Configured Connection for a Connection ID

/provision/connections/{id}
API to list the configured connection in Informatica Intelligent Cloud Services for a connection ID.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog//provision/connections/{id}
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
icsUsername
Required
The user name to log in to Informatica Intelligent Cloud Services.
Query
String
id
Required
The ID of the connection.
Path
String

Response Codes

Code
Reason
200
Listed Informatica Intelligent Cloud Services connections.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/connections/01100C?icsUsername=testuser1" -H "accept: application/json"

Validate a Test Connection

/provision/connections/{id}/test
API to validate a test connection for a connection ID in Enterprise Data Catalog.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/connections/{id}/test
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the connection.
Path
String
testRequest
Required
Enter the connection attributes.
Body
-

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
Values
configOptions
Optional
Configuration options for a connection.
-
Enter the following configuration options:
  • - defaultValue
  • - description
  • - id
  • - isEditable
  • - isRequired
  • - isRuntimeAttr
  • - isSensitive
  • - label
  • - supportedValues
  • - value
href
Optional
The link to the resource.
String
-
id
Required
The connection ID.
isAppendable
Optional
Allowed to create append target. Default is false.
Boolean
isCreatable
Optional
Allowed to create a target. Default is false.
Boolean
name
Optional
The name of the connection.
String
-
orgId
Optional
The ID of the organization.
String
-
runtimeEnvironmentId
Optional
The runtime environment used by the connection.
String
-
type
Optional
Enter one of the following connection types:
  • - Oracle
  • - SqlServer
  • - Amazon S3
  • - Tableau Online
String
-
icsUsername
Required
The user name to log in to Informatica Intelligent Cloud Services.
String

Response Codes

Code
Reason
200
Created the test connection.
201
Created the test connection.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/connections/334444440000000000PK/test" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"connDetails\": { \"configOptions\": [{ \"id\": \"Access Key\", \"value\": \"AKIAJCA\" }, { \"id\": \"Master Symmetric Key\", \"value\": \"COJ9oRl+G8Qv6em6e8kEY=\" }, { \"id\": \"Secret Key\", \"value\": \"jocQFy08kJXP4VJPdQkk3\" } ], \"id\": \"0000K\" }, \"icsUsername\": \"ams\"}"

List Configured Connections for all Supported Resource Types

provision/connections/config
API to list the connection configuration options for all the supported resource types.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/connections/config
HTTP Method Type
GET

Response Codes

Code
Reason
200
Listed the connection configuration options for the supported resource types.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/connections/config" -H "accept: application/json"

List Configured Connections for a Resource Type

provision/connections/config/{type}
API to list the connection configuration options for a resource type.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/connections/config/{type}
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
type
Required
Enter one of the following connection types:
  • - Azure DW
  • - JDBC_IC
  • - Amazon S3
  • - Hive Connector
  • - Amazon Redshift v2
  • - Google Cloud Storage V2
  • - Microsoft Azure Blob Storage V3
  • - Teradata
  • - Google Big Query V2
  • - SqlServer2016
  • - Tableau V3
  • - Qlik
  • - Azure Data Lake Store Gen2
  • - SqlServer2012
  • - Oracle
  • - Hadoop Files V2
  • - Salesforce
  • - SqlServer2000
  • - SqlServer2005
  • - SqlServer2017
  • - SqlServer2019
  • - SqlServer2008
  • - SqlServer2014
Path
String

Response Codes

Code
Reason
200
Listed the configured connections for the supported type.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/connections/config/Oracle" -H "accept: application/json"

List Data Provisioning Details

/provision/info
API to list whether data provisioning is available.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/info
HTTP Method Type
GET

Response Codes

Code
Reason
200
Provided the data provisioning information.
400
Missing or invalid parameter
401
Missing credentials
403
User does not have the required access permissions
404
Requested object not found
429
Rate limit for requests encountered

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/info" -H "accept: application/json"

Preview Data for a Data Object

provision/preview
API to preview data for a data object.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/preview
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
icsUsername
Required
The user name to log in to Informatica Intelligent Cloud Services.
Query
String
objectId
Required
The ID of the data object in Enterprise Data Catalog.
Query
String
connectionId
Required
The ID of the connection for the data object in Informatica Intelligent Cloud Services.
Query
String
configOpt
Required
Enter one or more user names and its associated passwords as key-value pairs in the following format:
<key>:<value>
For example, username:test1
password:test1
Query
Array [String]

Response Codes

Code
Reason
200
Listed the preview of data for the data object.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/preview?icsUsername=testuser1&objectId=edittable&connectionId=3423&configOpt=username%3Auser1" -H "accept: application/json"

List Supported Resources for Data Provisioning

/provision/provisionableResources
API to list the resources that support data provisioning.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/provisionableResources
HTTP Method Type
GET

Response Codes

Code
Reason
200
Listed the resources that support data provisioning.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/provisionableResources" -H "accept: application/json"

List Resources with Connection Details

provision/resources
API to list the resources with the connection details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/resources
HTTP Method Type
GET

Response Codes

Code
Reason
200
Listed the resources with the connection details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/resources" -H "accept: application/json"

List a Resource with Connection Details

provision/resources/{resourceName}
API to list a resource and its connection details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/resources/{resourceName}
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
resourceName
Required
The name of the resource
Path
String

Response Codes

Code
Reason
200
Listed the resource with connection details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/resources/ora" -H "accept: application/json"

Create or Update Resource Connection Configuration Options

provision/resources/{resourceName}
API to create or update the connection configuration for a resource.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/resources/{resourceName}
HTTP Method Type
PUT

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
resourceName
Required
The name of the resource.
Path
String
connConf
Required
Enter the attribute parameters.
Body
-
If-Match
Optional
Enter a value to display the results that match the value. Do not update if the entity tag or Etag for the resource has changed.
Header
String

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
Values
connectionId
Required
The ID of the Informatica Intelligent Cloud Services connection.
String
-
href
Optional
Link to resource configuration.
String
-
icsUsername
Required
The user name to log in to Informatica Intelligent Cloud Services.
String
-
orgId
Required
The ID of the organization that the icsUsername belongs to.
String
orgName
Required
The name of the organization.
String
-
resourceName
Required
The name of the resource
String
-

Response Codes

Code
Reason
200
Updated the connection configuration for a resource.
201
Created the connection configuration for a resource.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
412
Conflicting edit detected.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/provision/resources/ora" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"connectionId\": \"345\", \"icsUserName\": \"testuser1\", \"orgId\": \"VB453B\", \"orgName\": \"Orc1\", \"resourceName\": \"ora\"}"

Delete the Connection to the Resource

provision/resources/{resourceName}
API to delete the connection to a resource.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/resources/{resourceName}
HTTP Method Type
DELETE

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
resourceName
Required
The name of the resource.
Path
String

Response Codes

Code
Reason
200
Deleted the connection to the resource.
204
No content.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X DELETE "http://<CatalogAdmin>:<port>/access/2/catalog/provision/resources/ora" -H "accept: application/json"

List All the Provisioning Tasks

provision/task
API to list all the provisioning tasks in Enterprise Data Catalog.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/task
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
objectId
Optional
Enter one or more data object IDs.
Query
Array [String]
resourceName
Optional
Enter one or more resource names.
Enterprise Data Catalog ignores this parameter if you enter an objectId.
Query
Array [String]

Response Codes

Code
Reason
200
Listed the provisioning tasks.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/task" -H "accept: application/json"

Submit a Provisioning Task

provision/task
API to submit a provisioning task in Enterprise Data Catalog.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/task
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
provisionTask
Required
Enter the provisioning task attributes.
Body
-

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
Values
createTarget
Required
Enter true to create a target.
Enter false to append rows to an existing table.
Boolean
Enter one of the following values:
  • - true
  • - false
icsUsername
Required
The user name to log in to Informatica Intelligent Cloud Services.
String
-
objectId
Required
The ID of the source object.
String
-
orgId
Required
The ID of the organization that the icsUsername belongs to.
String
srcDetails
Required
Enter the source configuration options.
-
Enter the following values:
  • - configOptions
    • - defaultValue
    • - description
    • - id
    • - isEditable
    • - isRequired
    • - isRuntimeAttr
    • - isSensitive
    • - label
    • - supportedValues
    • - value
  • - href
  • - id
  • - isAppendable
  • - isCreatable
  • - name
  • - orgId
  • - runtimeEnvironmentId
  • - type
Choose Oracle or SQLServer for the type parameter.
targetName
Required
Name of the target object.
You do not need a target name if you want to append rows to an existing table, To create a table, enter a target name.
String
-
tgtDetails
Required
Enter the target configuration options.
-
Enter the following values:
  • - configOptions
    • - defaultValue
    • - description
    • - id
    • - isEditable
    • - isRequired
    • - isRuntimeAttr
    • - isSensitive
    • - label
    • - supportedValues
    • - value
  • - href
  • - id
  • - isAppendable
  • - isCreatable
  • - name
  • - orgId
  • - runtimeEnvironmentId
  • - type
Choose Oracle, Amazon S3, SQLServer, or Tableau Online for the type parameter.
truncateTarget
Required
Enter false to create a new asset or overwrite existing data.
Enter true to append the data to an existing asset or create a new asset.
Boolean
Enter one of the following values:
  • - true
  • - false

Response Codes

Code
Reason
201
Submitted the provisioning task in Enterprise Data Catalog.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
412
Conflicting edit detected.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/task" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"createTarget\": true, \"icsUsername\": \"testuser1\", \"objectId\": \"CSource://ORA/testuser1/CUSTOMER_MAIN\", \"orgId\": \"testorg\", \"srcDetails\": { \"configOptions\": [ { \"id\": \"username\", \"value\": \"testuser1\" }, { \"id\": \"password\", \"value\": \"testuser1\" } ], \"id\": \"999000002\" }, \"tgtDetails\": { \"configOptions\": [ { \"id\": \"username\", \"value\": \"testuser1@test123.com\" }, { \"id\": \"password\", \"value\": \"testorg1\" } ], \"id\": \"99990007\" }, \"truncateTarget\": false}"

List Provisioning Tasks for a Task ID

provision/task/{id}
API to list the provisioning tasks for a task ID.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/task/{id}
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the task
Path
String

Response Codes

Code
Reason
200
Listed the provisioning task for the specified task.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/task/232" -H "accept: application/json"

Delete a Provisioning Task

provision/task/{id}
API to delete the provisioning task entry for a task ID.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/task/{id}
HTTP Method Type
DELETE

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the provisioning task
Path
String

Response Codes

Code
Reason
200
Deleted the provisioning task entry.
204
No content.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X DELETE "http://<CatalogAdmin>:<port>/access/2/catalog/provision/task/124" -H "accept: application/json"

List Configured Informatica Intelligent Cloud Services Users

provision/users
API to list all the Informatica Intelligent Cloud Services users in your enterprise.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/users
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
orgId
Optional
Enter one or more organization ID to filter the users.
Query
Array [String]
username
Optional
Enter one or more Informatica Intelligent Cloud Services user names to filter the users.
Enterprise Data Catalog ignores this option if you enter an orgId.
Query
Array [String]

Response Codes

Code
Reason
200
Listed the Informatica Intelligent Cloud Services users in your enterprise.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/provision/users" -H "accept: application/json"

Create or Update Credentials for Enterprise Data Catalog Users

provision/users
API to configure or update the credentials for Enterprise Data Catalog users.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/users
HTTP Method Type
PUT

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
users
Required
Enter the attribute parameters.
Body
-

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
href
Optional
The URL to access the secure agent.
String
icsUsername
Required
The username to log in to Informatica Intelligent Cloud Services.
String
orgId
Optional
The name of the orgID of the Informatica Intelligent Cloud Services user.
String
orgName
Optional
The name of the organization that the Informatica Intelligent Cloud Services user belongs to.
String
password
Required
The password of the Informatica Intelligent Cloud Services user.
String

Response Codes

Code
Reason
200
Created or updated the user details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
412
Conflicting edit detected.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/provision/users" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"items\": [ { \"icsUsername\": \"amsh\", \"password\": \"abcd@1234\" } ]}"

Create or Update Credentials for an Enterprise Data Catalog User

provision/users/{id}
API to configure or update the credentials for an Enterprise Data Catalog user.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/users/{id}
HTTP Method Type
PUT

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The user name of the Informatica Intelligent Cloud Services user.
Path
String
user
Required
Enter the attribute parameters.
Body
-
If-Match
Optional
Enter a value to display the results that match the value. Do not update if the entity tag or Etag for the resource has changed.
Header
String

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
href
Optional
The URL to access the secure agent.
String
icsUsername
Required
The username to log in to Informatica Intelligent Cloud Services.
String
orgId
Optional
The name of the orgID of the Informatica Intelligent Cloud Services user.
String
orgName
Optional
The name of the organization that the Informatica Intelligent Cloud Services user belongs to.
String
password
Required
The password of the Informatica Intelligent Cloud Services user.
String

Response Codes

Code
Reason
200
Created or updated the user details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
412
Conflicting edit detected.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/provision/users/asfma" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"icsUsername\": \"asfma\", \"password\": \"abc@1234\"}"

Delete an Enterprise Data Catalog User

provision/users/{id}
API to delete an Enterprise Data Catalog user.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/users/{id}
HTTP Method Type
DELETE

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the Enterprise Data Catalog user.
Path
String

Response Codes

Code
Reason
200
Deleted the specified Enterprise Data Catalog user.
204
No content.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X DELETE "http://<CatalogAdmin>:<port>/access/2/catalog/provision/users/33" -H "accept: application/json"

Validate and Return the Informatica Intelligent Cloud Services User Details

provision/users/validate
API to validate and return the Informatica Intelligent Cloud Services user details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/provision/users/validate
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
users
Required
Enter the required user attributes.
Body
-

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
href
Optional
The URL to access the secure agent.
String
icsUsername
Required
The user name to log in to Informatica Intelligent Cloud Services.
String
orgId
Optional
The name of the orgID of the Informatica Intelligent Cloud Services user.
String
orgName
Optional
The name of the organization that the Informatica Intelligent Cloud Services user belongs to.
String
password
Required
The password of the Informatica Intelligent Cloud Services user.
String
nextCursorMark
Optional
When the request supports cursor pagination this parameter is populated. Deep pagination using cursors can be more efficient.
String
partialResults
Optional
Choose true if the response must not contain results from all the appropriate shards.
Boolean
totalCount
Optional
Total number of results.
Integer

Response Codes

Code
Reason
200
Validated and returned the Informatica Intelligent Cloud Services user details.
201
Created.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
412
Conflicting edit detected.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X POST "http://<CatalogAdmin>:<port>/access/2/catalog/provision/users/validate" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"items\": [ { \"icsUsername\": \"afsfa\", \"password\": \"abdc@1234\" } ] }"