getAdminSecurityCriterion
get
/ccadmin/v1/adminSecurityCriteria/{id}
Get Admin Security Criterion. Returns a admin security criterion by ID.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The Security Criterion ID.
Query Parameters
-
expand(optional): string
Expand query param: currently used to expand constraints information. Possible value for this query parameter is 'constraints'Allowed Values:
[ "constraints" ]
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getAdminSecurityCriterion_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
Roles containing the 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
-
constraintDisplayValues(optional):
array constraintDisplayValues
Derived values for the constraint
-
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
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the constraint value
-
name(optional):
string
Display name of the constraint value
Example Response (application/json)
{
"constraintType":"grant",
"roles":[
{
"id":"adminRole"
}
],
"name":"Security Criterion for Catalog",
"description":"Grants access for catalogs: ClassicalMoviesCatalog, cloudCatalog, cloudLakeCatalog",
"securityCriteriaResource":{
"name":"Catalog Assets",
"id":"ora.catalogAssetResource"
},
"id":"sc-100001",
"lastModified":"2020-08-17T08:27:18.261Z",
"constraints":[
{
"values":[
"ClassicalMoviesCatalog",
"cloudLakeCatalog",
"cloudCatalog"
],
"constraintConfig":{
"id":"ora.catalogConstraintConfiguration"
},
"id":"scc-100001"
}
],
"actions":[
"create",
"delete",
"update"
]
}
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|
|------------------|------------------|
|22062|If input passed is invalid|
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