Infoworks Rest API V31.0
Infoworks Rest API V3
Servers
Choose a server to use:
http://localhost:3001/v3
Get `authentication_token` with `username` and `password`.
GET /security/authenticate
Get authentication_token with username and password.
Auth
Query String
| service_id | number | Used to represent the way user has login into infoworks | optional |
Example Request
x
curl --request GET \ --url http://localhost:3001/v3/security/authenticate?service_id={service_id} \ --header "Authorization: Basic {token}"Responses
200 400 401 406 500
| object | object | ||
| message | string | optional | |
| result | object | optional | |
| authentication_token | string | optional | |
| is_authenticated | boolean | optional | |
| user_id | string | optional |
Example Response
200 Authentication success response
400 Request has invalid body or parameters.
401 Forbidden. User lacks access to specified resource.
406 Authentication Failed response
500 Internal Server Error.
xxxxxxxxxx{ "message": "Authentication Success", "result": { "authentication_token": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjUwMzc2MTcsInN1YiI6IntcbiAgXCJlbWFpbFwiIDogXCJhZG1pbkBpbmZvd29ya3MuaW9cIixcbiAgXCJzY29wZVwiIDoge1xuICAgIFwiYWN0aW9uXCIgOiBcInJlZnJlc2hfdG9rZW5cIlxuICB9XG59IiwianRpIjoiOTFlZGZkMWYtN2Y5My00NjM0LTg4MjctZTZlYjViYWJmNDJkIiwiZXhwIjoxNjI1MDM4NTE3fQ.aCTMjNebvC2Rf1CrJp_wA0dsozJd-uKpTcdEvDyigSU", "is_authenticated": true, "user_id": "6RkfybTRQQByEey3v" }}Get `authentication_token` with `refresh_token`.
GET /security/token/access
Get authentication_token with refresh_token.
Auth
Headers
| Authorization | string | refresh token auth header put | required |
Example Request
xxxxxxxxxxcurl --request GET \ --url http://localhost:3001/v3/security/token/access \ --header "Authorization: {Authorization}"Responses
200 400 401 406 500
| object | object | ||
| message | string | optional | |
| result | object | optional | |
| authentication_token | string | optional |
Example Response
200 Authentication success response
400 Request has invalid body or parameters.
401 Forbidden. User lacks access to specified resource.
406 Authentication Failed response
500 Internal Server Error.
xxxxxxxxxx{ "message": "Authentication Success", "result": { "authentication_token": "eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjUwMzc2MTcsInN1YiI6IntcbiAgXCJlbWFpbFwiIDogXCJhZG1pbkBpbmZvd29ya3MuaW9cIixcbiAgXCJzY29wZVwiIDoge1xuICAgIFwiYWN0aW9uXCIgOiBcInJlZnJlc2hfdG9rZW5cIlxuICB9XG59IiwianRpIjoiOTFlZGZkMWYtN2Y5My00NjM0LTg4MjctZTZlYjViYWJmNDJkIiwiZXhwIjoxNjI1MDM4NTE3fQ.aCTMjNebvC2Rf1CrJp_wA0dsozJd-uKpTcdEvDyigSU" }}Purge authentication token
DELETE /security/token/access
Purges authentication token and logs out the user. The user will need to generate a new authentication token for subsequent API calls.
Auth
Example Request
xxxxxxxxxxcurl --request DELETE \ --url http://localhost:3001/v3/security/token/access \ --header "Authorization: Bearer {token}"Responses
200 400 401 500
| object | object | ||
| message | string | optional | |
| result | string | optional |
Example Response
200 ok
400 Request has invalid body or parameters.
401 Forbidden. User lacks access to specified resource.
500 Internal Server Error.
xxxxxxxxxx{ "message": "Example Success Message", "result": "Token successfully blacklisted"}Validate `authentication_token` if its active or not.
GET /security/token/validate
Validate authentication_token if its active or not.
Auth
Example Request
xxxxxxxxxxcurl --request GET \ --url http://localhost:3001/v3/security/token/validate \ --header "Authorization: Bearer {token}"Responses
200 400 401 500
| object | object | ||
| message | string | optional | |
| result | object | optional | |
| is_valid | boolean | optional |
Example Response
200 Valid Token Response
400 Request has invalid body or parameters.
401 Forbidden. User lacks access to specified resource.
500 Internal Server Error.
xxxxxxxxxx{ "message": "{string}", "result": { "is_valid": true }}Regenerate Refresh Token and blacklist old token.
DELETE /security/token/refresh
Regenerate Refresh Token and blacklist old token.
Auth
Example Request
xxxxxxxxxxcurl --request DELETE \ --url http://localhost:3001/v3/security/token/refresh \ --header "Authorization: Basic {token}"Responses
200 400 401 500
| object | object | ||
| message | string | optional | |
| result | string | optional |
Example Response
200
400 Request has invalid body or parameters.
401 Forbidden. User lacks access to specified resource.
500 Internal Server Error.
xxxxxxxxxx{ "message": "Platform Security Response", "result": "Successfully Blacklisted Refresh Token."}Authorise User.
POST /security/authorise/user
Authorise User.
Auth
Request Body
| object | object | ||
| entityType | string | optional | |
| action | string | optional | |
| entityId | string | optional |
Example Request
xxxxxxxxxxcurl --request POST \ --url http://localhost:3001/v3/security/authorise/user \ --header "Content-Type: application/json" \ --header "Authorization: Bearer {token}" \ --data '{ "entityType": "{string}", "action": "{string}", "entityId": "{string}"}'Responses
200 400 401 500
| object | object | ||
| message | string | optional | |
| result | object | optional | |
| delegation_token | string | optional | |
| is_authorised | boolean | optional |
Example Response
200
400 Request has invalid body or parameters.
401 Forbidden. User lacks access to specified resource.
500 Internal Server Error.
xxxxxxxxxx{ "message": "{string}", "result": { "delegation_token": "{string}", "is_authorised": "{boolean}" }}Get SAML Redirect URL.
GET /security/sso/initialise
Get SAML Redirect URL.
Auth
Example Request
xxxxxxxxxxcurl --request GET \ --url http://localhost:3001/v3/security/sso/initialise \ --header "Authorization: Bearer {token}"Responses
200 400 401 500
| object | object | ||
| Location | string | optional |
Example Response
200 Valid Token Response
400 Request has invalid body or parameters.
401 Forbidden. User lacks access to specified resource.
500 Internal Server Error.
xxxxxxxxxx{ "Location": "{string}"}LDAP Authorise User.
POST /security/get/user/data
LDAP Authorise User.
Auth
Request Body
| object | object | ||
| userIds | array[string] | optional | |
| searchAttribute | string | optional |
Example Request
xxxxxxxxxxcurl --request POST \ --url http://localhost:3001/v3/security/get/user/data \ --header "Content-Type: application/json" \ --header "Authorization: Bearer {token}" \ --data '{ "userIds": [ "{array[string]...}" ], "searchAttribute": "{string}"}'Responses
200 400 401 500
| object | object | ||
| users | array[string] | optional |
Example Response
200
400 Request has invalid body or parameters.
401 Forbidden. User lacks access to specified resource.
500 Internal Server Error.
xxxxxxxxxx{ "users": [ "{array[string]...}" ]}bulk sync (add/update) ldap user by providing login attribute
POST /security/bulk-ldap-sync
bulk sync (add/update) ldap user by providing login attribute
Auth
Request Body
| object | object | ||
| search_on | string | optional | |
| search_list | array[string] | optional | |
| should_update | boolean | Default: true | optional |
| should_add | boolean | Default: true | optional |
Example Request
xxxxxxxxxxcurl --request POST \ --url http://localhost:3001/v3/security/bulk-ldap-sync \ --header "Content-Type: application/json" \ --header "Authorization: Basic {token}" \ --data '{ "search_on": "email", "search_list": "admin@infoworks.io", "should_update": true, "should_add": true}'Responses
200 400 401 406 500
| object | object | ||
| message | string | optional | |
| result | object | optional | |
| new_users_count | integer | optional | |
| existing_user_count | integer | optional | |
| added | array[object] | optional | |
| string | optional | ||
| id | string | optional | |
| updated | array[object] | optional | |
| string | optional | ||
| id | string | optional | |
| failed | array[object] | optional | |
| string | optional | ||
| id | string | optional | |
| error | string | optional |
Example Response
200 bulk ldap users sync response
400 Request has invalid body or parameters.
401 Forbidden. User lacks access to specified resource.
406 Authentication Failed response
500 Internal Server Error.
xxxxxxxxxx{ "message": "Successfully synced ldap users", "result": { "new_users_count": 1, "existing_user_count": 20, "added": [ { "email": "modeller@infoworks.io", "id": "8qvdcWsT5foNuryNF" } ], "updated": [ { "email": "admin@infoworks.io", "id": "6RkfybTRQQByEey3v" } ], "failed": [ { "email": "prodops@infoworks.io", "id": "9DvdcZsH5foNuryVN", "error": "No valid role found for the User." } ] }}Users
Endpoints
Environment
Endpoints
Sources
Endpoints
Source Configurations
Endpoints
Generic Source Types
Endpoints
Topics
Endpoints
File Mappings
Endpoints
Tables
Endpoints
Table Groups
Endpoints
Table Group Schedule
Enable/Disable schedule for table groups
Domains
Endpoints
Pipeline Extensions
Endpoints
Source Extensions
Endpoints
Workflows Schedules
Jobs
Endpoints
Job Hooks
Endpoints
License
Pipeline Groups
Endpoints
Service Authentication
CRUD Operations to manage Service Authentication mechanisms
Secret Store
CRUD Operations to manage Secret Stores
Secrets
CRUD Operations to manage Secrets
Event Notifications
Read Operation for event notifications
Endpoints
Engagement Metrics
Read Operation for engagement metrics
Data Catalog
Read Operation for Data Catalog
Pipeline Version Locks
CRUD operations from pipeline version locks
Environment Cluster
Environment Cluster to start/stop/restart cluster
Endpoints
Scheduling Information
Admin Configurations
Endpoints
General Configs
Endpoints
Admin Metadata Cleanup
Endpoints
Metrics
Endpoints
Admin Metadata Backup
Target Data Connections
Self
Admin Schedules
Endpoints
Custom Audit Columns
Clear Cache
Endpoints
Stop Streaming
Misc
Favorites
Subscribers
Service Authentication Cache
Endpoints
Pipeline Version Lock
Endpoints
Workflow Run Metering Variables
Validation
Getting Server Timezone
Endpoints