Validate WebTier Policy JSON.

post

/admin/v1/WebTierPolicyJsonValidator

Request

Supported Media Types
  • application/scim+json
  • application/json
Query Parameters
attributes
Type: string
A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.
Header Parameters
Authorization
Type: string
Required: true
The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.
Content-Type
Type: string
Required: true
Media Type
RESOURCE_TYPE_SCHEMA_VERSION
Type: string
An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.
Body Parameter
Root Schema : WebTierPolicyJsonValidator
Type: object
WebTierPolicyJsonValidator is a convenience endpoint that allows a requester to validate WebTier Policy.
Nested Schema : idcsCreatedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: true
  • returned: default
  • type: complex
The User or App who created the Resource
Nested Schema : idcsLastModifiedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
The User or App who modified the Resource
Nested Schema : meta
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.

Response

Supported Media Types
  • text/html
  • application/json
  • application/scim+json
201 Response
The request was successful.
Body
WebTierPolicyJsonValidator is a convenience endpoint that allows a requester to validate WebTier Policy.
Root Schema : WebTierPolicyJsonValidator
Type: object
WebTierPolicyJsonValidator is a convenience endpoint that allows a requester to validate WebTier Policy.
Nested Schema : idcsCreatedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: true
  • returned: default
  • type: complex
The User or App who created the Resource
Nested Schema : idcsLastModifiedBy
Type: object
SCIM++ Properties:
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
The User or App who modified the Resource
Nested Schema : meta
Type: object
SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: complex
A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL.
400 Response
Bad or invalid request
Body
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
401 Response
The supplied credentials, if any, are not sufficient to access the resource.
Body
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
404 Response
The requested resource was not found.
Body
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.
500 Response
We couldn't return the representation due to an internal server error.
Body
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Root Schema : Error
Type: object
The SCIM Protocol uses the HTTP status response status codes defined in Section 6 [RFC7231] to indicate operation success or failure. Refer the available status codes here : Status Codes.
In addition to returning a HTTP response code implementers MUST return the errors in the body of the response in the client requested format containing the error response and, per the HTTP specification, human- readable explanations.
Nested Schema : urn:ietf:params:scim:api:oracle:idcs:extension:messages:Error
Type: object
Extension schema for error messages providing more details with the exception status.
Returns messageId corresponding to the detailed error message and optionally additional data related to the error condition - for example reason for authentication failure such as user is disabled or locked.
Nested Schema : additionalData
Type: object
Contains Map based additional data for the exception message (as key-value pair). All keys and values are in string format.

Examples

The following example shows how to validate the Web Tier policy JSON by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

cURL Command

Note:

The command in this example uses the URL structure https://tenant-base-url/resource-path, where tenant-base-url represents the Identity Service URL, and the resource path represents the Identity Service API. See Send Requests for the appropriate URL structure to use.
curl
-X POST
-H "Content-Type:application/scim+json"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/admin/v1/WebTierPolicyJsonValidator

Example of Request Body

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

{
		"webTierPolicyJson": "{\"cloudgatePolicy\":{\"version\":\"2.3\",\"webtierPolicy\":[{\"policyName\":\"xyz\",\"comment\":\"abc\",\"resourceFilters\":[{\"comment\":\"filter1\",\"type\":\"text\",\"filter\":\"/uri1/path1\",\"method\":\"public\"},{\"comment\":\"filter2\",\"type\":\"regex\",\"filter\":\"/uri2/.*/path2\",\"method\":\"oauth\",\"authorize\":false,\"scope\":\"scope1scope2scope3\"},{\"comment\":\"filterN\",\"type\":\"regex\",\"filter\":\"/uriN/pathN\",\"method\":\"oauth+logout\",\"oauthPostLogoutUrl\":\"http://foo/landingpage\",\"oauthPostLogoutState\":\"blahblahblah\"}]}]}}",
		"schemas": ["urn:ietf:params:scim:schemas:oracle:idcs:WebTierPolicyJsonValidator"]
	}

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
		"webTierPolicyJson": "{\"cloudgatePolicy\":{\"version\":\"2.3\",\"webtierPolicy\":[{\"policyName\":\"xyz\",\"comment\":\"abc\",\"resourceFilters\":[{\"comment\":\"filter1\",\"type\":\"text\",\"filter\":\"/uri1/path1\",\"method\":\"public\"},{\"comment\":\"filter2\",\"type\":\"regex\",\"filter\":\"/uri2/.*/path2\",\"method\":\"oauth\",\"authorize\":false,\"scope\":\"scope1scope2scope3\"},{\"comment\":\"filterN\",\"type\":\"regex\",\"filter\":\"/uriN/pathN\",\"method\":\"oauth+logout\",\"oauthPostLogoutUrl\":\"http://foo/landingpage\",\"oauthPostLogoutState\":\"blahblahblah\"}]}]}}",
		"schemas": [
			"urn:ietf:params:scim:schemas:oracle:idcs:WebTierPolicyJsonValidator"
		],
		"meta": {
			"created": "2016-12-08T00:17:55.142Z",
			"lastModified": "2016-12-08T00:17:55.142Z",
			"resourceType": "WebTierPolicyJsonValidator",
			"location": "http://tenant-base-url/admin/v1/WebTierPolicyJsonValidator"
		},
		"idcsCreatedBy": {
			"value": "f26a8e473ac64c37a6d77838d447fde6",
			"type": "User",
			"display": "admin opc",
			"$ref": "http://tenant-base-url/admin/v1/Users/f26a8e473ac64c37a6d77838d447fde6"
		},
		"idcsLastModifiedBy": {
			"value": "f26a8e473ac64c37a6d77838d447fde6",
			"type": "User",
			"display": "admin opc",
			"$ref": "http://tenant-base-url/admin/v1/Users/f26a8e473ac64c37a6d77838d447fde6"
		}
	}
}