Jump to

• Request
• Response

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(required): string
  The Security Criterion ID.

Query Parameters

• expand: string
  Expand query param: currently used to expand constraints information. Possible value for this query parameter is 'constraints'

  Allowed Values: [ "constraints" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAdminSecurityCriterion_response

Type: object

Show Source

• actions: array actions
  Array of actions on which the resource is constrained by the security criterion
• 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
• roles: array roles
  Roles containing the security criterion
• securityCriteriaResource: object securityCriteriaResource
  Resource for the security criterion

{
    "properties":{
        "constraintType":{
            "description":"Constraint type of the security criterion",
            "type":"string",
            "enum":[
                "grant",
                "deny",
                "grantNone"
            ]
        },
        "roles":{
            "description":"Roles containing the security criterion",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"ID of the role",
                        "type":"string"
                    }
                }
            }
        },
        "name":{
            "description":"Name of the security criterion",
            "type":"string"
        },
        "description":{
            "description":"Description of the security criterion",
            "type":"string"
        },
        "id":{
            "description":"ID of the security criterion",
            "type":"string"
        },
        "lastModified":{
            "description":"Last modified time stamp of the security criterion",
            "type":"string"
        },
        "securityCriteriaResource":{
            "description":"Resource for the security criterion",
            "type":"object",
            "properties":{
                "name":{
                    "description":"Name of the resource",
                    "type":"string"
                },
                "id":{
                    "description":"ID of the resource",
                    "type":"string"
                }
            }
        },
        "actions":{
            "description":"Array of actions on which the resource is constrained by the security criterion",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "constraints":{
            "description":"Constraints for the security criterion",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "constraintConfig":{
                        "description":"Constraint configuration for the resource",
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"ID of the constraint configuration",
                                "type":"string"
                            }
                        }
                    },
                    "values":{
                        "description":"IDs of the constraining asset type. Catalog IDs in case of ora.catalogConstraintConfiguration",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "constraintDisplayValues":{
                        "description":"Derived values for the constraint",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "name":{
                                    "description":"Display name of the constraint value",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"ID of the constraint value",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "id":{
                        "description":"ID of the security criterion constraint",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : actions

Type: array

Array of actions on which the resource is constrained by the security criterion

Show Source

• Array of: string

{
    "description":"Array of actions on which the resource is constrained by the security criterion",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : constraints

Type: array

Constraints for the security criterion

Show Source

• Array of: object items

{
    "description":"Constraints for the security criterion",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "constraintConfig":{
                "description":"Constraint configuration for the resource",
                "type":"object",
                "properties":{
                    "id":{
                        "description":"ID of the constraint configuration",
                        "type":"string"
                    }
                }
            },
            "values":{
                "description":"IDs of the constraining asset type. Catalog IDs in case of ora.catalogConstraintConfiguration",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "constraintDisplayValues":{
                "description":"Derived values for the constraint",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "name":{
                            "description":"Display name of the constraint value",
                            "type":"string"
                        },
                        "id":{
                            "description":"ID of the constraint value",
                            "type":"string"
                        }
                    }
                }
            },
            "id":{
                "description":"ID of the security criterion constraint",
                "type":"string"
            }
        }
    }
}

Nested Schema : roles

Type: array

Roles containing the security criterion

Show Source

• Array of: object items

{
    "description":"Roles containing the security criterion",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"ID of the role",
                "type":"string"
            }
        }
    }
}

Nested Schema : securityCriteriaResource

Type: object

Resource for the security criterion

Show Source

• id: string
  ID of the resource
• name: string
  Name of the resource

{
    "description":"Resource for the security criterion",
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the resource",
            "type":"string"
        },
        "id":{
            "description":"ID of the resource",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "constraintConfig":{
            "description":"Constraint configuration for the resource",
            "type":"object",
            "properties":{
                "id":{
                    "description":"ID of the constraint configuration",
                    "type":"string"
                }
            }
        },
        "values":{
            "description":"IDs of the constraining asset type. Catalog IDs in case of ora.catalogConstraintConfiguration",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "constraintDisplayValues":{
            "description":"Derived values for the constraint",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Display name of the constraint value",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the constraint value",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"ID of the security criterion constraint",
            "type":"string"
        }
    }
}

Nested Schema : constraintConfig

Type: object

Constraint configuration for the resource

Show Source

• id: string
  ID of the constraint configuration

{
    "description":"Constraint configuration for the resource",
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of the constraint configuration",
            "type":"string"
        }
    }
}

Nested Schema : constraintDisplayValues

Type: array

Derived values for the constraint

Show Source

• Array of: object items

{
    "description":"Derived values for the constraint",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Display name of the constraint value",
                "type":"string"
            },
            "id":{
                "description":"ID of the constraint value",
                "type":"string"
            }
        }
    }
}

Nested Schema : values

Type: array

IDs of the constraining asset type. Catalog IDs in case of ora.catalogConstraintConfiguration

Show Source

• Array of: string

{
    "description":"IDs of the constraining asset type. Catalog IDs in case of ora.catalogConstraintConfiguration",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• id: string
  ID of the constraint value
• name: string
  Display name of the constraint value

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Display name of the constraint value",
            "type":"string"
        },
        "id":{
            "description":"ID of the constraint value",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id: string
  ID of the role

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of the role",
            "type":"string"
        }
    }
}

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|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top