Get all connection descriptors
get
/admin/connectionDescriptors
Request
Query Parameters
-
endpoint-name: string
-
owner: string
Allowed Values:
[ "internal", "tenant" ]
-
scope: string
-
system-descriptor: string
-
type: string
Allowed Values:
[ "internal", "external" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Nested Schema : ConnectionDescriptor
Type:
Show Source
object
-
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" ]
Nested Schema : client-controlled-security
Type:
Show Source
object
-
inbound-auth-header-key: string
-
usage-of-inbound-auth-header: string
Allowed Values:
[ "DROP", "FORWARD" ]
Match One Schema
Show Source
Nested Schema : Oidc-client-credentials
Type:
Show Source
object
-
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" ]
Nested Schema : inbound-token-custom-claim-to-scope-mapping
Type:
object
Additional Properties Allowed
Show Source
-
array additionalProperties
Minimum Number of Items:
1
Nested Schema : inbound-token-scopes-from
Type:
array
Minimum Number of Items:
1
Default Value:
Show Source
[
"JWT_SCOPES"
]
-
Array of:
string
Allowed Values:
[ "JWT_SCOPES", "JWT_CUSTOM_CLAIM" ]
400 Response
Bad Request
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
401 Response
Unauthorized
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
403 Response
Forbidden
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
404 Response
Not Found
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
500 Response
Internal Server Error
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
Examples
The following example shows how to get all connection descriptors by submitting a GET request on the REST resource using cURL.
cURL Command
curl -H 'Authorization: Bearer <Token>' -X GET
https://{FABRIC_HOST}/admin/connectionDescriptors -H
"Content-Type: application/json" | json_pp
Example of Response Body
The following shows an example of the response body in JSON format.
[ { "merge-policy": "ValidateMerge", "endpoint-name": "buying-rest-staging", "endpoint-url": "http://slc12fjc.us.oracle.com:8080/castlemock/mock/rest/project/bvcLru/application/gKpAWP", "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::all", "oidc-flow": "user-assertion-token", "client-identity-propagation-required": false } }, "id": "external-rest-buying", "type": "external", "system-descriptor": "/systemDescriptors/buying-for-merge" }, { "merge-policy": "NotMergeParticipant", "endpoint-name": "tmf629", "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::all", "oidc-flow": "user-assertion-token", "client-identity-propagation-required": false } }, "id": "internal-rest-tmf629-fa-listener", "type": "internal", "system-descriptor": "/systemDescriptors/fa-cdm-tmf629-rest-listener" }, { "merge-policy": "ValidateMerge", "endpoint-name": "brm-rest-staging", "endpoint-url": "http://slc12fjc.us.oracle.com:8080/castlemock/mock/rest/project/bvcLru/application/gKpAWP", "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::all", "oidc-flow": "user-assertion-token", "client-identity-propagation-required": false } }, "id": "external-rest-brm", "type": "external", "system-descriptor": "/systemDescriptors/brm-for-merge" }, { "merge-policy": "NotMergeParticipant", "endpoint-name": "tmf666", "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::all", "oidc-flow": "user-assertion-token", "client-identity-propagation-required": false } }, "id": "internal-rest-tmf666-fa-listener", "type": "internal", "system-descriptor": "/systemDescriptors/fa-cdm-tmf666-rest-listener" }, { "merge-policy": "NotMergeParticipant", "endpoint-name": "tmf666", "id": "internal-rest-tmf666-fa", "type": "internal", "system-descriptor": "/systemDescriptors/fa-cdm-tmf666-rest" }, { "merge-policy": "NotMergeParticipant", "endpoint-name": "Buying", "endpoint-url": "https://test-dx4c-buying-oke.us.oracle.com/orch57e1883c/", "fabric-facing-auth": { "oidc-client-credentials": { "identity-uri": "https://idcs-32e76feb973e47c88f0dedf0610ff764.identity.c9dev2.oc9qadev.com/oauth2/v1/token", "scope": "https://test-dx4c-buying-oke.us.oracle.com/buyingX", "oidc-flow": "user-assertion-token", "client-identity-propagation-required": false } }, "id": "buyingcfjb9", "type": "external", "system-descriptor": "/systemDescriptors/buyingvp8zg" }, { "merge-policy": "NotMergeParticipant", "endpoint-name": "Buying-Product-Sync", "endpoint-url": "https://test-dx4c-buying-oke.us.oracle.com/orch57e1883c", "fabric-facing-auth": { "oidc-client-credentials": { "identity-uri": "https://idcs-32e76feb973e47c88f0dedf0610ff764.identity.c9dev2.oc9qadev.com/oauth2/v1/token", "scope": "https://test-dx4c-buying-oke.us.oracle.com/buyingX", "oidc-flow": "user-assertion-token", "client-identity-propagation-required": false } }, "id": "external-buying-prod-spoke", "type": "external", "system-descriptor": "/systemDescriptors/buying-prod-sync-restapi" }, { "merge-policy": "NotMergeParticipant", "endpoint-name": "tmf629", "id": "internal-rest-tmf629-fa", "type": "internal", "system-descriptor": "/systemDescriptors/fa-cdm-tmf629-rest" }, { "merge-policy": "NotMergeParticipant", "endpoint-name": "tmf632", "id": "internal-rest-tmf632-fa", "type": "internal", "system-descriptor": "/systemDescriptors/fa-cdm-tmf632-rest" }, { "merge-policy": "NotMergeParticipant", "endpoint-name": "tmf632", "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::all", "oidc-flow": "user-assertion-token", "client-identity-propagation-required": false } }, "id": "internal-rest-tmf632-fa-listener", "type": "internal", "system-descriptor": "/systemDescriptors/fa-cdm-tmf632-rest-listener" }, { "merge-policy": "NotMergeParticipant", "endpoint-name": "Buying-2", "endpoint-url": "https://test-dx4c-buying-oke.us.oracle.com/orch02a8cfd8", "fabric-facing-auth": { "oidc-client-credentials": { "identity-uri": "https://idcs-e26cf95703b8474a9a3efc9bd0ec0206.identity.c9dev2.oc9qadev.com/oauth2/v1/token", "scope": "https://test-dx4c-buying-oke.us.oracle.com/buyingX", "oidc-flow": "user-assertion-token", "client-identity-propagation-required": false } }, "id": "buying-2x8p5v", "type": "external", "system-descriptor": "/systemDescriptors/buying-2v8ws8" }, { "merge-policy": "NotMergeParticipant", "endpoint-name": "BRM", "endpoint-url": "http://sca00jfp.us.oracle.com:9999", "fabric-facing-auth": { "oidc-client-credentials": { "identity-uri": "https://idcs-ddeba14a21d74e72baf5a26c65900c12.identity.c9dev2.oc9qadev.com/oauth2/v1/token", "scope": "https://kv2asa3jmedyhaffdkkdu2ct2m.apigateway.us-ashburn-1.oci.customer-oci.comurn:opc:resource:consumer::all", "oidc-flow": "user-assertion-token", "client-identity-propagation-required": false } }, "id": "brm6qq9j", "type": "external", "system-descriptor": "/systemDescriptors/brmsz5lm" }, { "merge-policy": "NotMergeParticipant", "endpoint-name": "flytxt", "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": "flytxtjmbfz", "type": "external", "system-descriptor": "/systemDescriptors/analyticshzmd6" } ]