Jump to

• Request
• Response
• Examples

Update Gateway Runtime user credentials

put

/apiplatform/gatewaynode/v1/security/credentials

Updates the Gateway Runtime user credentials used by the node. Perform this operation after updating the user's credentials on the management tier.

This performs the same function as the updatecredentials gateway node installer action.

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

Request

Supported Media Types

• application/json

Body ()

Root Schema : UpdateCredentialsRequest

Match All

Show Source

• object GatewayRuntimeCredentials

{
    "allOf":[
        {
            "$ref":"#/definitions/GatewayRuntimeCredentials"
        }
    ]
}

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."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• text/plain

204 Response

Request completed successfully.

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"
    }
}

503 Response

Temporarily unavailable 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 update the credentials of the gateway runtime user for the gateway node by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X PUT 
-H "Authorization: Bearer access_token 
-H "Content-Type: application/json"
-d @credentials.json
https://example.com/apiplatform/gatewaynode/v1/security/credentials

Example of Request Body

The following shows an example request body (included with the request above in a file named credentials.json) that changes the password of the gateway-runtime-user user.

{
	"gatewayRuntimeUsername": "gateway-runtime-user",
	"gatewayRuntimePassword": "new_Passw0rd"
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Date: Fri, 30 Dec 2016 19:09:45 GMT

Back to Top