Jump to

• Request
• Response
• Examples

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: string
  Entity type for which search operation needs to be performed. For global search operation its value should be * .
• searchPattern: string
  Search pattern based on which entity will be searched.

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Body ()

The request was successfully completed. The response body includes information about the entities.

Root Schema : searchentity-response

Type: array

The request was successfully completed. The response body includes information about the entities.

Show Source

• [0]: object searchentity-array

{
    "type":"array",
    "description":"The request was successfully completed. The response body includes information about the entities.",
    "items":{
        "$ref":"#/definitions/searchentity-array"
    }
}

Nested Schema : searchentity-array

Type: object

Show Source

• entityName(optional): string
  Name of the entity that matches the search operation.
• entityType(optional): string
  Type of the entity that matches the search operation.
• entityTypeDisplay(optional): string
  Specify the display name of entity type which is locale dependent.
• message(optional): string
  The text message of search operation that can be displayed on the interface, if any.

{
    "properties":{
        "entityType":{
            "type":"string",
            "description":"Type of the entity that matches the search operation."
        },
        "entityTypeDisplay":{
            "type":"string",
            "description":"Specify the display name of entity type which is locale dependent."
        },
        "entityName":{
            "type":"string",
            "description":"Name of the entity that matches the search operation."
        },
        "message":{
            "type":"string",
            "description":"The text message of search operation that can be displayed on the interface, if any."
        }
    }
}

Back to Top

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
  }
]

Back to Top