updateAdminSecurityCriterion
put
/ccadmin/v1/adminSecurityCriteria/{id}
Update Admin Security Criterion. Updates a given admin security criterion by ID.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The Security Criterion ID.
Root Schema : updateAdminSecurityCriterion_request
Type:
Show Source
object
-
constraints(optional):
array constraints
Constraints for the security criterion
-
description(optional):
string
Description of the security criterion
-
name(optional):
string
Name of the security criterion
Example:
{
"name":"Security Criterion for Catalog",
"description":"Grant access to catalogs: ClassicalMoviesCatalog",
"constraints":[
{
"constraintConfig":{
"id":"ora.catalogConstraintConfiguration"
},
"values":[
"ClassicalMoviesCatalog"
]
}
]
}
Nested Schema : items
Type:
Show Source
object
-
constraintConfig(optional):
object constraintConfig
Constraint configuration for the resource
-
values(optional):
array values
IDs of the constraining asset type. Catalog IDs in case of ora.catalogConstraintConfiguration
Nested Schema : constraintConfig
Type:
object
Constraint configuration for the resource
Show Source
-
id(optional):
string
ID of constraint configuration
Nested Schema : values
Type:
array
IDs of the constraining asset type. Catalog IDs in case of ora.catalogConstraintConfiguration
Show Source
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createAdminSecurityCriterion_response
Type:
Show Source
object
-
actions(optional):
array actions
Array of actions on which the resource is constrained by the security criterion
-
constraints(optional):
array constraints
Constraints for the security criterion
-
constraintType(optional):
string
Allowed Values:
[ "grant", "deny", "grantNone" ]
Constraint type of the security criterion -
description(optional):
string
Description of the security criterion
-
id(optional):
string
ID of the security criterion
-
lastModified(optional):
string
Last modified time stamp of the security criterion
-
name(optional):
string
Name of the security criterion
-
roles(optional):
array roles
Array of roles that contain this security criterion
-
securityCriteriaResource(optional):
object securityCriteriaResource
Resource for the security criterion
Nested Schema : actions
Type:
array
Array of actions on which the resource is constrained by the security criterion
Show Source
Nested Schema : securityCriteriaResource
Type:
object
Resource for the security criterion
Show Source
-
id(optional):
string
ID of the resource
-
name(optional):
string
Name of the resource
Nested Schema : items
Type:
Show Source
object
-
constraintConfig(optional):
object constraintConfig
Constraint configuration for the resource
-
id(optional):
string
ID of the security criterion constraint
-
values(optional):
array values
IDs of the constraining asset type. Catalog IDs in case of ora.catalogConstraintConfiguration
Nested Schema : constraintConfig
Type:
object
Constraint configuration for the resource
Show Source
-
id(optional):
string
ID of the constraint configuration
Nested Schema : values
Type:
array
IDs of the constraining asset type. Catalog IDs in case of ora.catalogConstraintConfiguration
Show Source
Example Response (application/json)
{
"constraintType":"grant",
"roles":[
{
"id":"adminRole"
}
],
"name":"Security Criterion for Catalog",
"description":"Grant access to catalogs: ClassicalMoviesCatalog",
"id":"sc-100001",
"lastModified":"2021-02-12T09:17:45.862Z",
"securityCriteriaResource":{
"name":"Catalog Assets",
"id":"ora.catalogAssetResource"
},
"actions":[
"create",
"update",
"delete"
],
"constraints":[
{
"constraintConfig":{
"id":"ora.catalogConstraintConfiguration"
},
"values":[
"ClassicalMoviesCatalog"
],
"id":"scc-100001"
}
]
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|22061|If input passed is invalid|
|22073|If constraint values passed are invalid|
|22076|If constraint configuration passed is invalid|
|22077|If constraints are passed with constraintType: grantNone|
|22079|If constraint configuration is not passed|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code