Jump to

• Request
• Response
• Examples

Register node to a logical gateway

post

/apiplatform/gatewaynode/v1/registration

Registers the node to a logical gateway on the management tier.

Users requesting this resource must be assigned the Gateway Manager role for the logical gateway this node is to be registered to.

Request

Supported Media Types

• application/json

Body ()

Root Schema : RegistrationRequest

Match All

Show Source

• object ManagementTierUrls
• object GatewayId
• object NodeName
• object GatewayRuntimeCredentials
• object NodeProperties
  The node's properties.

{
    "allOf":[
        {
            "$ref":"#/definitions/ManagementTierUrls"
        },
        {
            "$ref":"#/definitions/GatewayId"
        },
        {
            "$ref":"#/definitions/NodeName"
        },
        {
            "$ref":"#/definitions/GatewayRuntimeCredentials"
        },
        {
            "$ref":"#/definitions/NodeProperties"
        }
    ]
}

Nested Schema : ManagementTierUrls

Type: object

Show Source

• analyticsManagementUrl(optional): string
  The URL of the analytics service this node is associated with.
• managementUrl: string
  The URL of the management service this node is associated with.
• registryManagementUrl(optional): string
  The URL of the registration service this node is associated with.
• runtimeScope(optional): string
  The scope for the Oracle Identity Cloud Service application associated with the management service.
• tokenIssuerUrl: string
  The URL of the Oracle Identity Cloud Service instance that the management service is associated with.

{
    "type":"object",
    "required":[
        "managementUrl",
        "tokenIssuerUrl"
    ],
    "properties":{
        "managementUrl":{
            "type":"string",
            "description":"The URL of the management service this node is associated with."
        },
        "analyticsManagementUrl":{
            "type":"string",
            "description":"The URL of the analytics service this node is associated with."
        },
        "registryManagementUrl":{
            "type":"string",
            "description":"The URL of the registration service this node is associated with."
        },
        "tokenIssuerUrl":{
            "type":"string",
            "description":"The URL of the Oracle Identity Cloud Service instance that the management service is associated with."
        },
        "runtimeScope":{
            "type":"string",
            "description":"The scope for the Oracle Identity Cloud Service application associated with the management service."
        }
    }
}

Nested Schema : GatewayId

Type: object

Show Source

• gatewayId: string
  The ID of the logical gateway the node is registered to.

{
    "type":"object",
    "required":[
        "gatewayId"
    ],
    "properties":{
        "gatewayId":{
            "type":"string",
            "description":"The ID of the logical gateway the node is registered to."
        }
    }
}

Nested Schema : NodeName

Type: object

Show Source

• gatewayNodeName: string
  The node's name.

{
    "type":"object",
    "required":[
        "gatewayNodeName"
    ],
    "properties":{
        "gatewayNodeName":{
            "type":"string",
            "description":"The node's name."
        }
    }
}

Nested Schema : GatewayRuntimeCredentials

Type: object

Show Source

• gatewayRuntimeClientId: string
  The client ID for the client in Oracle Identity Cloud Service that is to be used by the node.
• gatewayRuntimeClientSecret: string
  The client secret for the client in Oracle Identity Cloud Service that is to be used by the node.
• gatewayRuntimePassword: string
  The password of the Gateway Runtime user associated with the node.
• gatewayRuntimeUsername: string
  The username of the Gateway Runtime user associated with the node.

{
    "type":"object",
    "required":[
        "gatewayRuntimeClientId",
        "gatewayRuntimeClientSecret",
        "gatewayRuntimePassword",
        "gatewayRuntimeUsername"
    ],
    "properties":{
        "gatewayRuntimeUsername":{
            "type":"string",
            "description":"The username of the Gateway Runtime user associated with the node."
        },
        "gatewayRuntimePassword":{
            "type":"string",
            "description":"The password of the Gateway Runtime user associated with the node."
        },
        "gatewayRuntimeClientId":{
            "type":"string",
            "description":"The client ID for the client in Oracle Identity Cloud Service that is to be used by the node."
        },
        "gatewayRuntimeClientSecret":{
            "type":"string",
            "description":"The client secret for the client in Oracle Identity Cloud Service that is to be used by the node."
        }
    }
}

Nested Schema : NodeProperties

Type: object

The node's properties.

Show Source

• properties(optional): object properties

{
    "type":"object",
    "properties":{
        "properties":{
            "type":"object",
            "properties":{
                "nodeProxy":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "phoneHomeProxy":{
                    "type":"array",
                    "items":{
                        "type":"string",
                        "description":"Proxy the node uses to communicate with the management tier, in this format: <code><Proxy-Type>://<Proxy Host Address>:<Proxy Host Port></code>."
                    }
                },
                "nodeDescription":{
                    "type":"string",
                    "description":"The node's description."
                },
                "publishUrls":{
                    "type":"array",
                    "items":{
                        "type":"string",
                        "description":"The external IP/hostname for the gateway, which is visible to the management tier."
                    }
                }
            }
        }
    },
    "description":"The node's properties."
}

Nested Schema : properties

Type: object

Show Source

• nodeDescription(optional): string
  The node's description.
• nodeProxy(optional): array nodeProxy
• phoneHomeProxy(optional): array phoneHomeProxy
• publishUrls(optional): array publishUrls

{
    "type":"object",
    "properties":{
        "nodeProxy":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "phoneHomeProxy":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Proxy the node uses to communicate with the management tier, in this format: <code><Proxy-Type>://<Proxy Host Address>:<Proxy Host Port></code>."
            }
        },
        "nodeDescription":{
            "type":"string",
            "description":"The node's description."
        },
        "publishUrls":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"The external IP/hostname for the gateway, which is visible to the management tier."
            }
        }
    }
}

Nested Schema : nodeProxy

Type: array

Show Source

• Array of: string

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

Nested Schema : phoneHomeProxy

Type: array

Show Source

• Array of: string
  Proxy the node uses to communicate with the management tier, in this format: ://:.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Proxy the node uses to communicate with the management tier, in this format: <code><Proxy-Type>://<Proxy Host Address>:<Proxy Host Port></code>."
    }
}

Nested Schema : publishUrls

Type: array

Show Source

• Array of: string
  The external IP/hostname for the gateway, which is visible to the management tier.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"The external IP/hostname for the gateway, which is visible to the management tier."
    }
}

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

Registration completed successfully.

Body ()

Root Schema : RegistrationNodeId

Type: object

Show Source

• message(optional): string
  Message about the state of registration
• nodeId: string
  The node's ID.

{
    "type":"object",
    "required":[
        "nodeId"
    ],
    "properties":{
        "nodeId":{
            "type":"string",
            "description":"The node's ID."
        },
        "message":{
            "type":"string",
            "description":"Message about the state of registration"
        }
    }
}

400 Response

Bad request, indicates a problem with the input parameters.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

Show Source

• detail(optional): string
  Detailed error message.
• errorCode(optional): string
  Application-specific error code.
• errorDetails(optional): array errorDetails
  Additional errors.
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error.
• status(optional): string
  HTTP status code.
• title: string
  Summary error message.
• type: string
  Error type.

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorCode":{
            "type":"string",
            "description":"Application-specific error code."
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code."
        },
        "errorDetails":{
            "type":"array",
            "description":"Additional errors.",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

{
    "type":"array",
    "description":"Additional errors.",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

401 Response

Authentication required.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

Show Source

• detail(optional): string
  Detailed error message.
• errorCode(optional): string
  Application-specific error code.
• errorDetails(optional): array errorDetails
  Additional errors.
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error.
• status(optional): string
  HTTP status code.
• title: string
  Summary error message.
• type: string
  Error type.

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorCode":{
            "type":"string",
            "description":"Application-specific error code."
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code."
        },
        "errorDetails":{
            "type":"array",
            "description":"Additional errors.",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

{
    "type":"array",
    "description":"Additional errors.",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

403 Response

Forbidden.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

Show Source

• detail(optional): string
  Detailed error message.
• errorCode(optional): string
  Application-specific error code.
• errorDetails(optional): array errorDetails
  Additional errors.
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error.
• status(optional): string
  HTTP status code.
• title: string
  Summary error message.
• type: string
  Error type.

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorCode":{
            "type":"string",
            "description":"Application-specific error code."
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code."
        },
        "errorDetails":{
            "type":"array",
            "description":"Additional errors.",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

{
    "type":"array",
    "description":"Additional errors.",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

Show Source

• detail(optional): string
  Detailed error message.
• errorCode(optional): string
  Application-specific error code.
• errorDetails(optional): array errorDetails
  Additional errors.
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error.
• status(optional): string
  HTTP status code.
• title: string
  Summary error message.
• type: string
  Error type.

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorCode":{
            "type":"string",
            "description":"Application-specific error code."
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code."
        },
        "errorDetails":{
            "type":"array",
            "description":"Additional errors.",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

{
    "type":"array",
    "description":"Additional errors.",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to register a gateway node to a logical gateway in an Oracle API Platform Cloud Service - Classic instance by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X POST 
-u apicsadmin:password 
-H "Content-Type: application/json"
-d @node.json
https://example.com/apiplatform/gatewaynode/v1/registration

Example of Request Body

The following sample request body in JSON format (included with the request above in a file named node.json) specifies the details of the logical gateway you want to register the node to.

{
	"gatewayId": "177",
	"gatewayNodeName": "Production Gateway Node 1",
	"tenantId": "SampleTenant",
	"tenantInstanceId": "SampleInstance",
	"managementUrl": "https://example.com:7201",
	"gatewayRuntimeUsername": "gateway-runtime-user",
	"gatewayRuntimePassword": "password",
	"properties": {
		"nodeProxy": ["http://www-proxy.example.com:80", "https://www-proxy.example.com:80"]
	}
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Fri, 30 Dec 2016 17:58:40 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format, including the ID of the registered node.

{
  "id": "102"
}

Back to Top