REST API for the Gateway Controller in Oracle API Platform Cloud Service

Update security profile

put

/apiplatform/gatewaynode/v1/security/profile

Updates the security profile the node uses to authenticate APIs secured with the OAuth 2.0 policy.

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

Request

Supported Media Types

text/plain

The security identity provider's profile.

Root Schema : UpdateProfileRequest

Type: string

The security identity provider's profile.

Response

Supported Media Types

application/json
text/plain

204 Response

Request completed successfully.

400 Response

Bad request, indicates a problem with the input parameters.

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.

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.

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.

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.

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

Examples

The following example shows how to update the OAuth 2.0 profile 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: text/plain"
?-data-binary @oAuthProfile.xml
https://example.com/apiplatform/gatewaynode/v1/security/profile

Example OAuth 2.0 Profile

The following example shows a sample OAuth 2.0 profile, passed to the gateway node via the ?-data-binary @oAuthProfile.xml flag, as shown in the cURL example.

<OAuth2TokenLocalEnforcerConfig>
	<Name>DEFAULT</Name>
	<HeaderNameIDToken>IDToken</HeaderNameIDToken>	
	<Issuer>https://identity.oraclecloud.com/</Issuer>
	<AudienceRestrictionFromConfig>true</AudienceRestrictionFromConfig>
	<Audience>http://example</Audience>
	<MandatoryClaims></MandatoryClaims>
	<Subject></Subject>
<!-- useFormat has 3 values  PEMFormatPubKey, X509FormatPubKey, JWKFormatPubKey -->
	<PublicCertLocation useFormat="X509FormatPubKey">
	<X509FormatPubKey>MIICUDCCAbmgAwIBAgIELfGcXDANBgkqhkiG9w0BAQUFADBXMRMwEQYKCZImiZPyLGQBGRYDY29tMRYwFAYKCZImiZPyLGQBGRYGb3JhY2xlMRUwEwYKCZImiZPyLGQBGRYFY2xvdWQxETAPBgNVBAMTCENsb3VkOUNBMB4XDTE1MTEyMDA5MzI0OFoXDTI1MTExNzA5MzI0OFowXzETMBEGCgmSJomT8ixkARkWA2NvbTEWMBQGCgmSJomT8ixkARkWBm9yYWNsZTEVMBMGCgmSJomT8ixkARkWBWNsb3VkMRkwFwYDVQQDDBBvcmNsTVQxMjMyMzJfaWRtMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCLVvyue+qFraxwM5LxaNLt2QH3wHn/n0+yk2jmP7mpYkz1xrKuEk2e2SCggzK8MT9jJ5VUaNlF0MwhIZ8/naxA5LPCzGEVfZ/41GPtGNADFyspqGHkdsNv+M2eCBme7MDp9L3noBtt2peqGqxSu0DHyt1wgNr6p6EXqTT4AbLdyQIDAQABoyEwHzAdBgNVHQ4EFgQU2rtogHKC0/ws2dS3Zq7s9wwMofkwDQYJKoZIhvcNAQEFBQADgYEAK1jtcbRpYFAl2Bp9X02MaA/igq3WXykizH7uQvrWgNQluf7ADbxaB7J96jaIN2GLQFxl6cbPwOvBIu7xd9a26eK6F5gq4iJKm7GeOgV5PZ4r5umvSZgA0aLOAbhZ/gwy40RauF0X+4I7JqamnV0DizM2YEDsFWKfTSvCy90ZizMwggJeMIIBx6ADAgECAgRgdcJQMA0GCSqGSIb3DQEBBQUAMFcxEzARBgoJkiaJk/IsZAEZFgNjb20xFjAUBgoJkiaJk/IsZAEZFgZvcmFjbGUxFTATBgoJkiaJk/IsZAEZFgVjbG91ZDERMA8GA1UEAxMIQ2xvdWQ5Q0EwIBcNMTUxMTE5MTIwMDQyWhgPMjExNTEwMjYxMTAwNDJaMFcxEzARBgoJkiaJk/IsZAEZFgNjb20xFjAUBgoJkiaJk/IsZAEZFgZvcmFjbGUxFTATBgoJkiaJk/IsZAEZFgVjbG91ZDERMA8GA1UEAxMIQ2xvdWQ5Q0EwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAJeXcnReWfVIhqdedQKy+qi+tMp2NstgxHWisJ6OZf7O+KC9WzP+X+UwiQTMUzp+B4UWUEbpGNW7dv7jiyKdsgYGrnpwINl6OT4wrlKD8r2+7yQLNBsvDQjVeWmhHTqFfgqTfd/wi3MC2itft+I40O4GnSL3/VDcTSxJZMaigKizAgMBAAGjNTAzMBIGA1UdEwEB/wQIMAYBAf8CAQAwHQYDVR0OBBYEFPwqb7nQaKEVc+oSa7ohvOxIGMfXMA0GCSqGSIb3DQEBBQUAA4GBADydG93z/CGRVfUyVfD/ULT/d+RYfm3sriGgPPZlEO+idCgA6tEMcnIOFf3lP5CFAdFq6ykmFHMOf15CYvqkv7jZULiL3zMgy7OgB4I0i0WMUAAybqeiZlU90y86zd2yfAgQEM4ncUCHg+Dwf2XF0qmYK0XLF7CSb/hSEJJp4W2j</X509FormatPubKey>
	</PublicCertLocation> 
</OAuth2TokenLocalEnforcerConfig>

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Date: Fri, 30 Dec 2016 20:08:03 GMT