Jump to

• Request
• Response
• Examples

Update a connection descriptor

patch

/admin/connectionDescriptors/{id}

Request

Path Parameters

• id(required): string
  The id of the ConnectionDescriptor to be updated

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object PatchDocument
  A JSONPatch document as defined by RFC 6902

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PatchDocument"
    }
}

Nested Schema : PatchDocument

Type: object

A JSONPatch document as defined by RFC 6902

Show Source

• from: string
  A string containing a JSON Pointer value.
• op(required): string
  Allowed Values: [ "add", "remove", "replace", "move", "copy", "test" ]

  The operation to be performed
• path(required): string
  A JSON-Pointer
• value: object value
  The value to be used within the operations.

{
    "description":"A JSONPatch document as defined by RFC 6902",
    "required":[
        "op",
        "path"
    ],
    "properties":{
        "op":{
            "type":"string",
            "description":"The operation to be performed",
            "enum":[
                "add",
                "remove",
                "replace",
                "move",
                "copy",
                "test"
            ]
        },
        "path":{
            "type":"string",
            "description":"A JSON-Pointer"
        },
        "value":{
            "type":"object",
            "description":"The value to be used within the operations."
        },
        "from":{
            "type":"string",
            "description":"A string containing a JSON Pointer value."
        }
    }
}

Nested Schema : value

Type: object

The value to be used within the operations.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ConnectionDescriptor

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ConnectionDescriptor"
    }
}

Nested Schema : ConnectionDescriptor

Type: object

Show Source

• adapter-id: string
• client-controlled-security: object client-controlled-security
• endpoint-name: string
• endpoint-url: string
• fabric-facing-auth: object Fabric-facing-auth
• header-enrichment: object header-enrichment
  Additional Properties Allowed: additionalProperties
• internal-adapter-app-config: object Internal-adapter-app-config
• merge-policy: string
• routing: string
• system-descriptor: string
• timeout-variance: string
• type: string
  Allowed Values: [ "internal", "external" ]

{
    "type":"object",
    "properties":{
        "system-descriptor":{
            "type":"string"
        },
        "endpoint-name":{
            "type":"string"
        },
        "adapter-id":{
            "type":"string"
        },
        "header-enrichment":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "client-controlled-security":{
            "type":"object",
            "properties":{
                "usage-of-inbound-auth-header":{
                    "type":"string",
                    "enum":[
                        "DROP",
                        "FORWARD"
                    ]
                },
                "inbound-auth-header-key":{
                    "type":"string"
                }
            },
            "oneOf":[
                {
                    "required":[
                        "usage-of-inbound-auth-header"
                    ]
                }
            ]
        },
        "endpoint-url":{
            "type":"string"
        },
        "routing":{
            "type":"string"
        },
        "timeout-variance":{
            "type":"string"
        },
        "merge-policy":{
            "type":"string"
        },
        "fabric-facing-auth":{
            "$ref":"#/components/schemas/Fabric-facing-auth"
        },
        "type":{
            "type":"string",
            "enum":[
                "internal",
                "external"
            ]
        },
        "internal-adapter-app-config":{
            "$ref":"#/components/schemas/Internal-adapter-app-config"
        }
    }
}

Nested Schema : client-controlled-security

Type: object

Show Source

• inbound-auth-header-key: string
• usage-of-inbound-auth-header: string
  Allowed Values: [ "DROP", "FORWARD" ]

{
    "type":"object",
    "properties":{
        "usage-of-inbound-auth-header":{
            "type":"string",
            "enum":[
                "DROP",
                "FORWARD"
            ]
        },
        "inbound-auth-header-key":{
            "type":"string"
        }
    },
    "oneOf":[
        {
            "required":[
                "usage-of-inbound-auth-header"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "usage-of-inbound-auth-header":{
            "type":"string",
            "enum":[
                "DROP",
                "FORWARD"
            ]
        },
        "inbound-auth-header-key":{
            "type":"string"
        }
    },
    "oneOf":[
        {
            "required":[
                "usage-of-inbound-auth-header"
            ]
        }
    ]
}

Nested Schema : Fabric-facing-auth

Type: object

Show Source

• basic: object Basic-credentials
• oidc-client-credentials: object Oidc-client-credentials

{
    "type":"object",
    "properties":{
        "oidc-client-credentials":{
            "$ref":"#/components/schemas/Oidc-client-credentials"
        },
        "basic":{
            "$ref":"#/components/schemas/Basic-credentials"
        }
    }
}

Nested Schema : header-enrichment

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : Internal-adapter-app-config

Type: object

Show Source

• additional-urls: array additional-urls
• auth: object Basic-credentials
• event-emitter-outgoing-auth: object Oidc-client-credentials

{
    "type":"object",
    "properties":{
        "additional-urls":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"url"
            }
        },
        "auth":{
            "$ref":"#/components/schemas/Basic-credentials"
        },
        "event-emitter-outgoing-auth":{
            "$ref":"#/components/schemas/Oidc-client-credentials"
        }
    }
}

Nested Schema : Basic-credentials

Type: object

Show Source

• password: object password
• username: object username

{
    "type":"object",
    "properties":{
        "username":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PasswordUserName"
            }
        },
        "password":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PasswordUserName"
            }
        }
    }
}

Nested Schema : Oidc-client-credentials

Type: object

Show Source

• audience: string
• client-id: string
• client-identity-propagation-required: boolean
• client-secret: string
• fixed-user-for-user-assertion: string
• identity-uri: string
• inbound-token-custom-claim-to-scope-mapping: object inbound-token-custom-claim-to-scope-mapping
  Additional Properties Allowed: additionalProperties
• inbound-token-scopes-from: array inbound-token-scopes-from
  Minimum Number of Items: 1
• oidc-auth-server-audience: string
• oidc-flow: string
  Allowed Values: [ "client-token", "user-assertion-token", "fixed-user-assertion-token" ]
• oidc-server: string
• scope: string
• usage-of-inbound-token-scopes: string
  Default Value: IGNORE

  Allowed Values: [ "INCLUDE", "IGNORE", "ONLY" ]

{
    "type":"object",
    "properties":{
        "identity-uri":{
            "type":"string"
        },
        "client-id":{
            "type":"string"
        },
        "client-secret":{
            "type":"string"
        },
        "scope":{
            "type":"string"
        },
        "oidc-auth-server-audience":{
            "type":"string"
        },
        "oidc-server":{
            "type":"string"
        },
        "oidc-flow":{
            "$ref":"#/components/schemas/Oidc-flow"
        },
        "fixed-user-for-user-assertion":{
            "type":"string"
        },
        "client-identity-propagation-required":{
            "type":"boolean"
        },
        "audience":{
            "type":"string"
        },
        "usage-of-inbound-token-scopes":{
            "type":"string",
            "enum":[
                "INCLUDE",
                "IGNORE",
                "ONLY"
            ],
            "default":"IGNORE"
        },
        "inbound-token-scopes-from":{
            "type":"array",
            "default":[
                "JWT_SCOPES"
            ],
            "minItems":1,
            "items":{
                "type":"string",
                "nullable":false,
                "enum":[
                    "JWT_SCOPES",
                    "JWT_CUSTOM_CLAIM"
                ]
            }
        },
        "inbound-token-custom-claim-to-scope-mapping":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "minItems":1,
                "items":{
                    "type":"string",
                    "nullable":false
                }
            }
        }
    }
}

Nested Schema : password

Type: object

Show Source

• Array of: object PasswordUserName

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PasswordUserName"
    }
}

Nested Schema : username

Type: object

Show Source

• Array of: object PasswordUserName

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PasswordUserName"
    }
}

Nested Schema : PasswordUserName

Type: object

Show Source

• secret-key: string
• secret-name: string

{
    "type":"object",
    "properties":{
        "secret-name":{
            "type":"string"
        },
        "secret-key":{
            "type":"string"
        }
    }
}

Nested Schema : inbound-token-custom-claim-to-scope-mapping

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties
  Minimum Number of Items: 1

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "minItems":1,
        "items":{
            "type":"string",
            "nullable":false
        }
    }
}

Nested Schema : inbound-token-scopes-from

Type: array

Minimum Number of Items: 1

Default Value: [ "JWT_SCOPES" ]

Show Source

• Array of: string
  Allowed Values: [ "JWT_SCOPES", "JWT_CUSTOM_CLAIM" ]

{
    "type":"array",
    "default":[
        "JWT_SCOPES"
    ],
    "minItems":1,
    "items":{
        "type":"string",
        "nullable":false,
        "enum":[
            "JWT_SCOPES",
            "JWT_CUSTOM_CLAIM"
        ]
    }
}

Nested Schema : additionalProperties

Type: array

Minimum Number of Items: 1

Show Source

• Array of: string

{
    "type":"array",
    "minItems":1,
    "items":{
        "type":"string",
        "nullable":false
    }
}

Nested Schema : additional-urls

Type: array

Show Source

• Array of: string(url)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"url"
    }
}

400 Response

Bad Request

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

409 Response

Conflict

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

Back to Top

Examples

The following example shows how to update a connection descriptor by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -H 'Authorization: Bearer <Token>' -X PATCH https://{FABRIC_HOST}/admin/connectionDescriptors/{id} -H "Content-Type: application/json" -D @update_connectionDescriptors.json | json_pp

Example of Request Body

The following shows an example of the request body in JSON format.

[
    {
        "op": "replace",
        "path": "/endpoint-url",
        "value": "https://fusovmsmc76-fa-ext.us.oracle.com/crmRestApi/resources/11.13.18.05/"
    }
]

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "merge-policy": "NotMergeParticipant",
    "endpoint-name": "flytxt162",
    "endpoint-url": "https://fusovmsmc76-fa-ext.us.oracle.com/crmRestApi/resources/11.13.18.05/",
    "fabric-facing-auth": {
        "oidc-client-credentials": {
            "identity-uri": "https://idcs-322c58839d80453186f91eb606042ad2.identity.oraclecloud.com/oauth2/v1/token",
            "scope": "https://n6jfxzxt6schvqjkpge6uqfrum.apigateway.us-ashburn-1.oci.customer-oci.comurn:opc:resource:consumer::",
            "oidc-flow": "user-assertion-token",
            "client-identity-propagation-required": false
        }
    },
    "id": "flytxt162khh45",
    "type": "external",
    "system-descriptor": "/systemDescriptors/buyingvp8zg"
}

Back to Top