Summary
Updates a profile.
Description
Update a profile in IAP.
Route
PUT /profiles/:id
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Contains the id for the selected profile. |
| properties | object | yes | Contains the properties for the selected profile. |
{ "properties": { "applicationProps": { "directory": "/opt/pronghorn/current/node_modules", "description": "Application" }, "uiProps": { "layout": "node_modules/@itential/pronghorn-core/ui/views/layout.jade", "home": "node_modules/@itential/pronghorn-core/ui/views/home.jade", "login": "node_modules/@itential/pronghorn-core/ui/views/login.jade", "profile": "node_modules/@itential/pronghorn-core/ui/views/profile.jade", "fav_icon": "node_modules/@itential/pronghorn-core/ui/img/favicon.ico", "description": "UI" }, "authenticationProps": { "uniqueSession": false, "admins": [ { "provenance": "Local AAA", "group": "" }, { "provenance": "", "group": "" }, { "provenance": "", "group": "admin" } ], "sso": { "enabled": false, "config": "" }, "description": "Authentication", "logoutTime": 20, "cookieName": "token", "brokerPrincipal": false }, "expressProps": { "express_http": { "enable": false, "port": 40309 }, "express_https": { "enable": false, "port": 53987, "key": "/opt/pronghorn/current/keys/key.pem", "cert": "/opt/pronghorn/current/keys/cert.pem", "secureProtocol": "TLSv1_2_method", "client_reneg_limit": 1, "client_reneg_window": 600, "passphrase": "dolor", "ciphers": "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256" }, "description": "Express Server", "cacheControl": false, "timeout": 300000, "access_control_allow_origin": "*", "allowedHttpOptionalVerbs": [] }, "loggerProps": { "log_directory": "/var/log/pronghorn", "log_filename": "pronghorn.log", "log_max_file_size": 1048576, "log_max_files": 100, "log_level": "trace", "console_level": "trace", "description": "Logging", "webserver": { "log_directory": "/var/log/pronghorn", "log_filename": "webserver.log" }, "syslog": { "level": "error", "facility": "local0", "type": "BSD", "host": "localhost", "port": 514, "protocol": "udp4", "pid": "process.pid", "localhost": "localhost", "app_name": "process.title", "eol": "" } }, "redisProps": { "host": "127.0.0.1", "port": 6379, "db": 0, "username": "admin", "password": "$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e", "maxRetriesPerRequest": 20, "maxHeartbeatWriteRetries": 20 }, "auditProps": { "audit": true, "brokerValidation": true, "description": "Audit" }, "pathProps": { "encrypted": true, "description": "Path Properties" }, "alarmProps": [], "id": "profile1", "services": [ "WorkflowBuilder", "WorkflowBuilder" ], "description": "An IAP Profile", "adapterStrategy": { "device": { "adapterTypes": [], "exceptions": { "runCommand": "" } } }, "systemProps": { "shutdownTimeout": 3, "servicesBlacklist": [ "Local AAA", "Local AAA", "Local AAA" ], "launchDelay": 5, "launchTimeout": 60, "serviceHealthCheckInterval": 5, "serviceHealthCheckUnhealthyThreshold": 3, "deadProcessCheck": true, "deadProcessCheckInterval": 5, "deadProcessMaxPeriod": 15, "externalRequestTimeout": 5, "deviceCountPollingInterval": 24 }, "integrationProps": { "threadCount": 5, "timeout": 15000 }, "retryStrategy": { "maxRetries": 5, "retryResetTimer": 30000 } } }
{ "type": "object", "properties": { "properties": { "title": "properties", "type": "object", "properties": { "applicationProps": { "$ref": "profiles-schema#/definitions/applicationProps" }, "uiProps": { "$ref": "profiles-schema#/definitions/uiProps" }, "authenticationProps": { "$ref": "profiles-schema#/definitions/authenticationProps" }, "expressProps": { "$ref": "profiles-schema#/definitions/expressProps" }, "loggerProps": { "$ref": "profiles-schema#/definitions/loggerProps" }, "redisProps": { "$ref": "profiles-schema#/definitions/redisProps" }, "auditProps": { "$ref": "profiles-schema#/definitions/auditProps" }, "pathProps": { "$ref": "profiles-schema#/definitions/pathProps" }, "alarmProps": { "$ref": "profiles-schema#/definitions/alarmProps" }, "id": { "$ref": "profiles-schema#/definitions/id" }, "services": { "$ref": "profiles-schema#/definitions/services" }, "description": { "$ref": "profiles-schema#/definitions/description" }, "adapterStrategy": { "$ref": "profiles-schema#/definitions/adapterStrategy" }, "systemProps": { "$ref": "profiles-schema#/definitions/systemProps" }, "integrationProps": { "$ref": "profiles-schema#/definitions/integrationProps" }, "retryStrategy": { "$ref": "profiles-schema#/definitions/retryStrategy" } }, "additionalProperties": false } }, "required": [ "properties" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| result | object | The output of the update process. |
{ "status": "OK", "message": "A sample success message", "data": { "applicationProps": { "directory": "/opt/pronghorn/current/node_modules", "description": "Application" }, "uiProps": { "layout": "node_modules/@itential/pronghorn-core/ui/views/layout.jade", "home": "node_modules/@itential/pronghorn-core/ui/views/home.jade", "login": "node_modules/@itential/pronghorn-core/ui/views/login.jade", "profile": "node_modules/@itential/pronghorn-core/ui/views/profile.jade", "fav_icon": "node_modules/@itential/pronghorn-core/ui/img/favicon.ico", "description": "UI" }, "authenticationProps": { "uniqueSession": false, "admins": [ { "provenance": "", "group": "" }, { "provenance": "", "group": "admin" }, { "provenance": "Local AAA", "group": "admin" } ], "sso": { "enabled": false, "config": "" }, "description": "Authentication", "logoutTime": 60, "cookieName": "pronghorn_token", "brokerPrincipal": false }, "expressProps": { "express_http": { "enable": false, "port": 63066 }, "express_https": { "enable": false, "port": 10279, "key": "/opt/pronghorn/current/keys/key.pem", "cert": "/opt/pronghorn/current/keys/cert.pem", "secureProtocol": "TLSv1_2_method", "client_reneg_limit": 1, "client_reneg_window": 600, "passphrase": "in", "ciphers": "" }, "description": "Express Server", "cacheControl": false, "timeout": 300000, "access_control_allow_origin": "*", "allowedHttpOptionalVerbs": [] }, "loggerProps": { "log_directory": "/var/log/pronghorn", "log_filename": "pronghorn.log", "log_max_file_size": 1048576, "log_max_files": 100, "log_level": "warn", "console_level": "spam", "description": "Logger Settings", "webserver": { "log_directory": "/var/log/pronghorn", "log_filename": "webserver.log" }, "syslog": { "level": "warning", "facility": "local0", "type": "BSD", "path": "", "pid": "process.pid", "localhost": "localhost", "app_name": "process.title", "eol": "CR" } }, "redisProps": { "host": "::1", "port": 6379, "db": 0, "username": "admin", "password": "$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e", "maxRetriesPerRequest": 20, "maxHeartbeatWriteRetries": 20 }, "auditProps": { "audit": true, "brokerValidation": true, "description": "Audit" }, "pathProps": { "encrypted": true, "description": "Path Properties" }, "alarmProps": [ { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "trap", "description": "Alarm" }, { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "trap", "description": "Alarm" }, { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "trap", "description": "Alarm" }, { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "inform", "description": "Alarm" } ], "id": "profile1", "services": [ "FormBuilder", "WorkflowBuilder", "FormBuilder", "FormBuilder" ], "description": "An IAP Profile", "adapterStrategy": { "device": { "adapterTypes": [], "exceptions": { "runCommand": "" } } }, "systemProps": { "shutdownTimeout": 3, "servicesBlacklist": [ "Local AAA", "Local AAA", "Local AAA" ], "launchDelay": 5, "launchTimeout": 60, "serviceHealthCheckInterval": 5, "serviceHealthCheckUnhealthyThreshold": 3, "deadProcessCheck": false, "deadProcessCheckInterval": 5, "deadProcessMaxPeriod": 15, "externalRequestTimeout": 5, "deviceCountPollingInterval": 24 }, "prebuiltProps": { "repoConfigs": { "@itentialopensource": { "enabled": true, "type": "gitlab", "hostname": "gitlab.com", "path": "itentialopensource/pre-built-automations", "credentials": { "token": "uTc_P4pnMAEsLbQHmyOt" } } } }, "integrationProps": { "threadCount": 5, "timeout": 15000 }, "retryStrategy": { "maxRetries": 5, "retryResetTimer": 30000 } } }
{ "title": "result", "type": "object", "properties": { "status": { "$ref": "common-schema#/definitions/status" }, "message": { "$ref": "common-schema#/definitions/message" }, "data": { "$ref": "profiles-schema" } } }