REST APIs for Oracle Identity Role Intelligence

Search Resources Based On Criteria

post

/oiri/api/v1/task/resources/{resourcetype}/.search

Request

Path Parameters

resourcetype: string

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

criteria(optional): array criteria
pagination(optional): object pagination
returnAttributes(optional): array returnAttributes

{
    "properties":{
        "criteria":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Criteria"
            }
        },
        "pagination":{
            "required":[
                "offset",
                "limit"
            ],
            "type":"object",
            "properties":{
                "offset":{
                    "type":"string"
                },
                "limit":{
                    "type":"string"
                }
            }
        },
        "returnAttributes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : criteria

Type: array

Show Source

Array of: object Criteria

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Criteria"
    }
}

Nested Schema : pagination

Type: object

Show Source

limit: string
offset: string

{
    "required":[
        "offset",
        "limit"
    ],
    "type":"object",
    "properties":{
        "offset":{
            "type":"string"
        },
        "limit":{
            "type":"string"
        }
    }
}

Nested Schema : returnAttributes

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Criteria

Type: object

Show Source

filter(optional): string
type(optional): string

{
    "properties":{
        "type":{
            "type":"string"
        },
        "filter":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful Operation

Root Schema : ResourceTypeSearchResponse

Type: object

Show Source

count(optional): number
limit(optional): number
offset(optional): number
resource(optional): object resource
totalCount(optional): number

{
    "properties":{
        "resource":{
            "properties":{
                "type":{
                    "type":"string"
                },
                "results":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "userLogin":{
                                "type":"string"
                            },
                            "displayName":{
                                "type":"string"
                            },
                            "organization":{
                                "type":"string"
                            },
                            "id":{
                                "type":"string"
                            }
                        }
                    }
                }
            },
            "type":"object"
        },
        "totalCount":{
            "type":"number"
        },
        "limit":{
            "type":"number"
        },
        "offset":{
            "type":"number"
        },
        "count":{
            "type":"number"
        }
    }
}

Nested Schema : resource

Type: object

Show Source

results(optional): array results
type(optional): string

{
    "properties":{
        "type":{
            "type":"string"
        },
        "results":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "userLogin":{
                        "type":"string"
                    },
                    "displayName":{
                        "type":"string"
                    },
                    "organization":{
                        "type":"string"
                    },
                    "id":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "userLogin":{
                "type":"string"
            },
            "displayName":{
                "type":"string"
            },
            "organization":{
                "type":"string"
            },
            "id":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayName(optional): string
id(optional): string
organization(optional): string
userLogin(optional): string

{
    "type":"object",
    "properties":{
        "userLogin":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "organization":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}