put /proxyservice/{id}
Stability index
This API is extremely reliable and will not be broken unless absolutely necessary.
Path parameters
- id (required)
Request body
- item (required)
- ProxyService
Query parameters
- privileges (optional)
Return type
Example data
Content-Type: application/json
{
"privileges" : [ "privileges", "privileges" ],
"settings" : {
"virtualProxies" : [ {
"hasSecureAttributeHttp" : true,
"privileges" : [ "privileges", "privileges" ],
"headerAuthenticationStaticUserDirectory" : "headerAuthenticationStaticUserDirectory",
"jwtAttributeMap" : [ {
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"jwtAttribute" : "jwtAttribute",
"isMandatory" : true
}, {
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"jwtAttribute" : "jwtAttribute",
"isMandatory" : true
} ],
"defaultVirtualProxy" : true,
"prefix" : "prefix",
"oidcAttributeClientId" : "oidcAttributeClientId",
"magicLinkFriendlyName" : "magicLinkFriendlyName",
"disableOidcOptionalAttributesParsing" : true,
"samlHostUri" : "http://example.com/aeiou",
"loadBalancingAlgorithm" : 8,
"authenticationModuleRedirectUri" : "http://example.com/aeiou",
"loadBalancingServerNodes" : [ {
"privileges" : [ "privileges", "privileges" ],
"hostName" : "hostName",
"roles" : [ {
"privileges" : [ "privileges", "privileges" ],
"definition" : 3,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"privileges" : [ "privileges", "privileges" ],
"definition" : 3,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"temporaryfilepath" : "temporaryfilepath",
"serviceCluster" : {
"privileges" : [ "privileges", "privileges" ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
}, {
"privileges" : [ "privileges", "privileges" ],
"hostName" : "hostName",
"roles" : [ {
"privileges" : [ "privileges", "privileges" ],
"definition" : 3,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"privileges" : [ "privileges", "privileges" ],
"definition" : 3,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"temporaryfilepath" : "temporaryfilepath",
"serviceCluster" : {
"privileges" : [ "privileges", "privileges" ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
} ],
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"oidcAttributePicture" : "oidcAttributePicture",
"useStickyLoadBalancing" : true,
"websocketCrossOriginWhiteList" : [ "websocketCrossOriginWhiteList", "websocketCrossOriginWhiteList" ],
"enableEngineSaturationCheck" : true,
"jwtAttributeUserDirectory" : "jwtAttributeUserDirectory",
"hasSecureAttributeHttps" : true,
"oidcAttributeMap" : [ {
"oidcAttribute" : "oidcAttribute",
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isMandatory" : true
}, {
"oidcAttribute" : "oidcAttribute",
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isMandatory" : true
} ],
"samlAttributeUserId" : "samlAttributeUserId",
"samlSlo" : true,
"oidcAttributeGroups" : "oidcAttributeGroups",
"sessionModuleBaseUri" : "http://example.com/aeiou",
"windowsAuthenticationEnabledDevicePattern" : "windowsAuthenticationEnabledDevicePattern",
"tags" : [ {
"privileges" : [ "privileges", "privileges" ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"privileges" : [ "privileges", "privileges" ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ],
"oidcRealm" : "oidcRealm",
"jwtAudience" : "jwtAudience",
"oidcConfigurationEndpointUri" : "http://example.com/aeiou",
"authenticationMethod" : 7,
"sessionInactivityTimeout" : 67067,
"oidcAttributeEmail" : "oidcAttributeEmail",
"loadBalancingModuleBaseUri" : "http://example.com/aeiou",
"sameSiteAttributeHttps" : 5,
"samlAttributeMap" : [ {
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"samlAttribute" : "samlAttribute",
"isMandatory" : true
}, {
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"samlAttribute" : "samlAttribute",
"isMandatory" : true
} ],
"oidcAttributeSub" : "oidcAttributeSub",
"anonymousAccessMode" : 4,
"oidcClientId" : "oidcClientId",
"sameSiteAttributeHttp" : 9,
"description" : "description",
"samlMetadataIdP" : "samlMetadataIdP",
"additionalResponseHeaders" : "additionalResponseHeaders",
"samlEntityId" : "samlEntityId",
"samlAttributeUserDirectory" : "samlAttributeUserDirectory",
"disableSamlOptionalAttributesParsing" : true,
"oidcClientSecret" : "oidcClientSecret",
"headerAuthenticationHeaderName" : "headerAuthenticationHeaderName",
"headerAuthenticationDynamicUserDirectory" : "headerAuthenticationDynamicUserDirectory",
"extendedSecurityEnvironment" : true,
"oidcAttributeName" : "oidcAttributeName",
"oidcScope" : "oidcScope",
"samlAttributeSigningAlgorithm" : 6,
"enableEngineHealthCheckData" : true,
"sessionCookieHeaderName" : "sessionCookieHeaderName",
"headerAuthenticationMode" : 1,
"magicLinkHostUri" : "http://example.com/aeiou",
"jwtPublicKeyCertificate" : "jwtPublicKeyCertificate",
"sessionCookieDomain" : "sessionCookieDomain",
"jwtAttributeUserId" : "jwtAttributeUserId"
}, {
"hasSecureAttributeHttp" : true,
"privileges" : [ "privileges", "privileges" ],
"headerAuthenticationStaticUserDirectory" : "headerAuthenticationStaticUserDirectory",
"jwtAttributeMap" : [ {
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"jwtAttribute" : "jwtAttribute",
"isMandatory" : true
}, {
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"jwtAttribute" : "jwtAttribute",
"isMandatory" : true
} ],
"defaultVirtualProxy" : true,
"prefix" : "prefix",
"oidcAttributeClientId" : "oidcAttributeClientId",
"magicLinkFriendlyName" : "magicLinkFriendlyName",
"disableOidcOptionalAttributesParsing" : true,
"samlHostUri" : "http://example.com/aeiou",
"loadBalancingAlgorithm" : 8,
"authenticationModuleRedirectUri" : "http://example.com/aeiou",
"loadBalancingServerNodes" : [ {
"privileges" : [ "privileges", "privileges" ],
"hostName" : "hostName",
"roles" : [ {
"privileges" : [ "privileges", "privileges" ],
"definition" : 3,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"privileges" : [ "privileges", "privileges" ],
"definition" : 3,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"temporaryfilepath" : "temporaryfilepath",
"serviceCluster" : {
"privileges" : [ "privileges", "privileges" ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
}, {
"privileges" : [ "privileges", "privileges" ],
"hostName" : "hostName",
"roles" : [ {
"privileges" : [ "privileges", "privileges" ],
"definition" : 3,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"privileges" : [ "privileges", "privileges" ],
"definition" : 3,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"temporaryfilepath" : "temporaryfilepath",
"serviceCluster" : {
"privileges" : [ "privileges", "privileges" ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
} ],
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"oidcAttributePicture" : "oidcAttributePicture",
"useStickyLoadBalancing" : true,
"websocketCrossOriginWhiteList" : [ "websocketCrossOriginWhiteList", "websocketCrossOriginWhiteList" ],
"enableEngineSaturationCheck" : true,
"jwtAttributeUserDirectory" : "jwtAttributeUserDirectory",
"hasSecureAttributeHttps" : true,
"oidcAttributeMap" : [ {
"oidcAttribute" : "oidcAttribute",
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isMandatory" : true
}, {
"oidcAttribute" : "oidcAttribute",
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"isMandatory" : true
} ],
"samlAttributeUserId" : "samlAttributeUserId",
"samlSlo" : true,
"oidcAttributeGroups" : "oidcAttributeGroups",
"sessionModuleBaseUri" : "http://example.com/aeiou",
"windowsAuthenticationEnabledDevicePattern" : "windowsAuthenticationEnabledDevicePattern",
"tags" : [ {
"privileges" : [ "privileges", "privileges" ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"privileges" : [ "privileges", "privileges" ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ],
"oidcRealm" : "oidcRealm",
"jwtAudience" : "jwtAudience",
"oidcConfigurationEndpointUri" : "http://example.com/aeiou",
"authenticationMethod" : 7,
"sessionInactivityTimeout" : 67067,
"oidcAttributeEmail" : "oidcAttributeEmail",
"loadBalancingModuleBaseUri" : "http://example.com/aeiou",
"sameSiteAttributeHttps" : 5,
"samlAttributeMap" : [ {
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"samlAttribute" : "samlAttribute",
"isMandatory" : true
}, {
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"senseAttribute" : "senseAttribute",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"samlAttribute" : "samlAttribute",
"isMandatory" : true
} ],
"oidcAttributeSub" : "oidcAttributeSub",
"anonymousAccessMode" : 4,
"oidcClientId" : "oidcClientId",
"sameSiteAttributeHttp" : 9,
"description" : "description",
"samlMetadataIdP" : "samlMetadataIdP",
"additionalResponseHeaders" : "additionalResponseHeaders",
"samlEntityId" : "samlEntityId",
"samlAttributeUserDirectory" : "samlAttributeUserDirectory",
"disableSamlOptionalAttributesParsing" : true,
"oidcClientSecret" : "oidcClientSecret",
"headerAuthenticationHeaderName" : "headerAuthenticationHeaderName",
"headerAuthenticationDynamicUserDirectory" : "headerAuthenticationDynamicUserDirectory",
"extendedSecurityEnvironment" : true,
"oidcAttributeName" : "oidcAttributeName",
"oidcScope" : "oidcScope",
"samlAttributeSigningAlgorithm" : 6,
"enableEngineHealthCheckData" : true,
"sessionCookieHeaderName" : "sessionCookieHeaderName",
"headerAuthenticationMode" : 1,
"magicLinkHostUri" : "http://example.com/aeiou",
"jwtPublicKeyCertificate" : "jwtPublicKeyCertificate",
"sessionCookieDomain" : "sessionCookieDomain",
"jwtAttributeUserId" : "jwtAttributeUserId"
} ],
"loggedOutPageTemplate" : "loggedOutPageTemplate",
"performanceLoggingInterval" : 10662,
"schemaPath" : "schemaPath",
"logVerbosity" : {
"logVerbosityAudit" : 4,
"logVerbositySystem" : 1,
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"logVerbosityAuditSecurity" : 3,
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"logVerbosityService" : 2,
"logVerbosityAuditActivity" : 9,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"logVerbosityPerformance" : 7,
"logVerbositySecurity" : 1
},
"kerberosAuthentication" : true,
"maxHeaderLines" : 712,
"authenticationListenPort" : 9607,
"unencryptedAuthenticationListenPort" : 39073,
"errorPageTemplate" : "errorPageTemplate",
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"allowHttp" : true,
"restListenPort" : 44871,
"useWsTrace" : true,
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"maxHeaderSizeBytes" : 30568,
"formAuthenticationPageTemplate" : "formAuthenticationPageTemplate",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"listenPort" : 5249,
"keepAliveTimeoutSeconds" : 169,
"unencryptedListenPort" : 39501,
"sslBrowserCertificateThumbprint" : "sslBrowserCertificateThumbprint"
},
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"customProperties" : [ {
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"definition" : {
"privileges" : [ "privileges", "privileges" ],
"valueType" : "valueType",
"name" : "name",
"choiceValues" : [ "choiceValues", "choiceValues" ],
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"value" : "value"
}, {
"createdDate" : "2000-01-23T04:56:07.000+00:00",
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"definition" : {
"privileges" : [ "privileges", "privileges" ],
"valueType" : "valueType",
"name" : "name",
"choiceValues" : [ "choiceValues", "choiceValues" ],
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"value" : "value"
} ],
"modifiedByUserName" : "modifiedByUserName",
"schemaPath" : "schemaPath",
"modifiedDate" : "2000-01-23T04:56:07.000+00:00",
"serverNodeConfiguration" : {
"privileges" : [ "privileges", "privileges" ],
"hostName" : "hostName",
"roles" : [ {
"privileges" : [ "privileges", "privileges" ],
"definition" : 3,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"privileges" : [ "privileges", "privileges" ],
"definition" : 3,
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"temporaryfilepath" : "temporaryfilepath",
"serviceCluster" : {
"privileges" : [ "privileges", "privileges" ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}
},
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"tags" : [ {
"privileges" : [ "privileges", "privileges" ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}, {
"privileges" : [ "privileges", "privileges" ],
"name" : "name",
"id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
} ]
}
Responses
- 200
- OK