Phoenix App Manager API (1.0)

Download OpenAPI specification:

API Support: support@jiffy.ai URL: http://www.jiffy.ai/support

This is the API for the Phoenix App Manager.

Getting Started

Get Auth Config

Get Auth Config (client id, user pool id, region, cognito endpoint) for a given host.

Authorizations:

BearerAuth

query Parameters

host required	string Host (e.g. abcd.jiffy.ai or abcd.localhost:5173)
tenant_name required	string Tenant Name (e.g. abcd)

Responses

Response samples

Content type

application/json

{"app_name": "string",
"client_id": "string",
"cognito_endpoint": "string",
"region": "string",
"tenant_name": "string",
"user_pool_id": "string"
}

Generate Token

Generate Token for a given tenant , user and password. This is only for development purposes.

Authorizations:

BearerAuth

Request Body schema: application/json
required

Get Token Request

host	string
password	string
tenant_name	string
username	string

Responses

Request samples

Payload

Content type

application/json

{"host": "string",
"password": "string",
"tenant_name": "string",
"username": "string"
}

Response samples

Content type

application/json

{"access_token": "string",
"expires_in": 0,
"id_token": "string",
"refresh_token": "string"
}

Tenant

Tenant Management

Get all tenants

Authorizations:

BearerAuth

query Parameters

offset	integer Offset
limit	integer Limit

Responses

Response samples

Content type

application/json

[{"description": "string",
"id": "string",
"is_archived": true,
"is_super_tenant": true,
"label": "string",
"name": "string",
"owner_email": "string"
}
]

Create a tenant

Authorizations:

BearerAuth

Request Body schema: application/json
required

Tenant

	object
allowed_callback_urls	Array of strings example: ["tenantname.localhost:3000", "tenantname.neo-api.jiffy.ai"]
description	string
enableVersioning	boolean
initial_password	string
is_super_tenant	boolean
name	string
owner_email	string example: "account@example.com"
region	string (dto.Region) Enum: "us-east-1" "ap-south-1"

Responses

Request samples

Payload

Content type

application/json

{"additionalTags": {"property1": "string",
"property2": "string"
},
"allowed_callback_urls": ["string"
],
"description": "string",
"enableVersioning": true,
"initial_password": "string",
"is_super_tenant": true,
"name": "string",
"owner_email": "string",
"region": "us-east-1"
}

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"is_archived": true,
"is_super_tenant": true,
"label": "string",
"name": "string",
"owner_email": "string"
}

Delete a tenant

Authorizations:

BearerAuth

path Parameters

required

string

Tenant ID

Responses

Get a tenant

Get a tenant by name

Authorizations:

BearerAuth

path Parameters

name

required

string

Tenant Name

header Parameters

X-Jiffy-Tenant

required

string

Tenant Name

Responses

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"is_archived": true,
"is_super_tenant": true,
"label": "string",
"name": "string",
"owner_email": "string"
}

Update a tenant

Authorizations:

BearerAuth

path Parameters

name

required

string

Tenant Name

Request Body schema: application/json
required

Tenant

allowed_callback_urls	Array of strings
description	string
is_super_tenant	boolean
name	string

Responses

Request samples

Payload

Content type

application/json

{"allowed_callback_urls": ["string"
],
"description": "string",
"is_super_tenant": true,
"name": "string"
}

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"is_archived": true,
"is_super_tenant": true,
"label": "string",
"name": "string",
"owner_email": "string"
}

Application

Application Instances Management

Get all applications

Authorizations:

BearerAuth

query Parameters

environment	string
limit	integer
offset	integer
status	string
offset	integer Offset
limit	integer Limit

header Parameters

X-Jiffy-Tenant

required

string

Tenant Name

Responses

Response samples

Content type

application/json

[{"app_definition": "string",
"app_definition_key": "string",
"description": "string",
"editable": true,
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"status": "started",
"tenant": "string",
"version": "string"
}
]

Create an application

Create an application. Pass the application definition name to create a new application with that definition. If no application definition name is passed, a new application definition will be created.

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant

required

string

Tenant Name

Request Body schema: application/json
required

Application

app_definition	string
app_definition_key	string
description	string
editable	boolean
label	string
name	string
version	string

Responses

Request samples

Payload

Content type

application/json

{"app_definition": "string",
"app_definition_key": "string",
"description": "string",
"editable": true,
"label": "string",
"name": "string",
"version": "string"
}

Response samples

Content type

application/json

{"app_definition": "string",
"app_definition_key": "string",
"description": "string",
"editable": true,
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"status": "started",
"tenant": "string",
"version": "string"
}

Delete an application

Authorizations:

BearerAuth

path Parameters

required

string

Application ID

header Parameters

X-Jiffy-Tenant

required

string

Tenant Name

Responses

Get an application

Authorizations:

BearerAuth

path Parameters

required

string

Application ID

header Parameters

X-Jiffy-Tenant

required

string

Tenant Name

Responses

Response samples

Content type

application/json

{"app_definition": "string",
"app_definition_key": "string",
"description": "string",
"editable": true,
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"status": "started",
"tenant": "string",
"version": "string"
}

Update an application

Authorizations:

BearerAuth

path Parameters

required

string

Application ID

header Parameters

X-Jiffy-Tenant

required

string

Tenant Name

Request Body schema: application/json
required

Application

description	string
editable	boolean
skip_schema_migration	boolean
status	string
version	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"editable": true,
"skip_schema_migration": true,
"status": "string",
"version": "string"
}

Response samples

Content type

application/json

{"app_definition": "string",
"app_definition_key": "string",
"description": "string",
"editable": true,
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"status": "started",
"tenant": "string",
"version": "string"
}

Application Definition

Application Definitions Management

Get all application definitions

Authorizations:

BearerAuth

query Parameters

offset	integer Offset
limit	integer Limit

header Parameters

X-Jiffy-Tenant

required

string

Tenant Name

Responses

Response samples

Content type

application/json

[{"app_definition_key": "string",
"app_definition_name": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"tenant": "string",
"version": "string"
}
]

Deploy an application definition

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant

required

string

Tenant Name

Request Body schema: application/json
required

Application definition

app_definition_key	string
app_definition_name	string
id	string
is_archived	boolean
label	string
name	string
tenant	string
version	string

Responses

Request samples

Payload

Content type

application/json

{"app_definition_key": "string",
"app_definition_name": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"tenant": "string",
"version": "string"
}

Publish an application definition

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant

required

string

Tenant Name

Request Body schema: application/json
required

Application definition

app_definition	string
is_private	boolean
version	string

Responses

Request samples

Payload

Content type

application/json

{"app_definition": "string",
"is_private": true,
"version": "string"
}

Component Definitions

Component Definitions Management

Delete a component definition

Authorizations:

BearerAuth

path Parameters

id required	string component definition ID
componentType required	string Component type

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Patch a component definition

Authorizations:

BearerAuth

path Parameters

id required	string component definition ID
componentType required	string Component type

query Parameters

path

required

string

Path

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Request Body schema: application/json
required

Patch

object

Responses

Request samples

Payload

Content type

application/json

{"patch": { }
}

Response samples

Content type

application/json

{"Properties": null,
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Get a component definition

Authorizations:

BearerAuth

path Parameters

componentType required	string Component type
name required	string Component definition name

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"Properties": null,
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Update a component definition by name

Authorizations:

BearerAuth

path Parameters

name required	string component definition name
componentType required	string Component type

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Request Body schema: application/json
required

component definition

Properties	any
app_definition	string
	Array of objects (common.Attribute)
component_type	string (common.ComponentType) Enum: "screen" "app_ui" "workflow" "table" "entity" "etl" "automation" "agent" "document_processing" "schema_migration" "connector" "connector_request" "authenticator"
description	string
id	string
is_archived	boolean
label	string
name	string
org	string
root_component	string
sub_type	string
tenant	string
type	string
version	string

Responses

Request samples

Payload

Content type

application/json

{"Properties": null,
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Response samples

Content type

application/json

{"Properties": null,
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Get a component definition by ID

Authorizations:

BearerAuth

path Parameters

componentType required	string Component type
id required	string component definition ID

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"Properties": null,
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Search component definitions

Authorizations:

BearerAuth

path Parameters

componentType

required

string

Component type

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Request Body schema: application/json
required

Filter

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

[{"Properties": null,
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}
]

Entity Definition

Entity Definitions Management

Get all entity component definitions

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

[{"accessControlPolicy": {"aclFields": {"field": [{"all": {"field": [{ }
]
},
"any": { },
"filterField": "string",
"orgField": "string",
"ownerField": "string"
}
]
}
},
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"audit": {"auditEntity": "string",
"auditField": "string"
},
"columns": [{"audit": "string",
"computedExpression": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"constraints": [{"allowedValues": ["string"
],
"message": "string",
"type": "minValue",
"value": "string"
}
],
"dataType": "string",
"default": "string",
"description": "string",
"exclusive": true,
"fieldId": "string",
"fieldType": "property",
"isChangeTrackingField": true,
"isOrgUnitLink": true,
"isSequence": true,
"label": "string",
"linkTarget": "string",
"linkTargetNormalized": "string",
"multi": true,
"name": "string",
"normalizedName": "string",
"readonly": true,
"required": true,
"sequenceName": "string",
"sourceDeletionPolicy": {"deleteTarget": true,
"ifOrphan": true
},
"targetDeletionPolicy": "restrict",
"type": "string"
}
],
"component_type": "screen",
"compositeUniqueConstraints": [{"fields": ["string"
],
"name": "string"
}
],
"defaultOrderBy": {"fieldName": "string",
"order": "asc"
},
"description": "string",
"entityId": "string",
"entityType": "regular",
"features": ["string"
],
"id": "string",
"indexes": [{"fields": ["string"
],
"indexType": "undefined",
"isNaturalKey": true,
"name": "string"
}
],
"is_archived": true,
"label": "string",
"linkedEntities": ["string"
],
"name": "string",
"normalizedName": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"validations": [{"affectedField": ["string"
],
"enforceAt": "string",
"expression": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"message": "string",
"severity": "string"
}
],
"version": "string"
}
]

Create a entity component definition

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Request Body schema: application/json
required

Entity component definition

	object (component_definitions.AccessControlPolicy)
app_definition	string
	Array of objects (common.Attribute)
	object Optional audit configuration for this table
	Array of objects (component_definitions.Field)
component_type	string (common.ComponentType) Enum: "screen" "app_ui" "workflow" "table" "entity" "etl" "automation" "agent" "document_processing" "schema_migration" "connector" "connector_request" "authenticator"
	Array of objects (component_definitions.CompositeUniqueConstraint) List of composite unique constraints
	object Default ordering of the table
description	string
entityId	string Unique identifier from the schema (constant, never changes)
entityType	string Enum: "regular" "reference_data" "change_log" "enumeration" "messages" Data type of the table
features	Array of strings
id	string
	Array of objects (component_definitions.Index)
is_archived	boolean
label	string
linkedEntities	Array of strings Linked tables of the table
name	string
normalizedName	string Normalized name (e.g., "account" for "Account")
org	string
root_component	string
sub_type	string
tenant	string
type	string
	Array of objects (component_definitions.Validation) Validation rules for the table
version	string

Responses

Request samples

Payload

Content type

application/json

{"accessControlPolicy": {"aclFields": {"field": [{"all": {"field": [{ }
]
},
"any": { },
"filterField": "string",
"orgField": "string",
"ownerField": "string"
}
]
}
},
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"audit": {"auditEntity": "string",
"auditField": "string"
},
"columns": [{"audit": "string",
"computedExpression": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"constraints": [{"allowedValues": ["string"
],
"message": "string",
"type": "minValue",
"value": "string"
}
],
"dataType": "string",
"default": "string",
"description": "string",
"exclusive": true,
"fieldId": "string",
"fieldType": "property",
"isChangeTrackingField": true,
"isOrgUnitLink": true,
"isSequence": true,
"label": "string",
"linkTarget": "string",
"linkTargetNormalized": "string",
"multi": true,
"name": "string",
"normalizedName": "string",
"readonly": true,
"required": true,
"sequenceName": "string",
"sourceDeletionPolicy": {"deleteTarget": true,
"ifOrphan": true
},
"targetDeletionPolicy": "restrict",
"type": "string"
}
],
"component_type": "screen",
"compositeUniqueConstraints": [{"fields": ["string"
],
"name": "string"
}
],
"defaultOrderBy": {"fieldName": "string",
"order": "asc"
},
"description": "string",
"entityId": "string",
"entityType": "regular",
"features": ["string"
],
"id": "string",
"indexes": [{"fields": ["string"
],
"indexType": "undefined",
"isNaturalKey": true,
"name": "string"
}
],
"is_archived": true,
"label": "string",
"linkedEntities": ["string"
],
"name": "string",
"normalizedName": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"validations": [{"affectedField": ["string"
],
"enforceAt": "string",
"expression": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"message": "string",
"severity": "string"
}
],
"version": "string"
}

Response samples

Content type

application/json

{"accessControlPolicy": {"aclFields": {"field": [{"all": {"field": [{ }
]
},
"any": { },
"filterField": "string",
"orgField": "string",
"ownerField": "string"
}
]
}
},
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"audit": {"auditEntity": "string",
"auditField": "string"
},
"columns": [{"audit": "string",
"computedExpression": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"constraints": [{"allowedValues": ["string"
],
"message": "string",
"type": "minValue",
"value": "string"
}
],
"dataType": "string",
"default": "string",
"description": "string",
"exclusive": true,
"fieldId": "string",
"fieldType": "property",
"isChangeTrackingField": true,
"isOrgUnitLink": true,
"isSequence": true,
"label": "string",
"linkTarget": "string",
"linkTargetNormalized": "string",
"multi": true,
"name": "string",
"normalizedName": "string",
"readonly": true,
"required": true,
"sequenceName": "string",
"sourceDeletionPolicy": {"deleteTarget": true,
"ifOrphan": true
},
"targetDeletionPolicy": "restrict",
"type": "string"
}
],
"component_type": "screen",
"compositeUniqueConstraints": [{"fields": ["string"
],
"name": "string"
}
],
"defaultOrderBy": {"fieldName": "string",
"order": "asc"
},
"description": "string",
"entityId": "string",
"entityType": "regular",
"features": ["string"
],
"id": "string",
"indexes": [{"fields": ["string"
],
"indexType": "undefined",
"isNaturalKey": true,
"name": "string"
}
],
"is_archived": true,
"label": "string",
"linkedEntities": ["string"
],
"name": "string",
"normalizedName": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"validations": [{"affectedField": ["string"
],
"enforceAt": "string",
"expression": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"message": "string",
"severity": "string"
}
],
"version": "string"
}

Get a entity component definition by name

Authorizations:

BearerAuth

path Parameters

name

required

string

Entity component definition name

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"accessControlPolicy": {"aclFields": {"field": [{"all": {"field": [{ }
]
},
"any": { },
"filterField": "string",
"orgField": "string",
"ownerField": "string"
}
]
}
},
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"audit": {"auditEntity": "string",
"auditField": "string"
},
"columns": [{"audit": "string",
"computedExpression": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"constraints": [{"allowedValues": ["string"
],
"message": "string",
"type": "minValue",
"value": "string"
}
],
"dataType": "string",
"default": "string",
"description": "string",
"exclusive": true,
"fieldId": "string",
"fieldType": "property",
"isChangeTrackingField": true,
"isOrgUnitLink": true,
"isSequence": true,
"label": "string",
"linkTarget": "string",
"linkTargetNormalized": "string",
"multi": true,
"name": "string",
"normalizedName": "string",
"readonly": true,
"required": true,
"sequenceName": "string",
"sourceDeletionPolicy": {"deleteTarget": true,
"ifOrphan": true
},
"targetDeletionPolicy": "restrict",
"type": "string"
}
],
"component_type": "screen",
"compositeUniqueConstraints": [{"fields": ["string"
],
"name": "string"
}
],
"defaultOrderBy": {"fieldName": "string",
"order": "asc"
},
"description": "string",
"entityId": "string",
"entityType": "regular",
"features": ["string"
],
"id": "string",
"indexes": [{"fields": ["string"
],
"indexType": "undefined",
"isNaturalKey": true,
"name": "string"
}
],
"is_archived": true,
"label": "string",
"linkedEntities": ["string"
],
"name": "string",
"normalizedName": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"validations": [{"affectedField": ["string"
],
"enforceAt": "string",
"expression": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"message": "string",
"severity": "string"
}
],
"version": "string"
}

Get a entity component definition by ID

Authorizations:

BearerAuth

path Parameters

required

string

Entity component definition ID

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"accessControlPolicy": {"aclFields": {"field": [{"all": {"field": [{ }
]
},
"any": { },
"filterField": "string",
"orgField": "string",
"ownerField": "string"
}
]
}
},
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"audit": {"auditEntity": "string",
"auditField": "string"
},
"columns": [{"audit": "string",
"computedExpression": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"constraints": [{"allowedValues": ["string"
],
"message": "string",
"type": "minValue",
"value": "string"
}
],
"dataType": "string",
"default": "string",
"description": "string",
"exclusive": true,
"fieldId": "string",
"fieldType": "property",
"isChangeTrackingField": true,
"isOrgUnitLink": true,
"isSequence": true,
"label": "string",
"linkTarget": "string",
"linkTargetNormalized": "string",
"multi": true,
"name": "string",
"normalizedName": "string",
"readonly": true,
"required": true,
"sequenceName": "string",
"sourceDeletionPolicy": {"deleteTarget": true,
"ifOrphan": true
},
"targetDeletionPolicy": "restrict",
"type": "string"
}
],
"component_type": "screen",
"compositeUniqueConstraints": [{"fields": ["string"
],
"name": "string"
}
],
"defaultOrderBy": {"fieldName": "string",
"order": "asc"
},
"description": "string",
"entityId": "string",
"entityType": "regular",
"features": ["string"
],
"id": "string",
"indexes": [{"fields": ["string"
],
"indexType": "undefined",
"isNaturalKey": true,
"name": "string"
}
],
"is_archived": true,
"label": "string",
"linkedEntities": ["string"
],
"name": "string",
"normalizedName": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"validations": [{"affectedField": ["string"
],
"enforceAt": "string",
"expression": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"message": "string",
"severity": "string"
}
],
"version": "string"
}

Screen Definition

Screen Definitions Management

Get all screen component definitions

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

[{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"bindings": [{"event_mode": "string",
"event_type": "string",
"id": "string",
"steps": [{"assign": {"assignments": [{"name": "string",
"src_argument": {"functions": [ ],
"text": null,
"title": null,
"variables": [ ]
},
"target_argument": "string"
}
],
"target": "string"
},
"call": {"body_mappings": [{"name": "string",
"src_argument": {"functions": [ ],
"text": null,
"title": null,
"variables": [ ]
},
"target_argument": "string"
}
],
"call_type": "string",
"headers": [{"name": "string",
"src_argument": {"functions": [ ],
"text": null,
"title": null,
"variables": [ ]
},
"target_argument": "string"
}
],
"method": "string",
"path_mappings": [{"name": "string",
"src_argument": {"functions": [ ],
"text": null,
"title": null,
"variables": [ ]
},
"target_argument": "string"
}
],
"query_mappings": [{"name": "string",
"src_argument": {"functions": [ ],
"text": null,
"title": null,
"variables": [ ]
},
"target_argument": "string"
}
],
"response": null,
"url": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"description": "string",
"if_else": {"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"else": [{ }
],
"then": [{ }
]
},
"name": "string",
"navigate": {"inputs": [{"name": "string",
"src_argument": {"functions": [ ],
"text": null,
"title": null,
"variables": [ ]
},
"target_argument": "string"
}
],
"target": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"refresh": { },
"stepType": "call",
"visibility": {"action": "string",
"target": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"target_type": "string"
}
}
],
"title": "string"
}
],
"component_type": "screen",
"conditions": [{"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"disable": true,
"fallback_styles": {"property1": null,
"property2": null
},
"styles": {"property1": null,
"property2": null
},
"visibility_action": "string"
}
],
"description": "string",
"field_bindings": {"property1": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"property2": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"navigation_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"nodes": [{"bindings": [{"event_mode": "string",
"event_type": "string",
"id": "string",
"steps": [{"assign": {"assignments": [null
],
"target": "string"
},
"call": {"body_mappings": [null
],
"call_type": "string",
"headers": [null
],
"method": "string",
"path_mappings": [null
],
"query_mappings": [null
],
"response": null,
"url": {"functions": [ ],
"text": null,
"title": null,
"variables": [ ]
}
},
"condition": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"description": "string",
"if_else": {"condition": {"functions": [ ],
"text": null,
"title": null,
"variables": [ ]
},
"else": [null
],
"then": [null
]
},
"name": "string",
"navigate": {"inputs": [null
],
"target": {"functions": [ ],
"text": null,
"title": null,
"variables": [ ]
}
},
"refresh": { },
"stepType": "call",
"visibility": {"action": "string",
"target": {"functions": [ ],
"text": null,
"title": null,
"variables": [ ]
},
"target_type": "string"
}
}
],
"title": "string"
}
],
"conditions": [{"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"disable": true,
"fallback_styles": {"property1": null,
"property2": null
},
"styles": {"property1": null,
"property2": null
},
"visibility_action": "string"
}
],
"field_bindings": {"property1": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"property2": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"navigation_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"nodes": [{ }
],
"props": {"property1": null,
"property2": null
},
"screen_layout": "string",
"styles": {"property1": null,
"property2": null
},
"variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
]
}
],
"org": "string",
"props": {"property1": null,
"property2": null
},
"root_component": "string",
"screen_layout": "string",
"styles": {"property1": null,
"property2": null
},
"sub_type": "string",
"tenant": "string",
"type": "string",
"variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"version": "string"
}
]

Create a screen component definition

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Request Body schema: application/json
required

Screen component definition

app_definition	string
	Array of objects (common.Attribute)
	Array of objects (component_definitions.EventBinding) Event handlers attached to this component
component_type	string (common.ComponentType) Enum: "screen" "app_ui" "workflow" "table" "entity" "etl" "automation" "agent" "document_processing" "schema_migration" "connector" "connector_request" "authenticator"
	Array of objects (component_definitions.Condition) Conditional rendering and styling rules
description	string
	object Binds component fields to data sources
id	string
is_archived	boolean
label	string
name	string
	Array of objects (component_definitions.Variable) Variables passed via navigation
	Array of objects (component_definitions.Screen) Nested child components (tree structure)
org	string
	object Component-specific properties (e.g., placeholder, disabled, value)
root_component	string
screen_layout	string Reference to layout component that wraps this screen
	object CSS styles as key-value pairs (supports dynamic values via Expression)
sub_type	string
tenant	string
type	string
	Array of objects (component_definitions.Variable) Component-scoped variables
version	string

Responses

Request samples

Payload

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"bindings": [{"event_mode": "string",
"event_type": "string",
"id": "string",
"steps": [{"assign": {"assignments": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"target": "string"
},
"call": {"body_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"call_type": "string",
"headers": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"method": "string",
"path_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"query_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"response": null,
"url": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"description": "string",
"if_else": {"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"else": [{ }
],
"then": [{ }
]
},
"name": "string",
"navigate": {"inputs": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"target": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"refresh": { },
"stepType": "call",
"visibility": {"action": "string",
"target": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"target_type": "string"
}
}
],
"title": "string"
}
],
"component_type": "screen",
"conditions": [{"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"disable": true,
"fallback_styles": {"property1": null,
"property2": null
},
"styles": {"property1": null,
"property2": null
},
"visibility_action": "string"
}
],
"description": "string",
"field_bindings": {"property1": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"property2": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"navigation_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"nodes": [{"bindings": [{"event_mode": "string",
"event_type": "string",
"id": "string",
"steps": [{"assign": {"assignments": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"target": "string"
},
"call": {"body_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"call_type": "string",
"headers": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"method": "string",
"path_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"query_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"response": null,
"url": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
}
},
"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"description": "string",
"if_else": {"condition": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"else": [{ }
],
"then": [{ }
]
},
"name": "string",
"navigate": {"inputs": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"target": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
}
},
"refresh": { },
"stepType": "call",
"visibility": {"action": "string",
"target": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_type": "string"
}
}
],
"title": "string"
}
],
"conditions": [{"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"disable": true,
"fallback_styles": {"property1": null,
"property2": null
},
"styles": {"property1": null,
"property2": null
},
"visibility_action": "string"
}
],
"field_bindings": {"property1": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"property2": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"navigation_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"nodes": [{ }
],
"props": {"property1": null,
"property2": null
},
"screen_layout": "string",
"styles": {"property1": null,
"property2": null
},
"variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
]
}
],
"org": "string",
"props": {"property1": null,
"property2": null
},
"root_component": "string",
"screen_layout": "string",
"styles": {"property1": null,
"property2": null
},
"sub_type": "string",
"tenant": "string",
"type": "string",
"variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"version": "string"
}

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"bindings": [{"event_mode": "string",
"event_type": "string",
"id": "string",
"steps": [{"assign": {"assignments": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"target": "string"
},
"call": {"body_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"call_type": "string",
"headers": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"method": "string",
"path_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"query_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"response": null,
"url": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"description": "string",
"if_else": {"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"else": [{ }
],
"then": [{ }
]
},
"name": "string",
"navigate": {"inputs": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"target": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"refresh": { },
"stepType": "call",
"visibility": {"action": "string",
"target": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"target_type": "string"
}
}
],
"title": "string"
}
],
"component_type": "screen",
"conditions": [{"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"disable": true,
"fallback_styles": {"property1": null,
"property2": null
},
"styles": {"property1": null,
"property2": null
},
"visibility_action": "string"
}
],
"description": "string",
"field_bindings": {"property1": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"property2": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"navigation_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"nodes": [{"bindings": [{"event_mode": "string",
"event_type": "string",
"id": "string",
"steps": [{"assign": {"assignments": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"target": "string"
},
"call": {"body_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"call_type": "string",
"headers": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"method": "string",
"path_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"query_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"response": null,
"url": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
}
},
"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"description": "string",
"if_else": {"condition": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"else": [{ }
],
"then": [{ }
]
},
"name": "string",
"navigate": {"inputs": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"target": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
}
},
"refresh": { },
"stepType": "call",
"visibility": {"action": "string",
"target": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_type": "string"
}
}
],
"title": "string"
}
],
"conditions": [{"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"disable": true,
"fallback_styles": {"property1": null,
"property2": null
},
"styles": {"property1": null,
"property2": null
},
"visibility_action": "string"
}
],
"field_bindings": {"property1": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"property2": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"navigation_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"nodes": [{ }
],
"props": {"property1": null,
"property2": null
},
"screen_layout": "string",
"styles": {"property1": null,
"property2": null
},
"variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
]
}
],
"org": "string",
"props": {"property1": null,
"property2": null
},
"root_component": "string",
"screen_layout": "string",
"styles": {"property1": null,
"property2": null
},
"sub_type": "string",
"tenant": "string",
"type": "string",
"variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"version": "string"
}

Get a screen component definition by name

Authorizations:

BearerAuth

path Parameters

name

required

string

Screen component definition name

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"bindings": [{"event_mode": "string",
"event_type": "string",
"id": "string",
"steps": [{"assign": {"assignments": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"target": "string"
},
"call": {"body_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"call_type": "string",
"headers": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"method": "string",
"path_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"query_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"response": null,
"url": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"description": "string",
"if_else": {"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"else": [{ }
],
"then": [{ }
]
},
"name": "string",
"navigate": {"inputs": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"target": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"refresh": { },
"stepType": "call",
"visibility": {"action": "string",
"target": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"target_type": "string"
}
}
],
"title": "string"
}
],
"component_type": "screen",
"conditions": [{"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"disable": true,
"fallback_styles": {"property1": null,
"property2": null
},
"styles": {"property1": null,
"property2": null
},
"visibility_action": "string"
}
],
"description": "string",
"field_bindings": {"property1": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"property2": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"navigation_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"nodes": [{"bindings": [{"event_mode": "string",
"event_type": "string",
"id": "string",
"steps": [{"assign": {"assignments": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"target": "string"
},
"call": {"body_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"call_type": "string",
"headers": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"method": "string",
"path_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"query_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"response": null,
"url": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
}
},
"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"description": "string",
"if_else": {"condition": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"else": [{ }
],
"then": [{ }
]
},
"name": "string",
"navigate": {"inputs": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"target": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
}
},
"refresh": { },
"stepType": "call",
"visibility": {"action": "string",
"target": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_type": "string"
}
}
],
"title": "string"
}
],
"conditions": [{"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"disable": true,
"fallback_styles": {"property1": null,
"property2": null
},
"styles": {"property1": null,
"property2": null
},
"visibility_action": "string"
}
],
"field_bindings": {"property1": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"property2": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"navigation_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"nodes": [{ }
],
"props": {"property1": null,
"property2": null
},
"screen_layout": "string",
"styles": {"property1": null,
"property2": null
},
"variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
]
}
],
"org": "string",
"props": {"property1": null,
"property2": null
},
"root_component": "string",
"screen_layout": "string",
"styles": {"property1": null,
"property2": null
},
"sub_type": "string",
"tenant": "string",
"type": "string",
"variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"version": "string"
}

Get a screen component definition by ID

Authorizations:

BearerAuth

path Parameters

required

string

Screen component definition ID

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"bindings": [{"event_mode": "string",
"event_type": "string",
"id": "string",
"steps": [{"assign": {"assignments": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"target": "string"
},
"call": {"body_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"call_type": "string",
"headers": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"method": "string",
"path_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"query_mappings": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"response": null,
"url": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"description": "string",
"if_else": {"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"else": [{ }
],
"then": [{ }
]
},
"name": "string",
"navigate": {"inputs": [{"name": "string",
"src_argument": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_argument": "string"
}
],
"target": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"refresh": { },
"stepType": "call",
"visibility": {"action": "string",
"target": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"target_type": "string"
}
}
],
"title": "string"
}
],
"component_type": "screen",
"conditions": [{"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"disable": true,
"fallback_styles": {"property1": null,
"property2": null
},
"styles": {"property1": null,
"property2": null
},
"visibility_action": "string"
}
],
"description": "string",
"field_bindings": {"property1": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"property2": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"navigation_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"nodes": [{"bindings": [{"event_mode": "string",
"event_type": "string",
"id": "string",
"steps": [{"assign": {"assignments": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"target": "string"
},
"call": {"body_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"call_type": "string",
"headers": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"method": "string",
"path_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"query_mappings": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"response": null,
"url": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
}
},
"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"description": "string",
"if_else": {"condition": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"else": [{ }
],
"then": [{ }
]
},
"name": "string",
"navigate": {"inputs": [{"name": null,
"src_argument": null,
"target_argument": null
}
],
"target": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
}
},
"refresh": { },
"stepType": "call",
"visibility": {"action": "string",
"target": {"functions": [null
],
"text": "string",
"title": "string",
"variables": [null
]
},
"target_type": "string"
}
}
],
"title": "string"
}
],
"conditions": [{"condition": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"disable": true,
"fallback_styles": {"property1": null,
"property2": null
},
"styles": {"property1": null,
"property2": null
},
"visibility_action": "string"
}
],
"field_bindings": {"property1": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"property2": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
}
},
"navigation_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"nodes": [{ }
],
"props": {"property1": null,
"property2": null
},
"screen_layout": "string",
"styles": {"property1": null,
"property2": null
},
"variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
]
}
],
"org": "string",
"props": {"property1": null,
"property2": null
},
"root_component": "string",
"screen_layout": "string",
"styles": {"property1": null,
"property2": null
},
"sub_type": "string",
"tenant": "string",
"type": "string",
"variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"version": "string"
}

Application UI Definition

Application UI Definitions Management

Get all application UI component definitions

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

[{"app_definition": "string",
"app_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"default_layout": "string",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"landing_page": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}
]

Create a application UI component definition

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Request Body schema: application/json
required

Application UI component definition

app_definition	string
	Array of objects (component_definitions.Variable) Application-wide global variables
	Array of objects (common.Attribute)
component_type	string (common.ComponentType) Enum: "screen" "app_ui" "workflow" "table" "entity" "etl" "automation" "agent" "document_processing" "schema_migration" "connector" "connector_request" "authenticator"
default_layout	string Default layout component for screens
description	string
id	string
is_archived	boolean
label	string
landing_page	string Initial screen/page to display
name	string
org	string
root_component	string
sub_type	string
tenant	string
type	string
version	string

Responses

Request samples

Payload

Content type

application/json

{"app_definition": "string",
"app_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"default_layout": "string",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"landing_page": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Response samples

Content type

application/json

{"app_definition": "string",
"app_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"default_layout": "string",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"landing_page": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Get a application UI component definition by name

Authorizations:

BearerAuth

path Parameters

name

required

string

Application UI component definition name

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"app_definition": "string",
"app_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"default_layout": "string",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"landing_page": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Get a application UI component definition by ID

Authorizations:

BearerAuth

path Parameters

required

string

Application UI component definition ID

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"app_definition": "string",
"app_variables": [{"default_value": {"functions": ["string"
],
"text": "string",
"title": "string",
"variables": ["string"
]
},
"is_array": true,
"label": "string",
"name": "string",
"object_schema": null,
"type": "string"
}
],
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"default_layout": "string",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"landing_page": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Workflow Definition

Workflow Definitions Management

Get all workflow component definitions

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

[{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"flows": [{"property1": {"displayName": "string",
"params": [{"key": "string",
"value": null
}
],
"steps": [{"property1": null,
"property2": null
}
]
},
"property2": {"displayName": "string",
"params": [{"key": "string",
"value": null
}
],
"steps": [{"property1": null,
"property2": null
}
]
}
}
],
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}
]

Create a workflow component definition

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Request Body schema: application/json
required

Workflow component definition

app_definition	string
	Array of objects (common.Attribute)
component_type	string (common.ComponentType) Enum: "screen" "app_ui" "workflow" "table" "entity" "etl" "automation" "agent" "document_processing" "schema_migration" "connector" "connector_request" "authenticator"
description	string
	Array of objects (component_definitions.FlowEntry)
id	string
is_archived	boolean
label	string
name	string
org	string
root_component	string
sub_type	string
tenant	string
type	string
version	string

Responses

Request samples

Payload

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"flows": [{"property1": {"displayName": "string",
"params": [{"key": "string",
"value": null
}
],
"steps": [{"property1": null,
"property2": null
}
]
},
"property2": {"displayName": "string",
"params": [{"key": "string",
"value": null
}
],
"steps": [{"property1": null,
"property2": null
}
]
}
}
],
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"flows": [{"property1": {"displayName": "string",
"params": [{"key": "string",
"value": null
}
],
"steps": [{"property1": null,
"property2": null
}
]
},
"property2": {"displayName": "string",
"params": [{"key": "string",
"value": null
}
],
"steps": [{"property1": null,
"property2": null
}
]
}
}
],
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Get a workflow component definition by name

Authorizations:

BearerAuth

path Parameters

name

required

string

Workflow component definition name

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"flows": [{"property1": {"displayName": "string",
"params": [{"key": "string",
"value": null
}
],
"steps": [{"property1": null,
"property2": null
}
]
},
"property2": {"displayName": "string",
"params": [{"key": "string",
"value": null
}
],
"steps": [{"property1": null,
"property2": null
}
]
}
}
],
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Get a workflow component definition by ID

Authorizations:

BearerAuth

path Parameters

required

string

Workflow component definition ID

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"flows": [{"property1": {"displayName": "string",
"params": [{"key": "string",
"value": null
}
],
"steps": [{"property1": null,
"property2": null
}
]
},
"property2": {"displayName": "string",
"params": [{"key": "string",
"value": null
}
],
"steps": [{"property1": null,
"property2": null
}
]
}
}
],
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Agent Definition

Agent Definitions Management

Get all agent component definitions

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

[{"agent_config": {"critic_prompt": "string",
"llm_config": {"frequency_penalty": 0,
"max_tokens": 0,
"model": "string",
"presence_penalty": 0,
"temperature": 0,
"top_p": 0
},
"prompt": "string",
"tools": [{"action": "string",
"component_reference": "string",
"description": "string",
"name": "string",
"tool_type": "agent"
}
]
},
"agent_type": "llm",
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}
]

Create a agent component definition

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Request Body schema: application/json
required

Agent component definition

	object (component_definitions.AgentConfig)
agent_type	string (component_definitions.AgentType) Enum: "llm" "deterministic"
app_definition	string
	Array of objects (common.Attribute)
component_type	string (common.ComponentType) Enum: "screen" "app_ui" "workflow" "table" "entity" "etl" "automation" "agent" "document_processing" "schema_migration" "connector" "connector_request" "authenticator"
description	string
id	string
is_archived	boolean
label	string
name	string
org	string
root_component	string
sub_type	string
tenant	string
type	string
version	string

Responses

Request samples

Payload

Content type

application/json

{"agent_config": {"critic_prompt": "string",
"llm_config": {"frequency_penalty": 0,
"max_tokens": 0,
"model": "string",
"presence_penalty": 0,
"temperature": 0,
"top_p": 0
},
"prompt": "string",
"tools": [{"action": "string",
"component_reference": "string",
"description": "string",
"name": "string",
"tool_type": "agent"
}
]
},
"agent_type": "llm",
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Response samples

Content type

application/json

{"agent_config": {"critic_prompt": "string",
"llm_config": {"frequency_penalty": 0,
"max_tokens": 0,
"model": "string",
"presence_penalty": 0,
"temperature": 0,
"top_p": 0
},
"prompt": "string",
"tools": [{"action": "string",
"component_reference": "string",
"description": "string",
"name": "string",
"tool_type": "agent"
}
]
},
"agent_type": "llm",
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Get a agent component definition by name

Authorizations:

BearerAuth

path Parameters

name

required

string

Agent component definition name

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"agent_config": {"critic_prompt": "string",
"llm_config": {"frequency_penalty": 0,
"max_tokens": 0,
"model": "string",
"presence_penalty": 0,
"temperature": 0,
"top_p": 0
},
"prompt": "string",
"tools": [{"action": "string",
"component_reference": "string",
"description": "string",
"name": "string",
"tool_type": "agent"
}
]
},
"agent_type": "llm",
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Get a agent component definition by ID

Authorizations:

BearerAuth

path Parameters

required

string

Agent component definition ID

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"agent_config": {"critic_prompt": "string",
"llm_config": {"frequency_penalty": 0,
"max_tokens": 0,
"model": "string",
"presence_penalty": 0,
"temperature": 0,
"top_p": 0
},
"prompt": "string",
"tools": [{"action": "string",
"component_reference": "string",
"description": "string",
"name": "string",
"tool_type": "agent"
}
]
},
"agent_type": "llm",
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}

Authentication

Authentication Management

Get Auth Config

Get Auth Config (client id, user pool id, region, cognito endpoint) for a given host.

Authorizations:

BearerAuth

query Parameters

host required	string Host (e.g. abcd.jiffy.ai or abcd.localhost:5173)
tenant_name required	string Tenant Name (e.g. abcd)

Responses

Response samples

Content type

application/json

{"app_name": "string",
"client_id": "string",
"cognito_endpoint": "string",
"region": "string",
"tenant_name": "string",
"user_pool_id": "string"
}

Generate Token

Generate Token for a given tenant , user and password. This is only for development purposes.

Authorizations:

BearerAuth

Request Body schema: application/json
required

Get Token Request

host	string
password	string
tenant_name	string
username	string

Responses

Request samples

Payload

Content type

application/json

{"host": "string",
"password": "string",
"tenant_name": "string",
"username": "string"
}

Response samples

Content type

application/json

{"access_token": "string",
"expires_in": 0,
"id_token": "string",
"refresh_token": "string"
}

Create User Pool

Creates a new AWS Cognito User Pool for an organization

Authorizations:

BearerAuth

path Parameters

orgName

required

string

Organization Name

Request Body schema: application/json
required

User Pool Creation Request

allowed_callback_urls	Array of strings
description	string
name	string
region	string

Responses

Request samples

Payload

Content type

application/json

{"allowed_callback_urls": ["string"
],
"description": "string",
"name": "string",
"region": "string"
}

Response samples

Content type

application/json

{"domain": "string",
"message": "string",
"name": "string",
"region": "string",
"user_pool_client_id": "string",
"user_pool_client_secret": "string",
"user_pool_id": "string"
}

Get User Pool

Retrieves information about a specific AWS Cognito User Pool

Authorizations:

BearerAuth

path Parameters

userPoolId

required

string

User Pool ID

Responses

Response samples

Content type

application/json

{"created_at": "string",
"description": "string",
"id": "string",
"name": "string",
"region": "string"
}

List Users

Lists all users in the specified user pool

Authorizations:

BearerAuth

path Parameters

userPoolId

required

string

User Pool ID

Responses

Response samples

Content type

application/json

[{"created_at": "string",
"email": "string",
"first_name": "string",
"last_login_at": "string",
"last_name": "string",
"status": "string",
"user_pool_id": "string",
"username": "string"
}
]

Delete User

Deletes a user from the specified user pool

Authorizations:

BearerAuth

path Parameters

userPoolId required	string User Pool ID
username required	string Username

Responses

Get User

Retrieves information about a specific user in a user pool

Authorizations:

BearerAuth

path Parameters

userPoolId required	string User Pool ID
username required	string Username

Responses

Response samples

Content type

application/json

{"created_at": "string",
"email": "string",
"first_name": "string",
"last_login_at": "string",
"last_name": "string",
"status": "string",
"user_pool_id": "string",
"username": "string"
}

Create User

Creates a new user in the specified AWS Cognito User Pool

Authorizations:

BearerAuth

Request Body schema: application/json
required

User Creation Request

email	string
first_name	string
last_name	string
password	string
user_pool_id	string
username	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"first_name": "string",
"last_name": "string",
"password": "string",
"user_pool_id": "string",
"username": "string"
}

Response samples

Content type

application/json

{"idp_reference": "string",
"message": "string",
"user_pool_id": "string",
"username": "string"
}

Update User

Updates information for a specific user in a user pool

Authorizations:

BearerAuth

Request Body schema: application/json
required

User Update Request

email	string
first_name	string
last_name	string
user_pool_id	string
username	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"first_name": "string",
"last_name": "string",
"user_pool_id": "string",
"username": "string"
}

Response samples

Content type

application/json

{"created_at": "string",
"email": "string",
"first_name": "string",
"last_login_at": "string",
"last_name": "string",
"status": "string",
"user_pool_id": "string",
"username": "string"
}

Reference

References Management

Get references

Authorizations:

BearerAuth

query Parameters

invalid	boolean Invalid (default: false)
page	integer Page (default: 0)
pageSize	integer Page Size (default: 10)
componentTypes	string Component Types (comma separated list of component type ids)

Responses

Response samples

Content type

application/json

[{"from_app_definition": "string",
"from_component_alias": "string",
"from_component_type": "screen",
"id": "string",
"is_archived": true,
"is_composition": true,
"name": {"label": "string",
"name": "string"
},
"tenant": "string",
"to_app_definition_key": "string",
"to_component_alias": "string",
"to_component_type": "screen"
}
]

Platform Models

Platform Models Management

Initialize Platform Models

Initialize the platform models

Authorizations:

BearerAuth

Responses

Response samples

Content type

application/json

{"property1": "string",
"property2": "string"
}

Get Platform Models Version

Get the version of the platform models

Authorizations:

BearerAuth

Responses

Response samples

Content type

application/json

{"property1": "string",
"property2": "string"
}

Preference

Preferences Management

Get preferences

Authorizations:

BearerAuth

query Parameters

org_id	string Organization ID
user_id	string User ID
is_merged required	boolean Is merged
page	integer Page (default: 0)
pageSize	integer Page Size (default: 10)
category	string Category

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Responses

Response samples

Content type

application/json

[{"category": "string",
"description": "string",
"id": "string",
"name": "string",
"org_id": "string",
"type": "string",
"user_id": "string",
"value": "string"
}
]

Create preference

Authorizations:

BearerAuth

query Parameters

org_id	string Organization ID
user_id	string User ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Request Body schema: application/json
required

Preference

category	string
description	string
id	string
name	string
org_id	string
type	string
user_id	string
value	string

Responses

Request samples

Payload

Content type

application/json

{"category": "string",
"description": "string",
"id": "string",
"name": "string",
"org_id": "string",
"type": "string",
"user_id": "string",
"value": "string"
}

Response samples

Content type

application/json

{"category": "string",
"description": "string",
"id": "string",
"name": "string",
"org_id": "string",
"type": "string",
"user_id": "string",
"value": "string"
}

Delete preference

Authorizations:

BearerAuth

path Parameters

required

string

Preference ID

query Parameters

org_id	string Organization ID
user_id	string User ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Responses

Response samples

Content type

application/json

{"property1": "string",
"property2": "string"
}

Update preference

Authorizations:

BearerAuth

path Parameters

required

string

Preference ID

query Parameters

org_id	string Organization ID
user_id	string User ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Request Body schema: application/json
required

Preference

category	string
description	string
id	string
name	string
org_id	string
type	string
user_id	string
value	string

Responses

Request samples

Payload

Content type

application/json

{"category": "string",
"description": "string",
"id": "string",
"name": "string",
"org_id": "string",
"type": "string",
"user_id": "string",
"value": "string"
}

Response samples

Content type

application/json

{"category": "string",
"description": "string",
"id": "string",
"name": "string",
"org_id": "string",
"type": "string",
"user_id": "string",
"value": "string"
}

User

Users Management

Get all users

Authorizations:

BearerAuth

query Parameters

offset	integer Offset
limit	integer Limit
email	string
first_name	string
id	string
idp_reference	string
last_name	string
user_org_id	string
username	string

Responses

Response samples

Content type

application/json

[{"email": "string",
"first_name": "string",
"id": "string",
"idp_reference": "string",
"last_name": "string",
"user_org_id": "string",
"username": "string"
}
]

Create a user

Authorizations:

BearerAuth

Request Body schema: application/json
required

User

email	string
first_name	string
idp_reference	string
last_name	string
password	string
user_org_id	string
user_pool_id	string
username	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"first_name": "string",
"idp_reference": "string",
"last_name": "string",
"password": "string",
"user_org_id": "string",
"user_pool_id": "string",
"username": "string"
}

Response samples

Content type

application/json

{"email": "string",
"first_name": "string",
"id": "string",
"idp_reference": "string",
"last_name": "string",
"user_org_id": "string",
"username": "string"
}

Delete a user

Authorizations:

BearerAuth

path Parameters

required

string

User ID

Responses

Update a user

Authorizations:

BearerAuth

path Parameters

required

string

User ID

Request Body schema: application/json
required

User

email	string
first_name	string
idp_reference	string
last_name	string
password	string
user_org_id	string
user_pool_id	string
username	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"first_name": "string",
"idp_reference": "string",
"last_name": "string",
"password": "string",
"user_org_id": "string",
"user_pool_id": "string",
"username": "string"
}

Response samples

Content type

application/json

{"email": "string",
"first_name": "string",
"id": "string",
"idp_reference": "string",
"last_name": "string",
"user_org_id": "string",
"username": "string"
}

Get user roles

Authorizations:

BearerAuth

path Parameters

required

string

User ID

Responses

Response samples

Content type

application/json

[{"description": "string",
"id": "string",
"is_active": true,
"is_platform_role": true,
"is_primary": true,
"name": "string"
}
]

Delete user role

Authorizations:

BearerAuth

path Parameters

id required	string User ID
roleId required	string Role ID

Responses

Create user role

Authorizations:

BearerAuth

path Parameters

id required	string User ID
roleId required	string Role ID

Responses

Response samples

Content type

application/json

{"role_id": "string",
"user_id": "string"
}

Get current user

Authorizations:

BearerAuth

Responses

Response samples

Content type

application/json

{"email": "string",
"first_name": "string",
"id": "string",
"idp_reference": "string",
"last_name": "string",
"user_org_id": "string",
"username": "string"
}

Role

Roles Management

Get all roles

Authorizations:

BearerAuth

query Parameters

offset	integer Offset
limit	integer Limit

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Responses

Response samples

Content type

application/json

[{"description": "string",
"id": "string",
"is_active": true,
"is_platform_role": true,
"is_primary": true,
"name": "string"
}
]

Create a role

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Request Body schema: application/json
required

Role

description	string
id	string
is_active	boolean
is_platform_role	boolean This is a platform role and cannot be deleted or modified
is_primary	boolean
name	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"id": "string",
"is_active": true,
"is_platform_role": true,
"is_primary": true,
"name": "string"
}

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"is_active": true,
"is_platform_role": true,
"is_primary": true,
"name": "string"
}

Delete a role

Authorizations:

BearerAuth

path Parameters

required

string

Role ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Responses

Get role permissions

Authorizations:

BearerAuth

path Parameters

required

string

Role ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Responses

Response samples

Content type

application/json

[{"action": "string",
"is_active": true,
"permission": "string",
"resource": "string",
"resource_type": "string",
"role": "string"
}
]

Delete role permission

Authorizations:

BearerAuth

path Parameters

id required	string Role ID
permissionId required	string Permission ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Responses

Create role permission

Create role permission with explicit resource, resource type, and action

Authorizations:

BearerAuth

path Parameters

required

string

Role ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Request Body schema: application/json
required

Permission

action	string
is_active	boolean
permission	string enum: allow, deny
resource	string
resource_type	string
role	string

Responses

Request samples

Payload

Content type

application/json

{"action": "string",
"is_active": true,
"permission": "string",
"resource": "string",
"resource_type": "string",
"role": "string"
}

Response samples

Content type

application/json

{"action": "string",
"is_active": true,
"permission": "string",
"resource": "string",
"resource_type": "string",
"role": "string"
}

Permission

Permissions Management

Check a permission

Check if a role or user has a specific permission (resource + action + resource type)

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Request Body schema: application/json
required

Check Permission Request

action	string
resource	string
resource_type	string
role_id	string
user_id	string

Responses

Request samples

Payload

Content type

application/json

{"action": "string",
"resource": "string",
"resource_type": "string",
"role_id": "string",
"user_id": "string"
}

Response samples

Content type

application/json

true

Organization

Organizations Management

Get all organizations

Authorizations:

BearerAuth

Responses

Response samples

Content type

application/json

[{"code": "string",
"description": "string",
"fully_qualified_alias": "string",
"id": "string",
"is_self_sufficient": true,
"level": 0,
"name": "string",
"parent_org_id": "string"
}
]

Create an organization

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Request Body schema: application/json
required

Organization

code	string
fully_qualified_alias	string
id	string
is_archived	boolean
is_self_sufficient	boolean
label	string
level	integer
name	string
parent_org_id	string
tenant	string

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"fully_qualified_alias": "string",
"id": "string",
"is_archived": true,
"is_self_sufficient": true,
"label": "string",
"level": 0,
"name": "string",
"parent_org_id": "string",
"tenant": "string"
}

Response samples

Content type

application/json

{"code": "string",
"description": "string",
"fully_qualified_alias": "string",
"id": "string",
"is_self_sufficient": true,
"level": 0,
"name": "string",
"parent_org_id": "string"
}

Delete an organization

Authorizations:

BearerAuth

path Parameters

required

string

Organization ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Responses

Get an organization

Authorizations:

BearerAuth

path Parameters

required

string

Organization ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Responses

Response samples

Content type

application/json

{"code": "string",
"description": "string",
"fully_qualified_alias": "string",
"id": "string",
"is_self_sufficient": true,
"level": 0,
"name": "string",
"parent_org_id": "string"
}

Update an organization

Authorizations:

BearerAuth

path Parameters

required

string

Organization ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Request Body schema: application/json
required

Organization

code	string
fully_qualified_alias	string
id	string
is_archived	boolean
is_self_sufficient	boolean
label	string
level	integer
name	string
parent_org_id	string
tenant	string

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"fully_qualified_alias": "string",
"id": "string",
"is_archived": true,
"is_self_sufficient": true,
"label": "string",
"level": 0,
"name": "string",
"parent_org_id": "string",
"tenant": "string"
}

Response samples

Content type

application/json

{"code": "string",
"description": "string",
"fully_qualified_alias": "string",
"id": "string",
"is_self_sufficient": true,
"level": 0,
"name": "string",
"parent_org_id": "string"
}

Drive

Drives Management

Download file or folder from S3

Download handles both single file downloads and folder (zip) downloads based on ?isFolder=true|false

Authorizations:

BearerAuth

path Parameters

bucket required	string S3 Bucket Name
path required	string S3 Object Path

query Parameters

isFolder

string

Set to true for folder download (returns zip)

header Parameters

X-Transfer-Acceleration

string

Set to true to enable transfer acceleration

Responses

Upload file or folder to S3

Upload handles both file uploads and folder (zip) uploads based on ?isFolder=true|false

Authorizations:

BearerAuth

path Parameters

bucket

required

string

S3 Bucket Name

query Parameters

isFolder	string Set to true for folder upload (expects zip)
skipRootFolder	string Set to true to skip root folder in zip

header Parameters

X-Upload-Strategy	string Upload strategy: simple or multipart (default: multipart)
X-Transfer-Acceleration	string Set to true to enable transfer acceleration

Request Body schema: multipart/form-data
required

files

required

string <binary>

Files to upload

Responses

Response samples

Content type

application/json

{ }

Upload file or folder to S3

Upload handles both file uploads and folder (zip) uploads based on ?isFolder=true|false

Authorizations:

BearerAuth

path Parameters

bucket required	string S3 Bucket Name
path required	string S3 Object Path

query Parameters

isFolder	string Set to true for folder upload (expects zip)
skipRootFolder	string Set to true to skip root folder in zip

header Parameters

X-Upload-Strategy	string Upload strategy: simple or multipart (default: multipart)
X-Transfer-Acceleration	string Set to true to enable transfer acceleration

Request Body schema: multipart/form-data
required

files

required

string <binary>

Files to upload

Responses

Response samples

Content type

application/json

{ }

Application Data

Application Data Management

Delete app data

Authorizations:

BearerAuth

path Parameters

tableName required	string Table name
id required	string Data ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Responses

Response samples

Content type

application/json

{ }

Get app data

Get app data , filterable by query params by field name

Authorizations:

BearerAuth

path Parameters

tableName

required

string

Table name

query Parameters

offset	integer Offset
limit	integer Limit
filter	string Filter - can be used to filter the data by field name, value pair, example: field1=value1&field2=value2

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Responses

Response samples

Content type

application/json

[{ }
]

Create app data

Authorizations:

BearerAuth

path Parameters

tableName

required

string

Table name

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Request Body schema: application/json
required

Data

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{ }

Update app data

Authorizations:

BearerAuth

path Parameters

tableName required	string Table name
id required	string Data ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Request Body schema: application/json
required

Data

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{ }

Get app data by id

Authorizations:

BearerAuth

path Parameters

tableName required	string Table name
id required	string Data ID

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Responses

Response samples

Content type

application/json

{ }

Search app data

Authorizations:

BearerAuth

path Parameters

tableName

required

string

Table name

query Parameters

offset	integer Offset
limit	integer Limit

header Parameters

X-Jiffy-Tenant required	string Tenant Name
X-Jiffy-User-Id required	string User ID
X-Jiffy-Env required	string Environment

Request Body schema: application/json
required

Filter

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

[{ }
]

builtin-authenticators

Get all built-in authenticators

Responses

Response samples

Content type

application/json

[{ }
]

Get a built-in authenticator by name

Get a specific built-in authenticator by name

path Parameters

name

required

string

Built-in authenticator name

Responses

Response samples

Content type

application/json

{ }

Component definitions

Get all component definitions

Authorizations:

BearerAuth

path Parameters

componentType

required

string

Component type

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

[{"Properties": null,
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"type": "string",
"version": "string"
}
]

Authenticator Definition

Get all authenticator component definitions

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

[{"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"is_client_based_authenticator": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
},
"type": "string",
"version": "string"
}
]

Create an authenticator component definition

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Request Body schema: application/json
required

Authenticator component definition

	object
	object
	object
app_definition	string
	Array of objects (common.Attribute)
	object
auth_certificate	string
	object
auth_http_method	string (component_definitions.HttpMethod) Enum: "GET" "POST" "PUT" "PATCH" "DELETE" "HEAD" "OPTIONS" "CONNECT" "TRACE"
auth_key	string
auth_post_response_script	string
auth_url	string
	object
	Array of objects (component_definitions.ChainedAuthenticator)
component_type	string (common.ComponentType) Enum: "screen" "app_ui" "workflow" "table" "entity" "etl" "automation" "agent" "document_processing" "schema_migration" "connector" "connector_request" "authenticator"
description	string
id	string
is_archived	boolean
is_client_based_authenticator	boolean
label	string
name	string
org	string
	object
root_component	string
sub_type	string
tenant	string
token_expiry_duration_preference_key	string
	object
	object
token_refresh_http_method	string (component_definitions.HttpMethod) Enum: "GET" "POST" "PUT" "PATCH" "DELETE" "HEAD" "OPTIONS" "CONNECT" "TRACE"
token_refresh_post_response_script	string
token_refresh_url	string
	object
type	string
version	string

Responses

Request samples

Payload

Content type

application/json

{"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"is_client_based_authenticator": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
},
"type": "string",
"version": "string"
}

Response samples

Content type

application/json

{"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"is_client_based_authenticator": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
},
"type": "string",
"version": "string"
}

Get an authenticator component definition by name

Authorizations:

BearerAuth

path Parameters

name

required

string

Authenticator component definition name

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"is_client_based_authenticator": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
},
"type": "string",
"version": "string"
}

Get an authenticator component definition by ID

Authorizations:

BearerAuth

path Parameters

required

string

Authenticator component definition ID

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"is_client_based_authenticator": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
},
"type": "string",
"version": "string"
}

Connector Definition

Get all connector component definitions

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

[{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"post_response_script": "string",
"pre_request_script": "string",
"provider_name": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"version": "string"
}
]

Create a connector component definition

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Request Body schema: application/json
required

Connector component definition

app_definition	string
	Array of objects (common.Attribute)
	object
base_url	string Connector-specific fields
component_type	string (common.ComponentType) Enum: "screen" "app_ui" "workflow" "table" "entity" "etl" "automation" "agent" "document_processing" "schema_migration" "connector" "connector_request" "authenticator"
description	string
id	string
is_archived	boolean
label	string
name	string
org	string
	object
post_response_script	string
pre_request_script	string
provider_name	string
root_component	string
sub_type	string
tenant	string
timeout	integer
type	string
version	string

Responses

Request samples

Payload

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"post_response_script": "string",
"pre_request_script": "string",
"provider_name": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"version": "string"
}

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"post_response_script": "string",
"pre_request_script": "string",
"provider_name": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"version": "string"
}

Get a connector component definition by name

Authorizations:

BearerAuth

path Parameters

name

required

string

Connector component definition name

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"post_response_script": "string",
"pre_request_script": "string",
"provider_name": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"version": "string"
}

Get a connector component definition by ID

Authorizations:

BearerAuth

path Parameters

required

string

Connector component definition ID

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"post_response_script": "string",
"pre_request_script": "string",
"provider_name": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"version": "string"
}

Connector Request Definition

Get all connector-request component definitions

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

[{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"http_method": "GET",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": [{"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
],
"post_response_script": "string",
"pre_request_script": "string",
"requestBody": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"contentType": "string",
"description": "string",
"required": true
},
"response_type": "string",
"responses": {"property1": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
},
"property2": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"url": "string",
"version": "string"
}
]

Create a connector-request component definition

Authorizations:

BearerAuth

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Request Body schema: application/json
required

Connector-request component definition

app_definition	string
	Array of objects (common.Attribute)
	object
base_url	string Connector-specific fields
component_type	string (common.ComponentType) Enum: "screen" "app_ui" "workflow" "table" "entity" "etl" "automation" "agent" "document_processing" "schema_migration" "connector" "connector_request" "authenticator"
description	string
http_method	string Enum: "GET" "POST" "PUT" "PATCH" "DELETE" "HEAD" "OPTIONS" "CONNECT" "TRACE" OpenAPI Operation fields
id	string
is_archived	boolean
label	string
name	string
org	string
	Array of objects (component_definitions.OpenAPIParameter) OpenAPI Parameters (query, header, path, cookie)
post_response_script	string
pre_request_script	string
	object OpenAPI RequestBody
response_type	string Response configuration
	object OpenAPI Responses (map of status code to Response)
root_component	string
sub_type	string
tenant	string
timeout	integer
type	string
url required	string
version	string

Responses

Request samples

Payload

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"http_method": "GET",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": [{"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
],
"post_response_script": "string",
"pre_request_script": "string",
"requestBody": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"contentType": "string",
"description": "string",
"required": true
},
"response_type": "string",
"responses": {"property1": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
},
"property2": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"url": "string",
"version": "string"
}

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"http_method": "GET",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": [{"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
],
"post_response_script": "string",
"pre_request_script": "string",
"requestBody": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"contentType": "string",
"description": "string",
"required": true
},
"response_type": "string",
"responses": {"property1": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
},
"property2": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"url": "string",
"version": "string"
}

Get a connector-request component definition by name

Authorizations:

BearerAuth

path Parameters

name

required

string

Connector-request component definition name

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"http_method": "GET",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": [{"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
],
"post_response_script": "string",
"pre_request_script": "string",
"requestBody": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"contentType": "string",
"description": "string",
"required": true
},
"response_type": "string",
"responses": {"property1": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
},
"property2": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"url": "string",
"version": "string"
}

Get a connector-request component definition by ID

Authorizations:

BearerAuth

path Parameters

required

string

Connector-request component definition ID

header Parameters

X-Jiffy-Tenant required	string Tenant identifier
X-Jiffy-User-Id required	string User ID
X-Jiffy-App-Definition-Key	string Application definition key (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Definition	string Application definition (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-App-Name	string Application name (one of App-Definition-Key, App-Definition, or App-Name is required)
X-Jiffy-Roles	string Comma-separated list of user roles
X-Jiffy-Env	string Environment (e.g., develop, staging, prod)
X-Jiffy-Tenant-Class	string Tenant class (default: default)
X-Jiffy-User-Org-Hierarchy	string User organization hierarchy (e.g., org1-1,org2-2)

Responses

Response samples

Content type

application/json

{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"http_method": "GET",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": [{"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
],
"post_response_script": "string",
"pre_request_script": "string",
"requestBody": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"contentType": "string",
"description": "string",
"required": true
},
"response_type": "string",
"responses": {"property1": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
},
"property2": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"url": "string",
"version": "string"
}

connectors

List connector configuration IDs

Returns all configuration IDs configured for the specified connector in the current environment

path Parameters

connectorName

required

string

Connector name

Responses

Response samples

Content type

application/json

{"configs": [{"authenticatorLabel": "string",
"authenticatorName": "string",
"configId": "string"
}
]
}

Get connector request parameters

Returns all parameters for a connector request with priority: 1) Preferences with config ID, 2) Connector request, 3) Connector, 4) Authenticator. Excludes secret parameters.

path Parameters

requestName

required

string

Connector request name

query Parameters

configId

string

Configuration ID (optional)

Responses

Response samples

Content type

application/json

{"authenticators": {"property1": ["string"
],
"property2": ["string"
]
},
"parameters": {"property1": "string",
"property2": "string"
}
}

Platform

Health Check

Responses

Response samples

Content type

application/json

{ }

Initialize Platform

Initialize the platform models, create indexes etc. It is no-op if already initialized.

Responses

Response samples

Content type

application/json

{ }

openapi-parser

Parse OpenAPI specification file

Parses an OpenAPI specification file (JSON or YAML) and converts it to ConnectorComponentModel, ConnectorRequestComponentModel, and AuthenticatorComponentModel

query Parameters

connectorName	string Name for the connector component (required if connectorId is not provided)
connectorId	string ID of existing connector to use (if provided, connectorName is ignored)
appDefinition required	string App definition identifier
providerName	string Provider name (required if connectorId is not provided)
excludeAuthenticators	boolean Exclude authenticator models and config generation (default: false)

Request Body schema: multipart/form-data
required

file

required

string <binary>

OpenAPI specification file (JSON or YAML)

Responses

Response samples

Content type

application/json

{"authenticators": [{"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"is_client_based_authenticator": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
},
"type": "string",
"version": "string"
}
],
"connector": {"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"post_response_script": "string",
"pre_request_script": "string",
"provider_name": "string",
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"version": "string"
},
"connectorRequests": [{"app_definition": "string",
"attributes": [{"attributes": [{ }
],
"component_reference": "string",
"name": "string",
"type": "string"
}
],
"authenticators": {"property1": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
},
"property2": {"api_body": { },
"api_headers": {"property1": "string",
"property2": "string"
},
"api_url_search_params": {"property1": "string",
"property2": "string"
},
"auth_body": { },
"auth_certificate": "string",
"auth_headers": {"property1": "string",
"property2": "string"
},
"auth_http_method": "GET",
"auth_key": "string",
"auth_post_response_script": "string",
"auth_url": "string",
"auth_url_search_params": {"property1": "string",
"property2": "string"
},
"chained_authenticators": [{"authenticator_name": "string",
"order": 0,
"output_variable_name": "string"
}
],
"is_client_based_authenticator": true,
"parameters": {"property1": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
},
"property2": {"datatype": "String",
"editable_by_end_user": true,
"editable_by_platform_user": true,
"is_secret": false,
"label": "Authorization Header",
"value": "string",
"visible": true
}
},
"token_expiry_duration_preference_key": "string",
"token_refresh_body": { },
"token_refresh_headers": {"property1": "string",
"property2": "string"
},
"token_refresh_http_method": "GET",
"token_refresh_post_response_script": "string",
"token_refresh_url": "string",
"token_refresh_url_search_params": {"property1": "string",
"property2": "string"
}
}
},
"base_url": "string",
"component_type": "screen",
"description": "string",
"http_method": "GET",
"id": "string",
"is_archived": true,
"label": "string",
"name": "string",
"org": "string",
"parameters": [{"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
],
"post_response_script": "string",
"pre_request_script": "string",
"requestBody": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"contentType": "string",
"description": "string",
"required": true
},
"response_type": "string",
"responses": {"property1": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
},
"property2": {"content": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
},
"headers": {"property1": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
},
"property2": {"description": "string",
"in": "query",
"name": "string",
"required": true,
"schema": {"additionalProperties": null,
"allOf": [{ }
],
"anyOf": [{ }
],
"default": null,
"deprecated": true,
"description": "string",
"enum": [null
],
"format": "string",
"items": { },
"maxItems": 0,
"maxLength": 0,
"maxProperties": 0,
"maximum": 0,
"minItems": 0,
"minLength": 0,
"minProperties": 0,
"minimum": 0,
"multipleOf": 0,
"not": { },
"nullable": true,
"oneOf": [{ }
],
"pattern": "string",
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"required": ["string"
],
"title": "string",
"type": "string",
"uniqueItems": true,
"writeOnly": true
}
}
}
}
},
"root_component": "string",
"sub_type": "string",
"tenant": "string",
"timeout": 0,
"type": "string",
"url": "string",
"version": "string"
}
],
"errors": ["string"
],
"warnings": ["string"
]
}

Provider

Get all providers

Authorizations:

BearerAuth

query Parameters

offset	integer Offset
limit	integer Limit

Responses

Response samples

Content type

application/json

[{"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"logo_url": "string",
"name": "string"
}
]

Create a provider

Authorizations:

BearerAuth

Request Body schema: application/json
required

Provider

description	string
label	string
logo_url	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"label": "string",
"logo_url": "string",
"name": "string"
}

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"logo_url": "string",
"name": "string"
}

Delete a provider

Authorizations:

BearerAuth

path Parameters

required

string

Provider ID

Responses

Get a provider

Get a provider by name

Authorizations:

BearerAuth

path Parameters

name

required

string

Provider Name

Responses

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"logo_url": "string",
"name": "string"
}

Update a provider

Authorizations:

BearerAuth

path Parameters

name

required

string

Provider Name

Request Body schema: application/json
required

Provider

description	string
label	string
logo_url	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"label": "string",
"logo_url": "string",
"name": "string"
}

Response samples

Content type

application/json

{"description": "string",
"id": "string",
"is_archived": true,
"label": "string",
"logo_url": "string",
"name": "string"
}

proxy

Handle unauthenticated proxy callback

Handles OAuth callback requests without authentication and sends request details via postMessage

Responses

Handle unauthenticated proxy callback

Handles OAuth callback requests without authentication and sends request details via postMessage

Responses

Handle authenticated proxy callback

Handles OAuth callback requests with authentication and stores request body, URL parameters, and headers

path Parameters

connectorName required	string Connector name
requestName required	string Request name
authenticatorName required	string Authenticator name
configId required	string Config ID

Responses

Response samples

Content type

application/json

{"property1": "string",
"property2": "string"
}

Handle authenticated proxy callback

Handles OAuth callback requests with authentication and stores request body, URL parameters, and headers

path Parameters

connectorName required	string Connector name
requestName required	string Request name
authenticatorName required	string Authenticator name
configId required	string Config ID

Responses

Response samples

Content type

application/json

{"property1": "string",
"property2": "string"
}

System

Get System Version

Get the version of the system

Responses

Response samples

Content type

application/json

{"property1": "string",
"property2": "string"
}

Phoenix App Manager API (1.0)

Getting Started

Get Auth Config

Authorizations:

query Parameters

Responses

Response samples

Generate Token

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Tenant

Get all tenants

Authorizations:

query Parameters

Responses

Response samples

Create a tenant

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a tenant

Authorizations:

path Parameters

Responses

Get a tenant

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update a tenant

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Application

Get all applications

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Create an application

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an application

Authorizations:

path Parameters

header Parameters

Responses

Get an application

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update an application

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Application Definition

Get all application definitions

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required