listAdminSecurityCriteria
get
/ccadmin/v1/adminSecurityCriteria
List Admin security criteria. Get all admin security criteria.
Request
Supported Media Types
- application/json
Query Parameters
-
expand: string
Expand query param: currently used to expand constraints information. Possible value for this query parameter is 'constraints'Allowed Values:
[ "constraints" ] -
limit: string
This is the field to determine number of items to be fetched per REST call.
-
offset: string
This field determines the offset/starting index from which data to be fetched.
-
q: string
SCIM query to search on the security criteria properties.
-
sort: string
This is the field to provide sort on the security criteria properties
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listAdminSecurityCriteria_response
Type:
Show Source
object-
items:
array items
List of admin security criteria
-
limit:
string
Number of items to be fetched.
-
offset:
string
The offset provided.
-
sort:
array sort
An array that specifies the sort order.
-
total:
string
Total number of items matching the searched string.
-
totalResults:
string
Total number of items matching the searched string.
Nested Schema : items
Type:
Show Source
object-
constraints:
array constraints
Constraints for the security criterion
-
constraintType:
string
Allowed Values:
[ "grant", "deny", "grantNone" ]Constraint type of the security criterion -
description:
string
Description of the security criterion
-
id:
string
ID of the security criterion
-
lastModified:
string
Last modified time stamp of the security criterion
-
name:
string
Name of the security criterion
-
securityCriteriaResource:
object securityCriteriaResource
Resource for the security criterion
Nested Schema : securityCriteriaResource
Type:
objectResource for the security criterion
Show Source
-
id:
string
ID of the resource
-
name:
string
Name of the resource
Nested Schema : items
Type:
Show Source
object-
constraintConfig:
object constraintConfig
Constraint configuration for the resource
-
constraintDisplayValues:
array constraintDisplayValues
Derived values for the constraint
-
id:
string
ID of the security criterion constraint
-
values:
array values
IDs of the constraining asset type. Catalog IDs in case of ora.catalogConstraintConfiguration
Nested Schema : constraintConfig
Type:
objectConstraint configuration for the resource
Show Source
-
id:
string
ID of the constraint configuration
Nested Schema : values
Type:
arrayIDs of the constraining asset type. Catalog IDs in case of ora.catalogConstraintConfiguration
Show Source
Nested Schema : items
Type:
Show Source
object-
id:
string
ID of the constraint value
-
name:
string
Display name of the constraint value
Nested Schema : items
Type:
Show Source
object-
order:
string
Whether this property should be sorted ascending ("asc") or descending ("dsc").
-
property:
string
The name of the property to use for sorting.
Example Response (application/json)
{
"total":2,
"totalResults":2,
"offset":0,
"limit":250,
"sort":[
{
"property":"id",
"order":"asc"
}
],
"items":[
{
"constraintType":"grant",
"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"
},
{
"constraintType":"deny",
"name":"Security Criterion for Catalog",
"description":"Denies access to catalogs: cloudLakeCatalog",
"securityCriteriaResource":{
"name":"Catalog Assets",
"id":"ora.catalogAssetResource"
},
"id":"sc-100002",
"lastModified":"2020-08-17T08:29:05.142Z"
}
]
}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|
|------------------|------------------|
|22063|If input passed is invalid|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code