Search operation on entities
get
/exports
Returns list of entities that match the search operation.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
entityType(required): string
Entity type for which search operation needs to be performed. For global search operation its value should be * .
-
searchPattern(required): string
Search pattern based on which entity will be searched.
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
OK
Root Schema : searchentity-response
Type:
array
The request was successfully completed. The response body includes information about the entities.
Show Source
Nested Schema : searchentity-array
Type:
Show Source
object
-
entityName:
string
Name of the entity that matches the search operation.
-
entityType:
string
Type of the entity that matches the search operation.
-
entityTypeDisplay:
string
Specify the display name of entity type which is locale dependent.
-
message:
string
The text message of search operation that can be displayed on the interface, if any.
Examples
This example retrieves all the entity that match the search criteria. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/json" -H "Accept: application/json" -X GET -u username:password https://pseudo.com/iam/governance/configmgmt/rest/exports?entityType=AdminRole&searchPattern=*Orcl*
Example of Response Body
The following example shows the contents of the response body in JSON format.
[ { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMSystemAdministrator", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMSystemConfigurator", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMCatalogAdmin", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMRoleAdministrator", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMRoleAuthorizer", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMRoleViewer", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMEntitlementAdministrator", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMEntitlementAuthorizer", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMEntitlementViewer", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMApplicationInstanceAdministratorRole", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMApplicationInstanceAuthorizerRole", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMApplicationInstanceViewerRole", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMOrgAdministrator", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMOrgViewer", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMUserAdmin", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMUserHelpDesk", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMUserViewer", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMSPMLAdmin", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMAdminRoleAdministrator", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMIdentityAuditAdministrator", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMIdentityAuditViewer", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMCertificationAdministrator", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMCertificationViewer", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMAccessPolicyAdministrator", "message": null }, { "entityType": "AdminRole", "entityTypeDisplay": "Admin Role", "entityName": "OrclOIMAccessPolicyViewer", "message": null } ]