REST API for Oracle Business Process Management

Retrieve Identities

get

/identities

Retrieves roles, groups, and users.

Request

Query Parameters

applicationId: Application in which to search
email: Search identites by email of user
firstName: Search identities by firstName of User
lastName: Search identites by lastName of user
limit: Maximum number of items per page. Set between 1 and 100. Default is 25.
offset: Index for the first item on a page of list items. Default is 1.
scope: Search scope - all (default), user, group, role
searchPattern: Pattern to search for, not case sensitive, default , for example identities?searchPattern=j&scope=user

Response

Supported Media Types

application/json
application/xml

200 Response

Success

Body

Root Schema : /paths/~1identities/get/responses/200/schema

Example application/json


{
    "totalResult":false,
    "hasMore":false,
    "items":[
        {
            "levels":0,
            "title":"oraclesystemuser",
            "id":"oraclesystemuser",
            "type":"user",
            "idLink":{
                "href":"http://example.com/bpm/api/3.0/identities/user/oraclesystemuser",
                "length":0,
                "rel":"self"
            },
            "lastName":"OracleSystemUser"
        },
        {
            "levels":0,
            "title":"jstein",
            "id":"jstein",
            "type":"user",
            "idLink":{
                "href":"http://example.com/bpm/api/3.0/identities/user/jstein",
                "length":0,
                "rel":"self"
            },
            "lastName":"jstein"
        },
        {
            "lastName":"Dickens",
            "id":"cdickens",
            "email":"cdickens@emailExample.com",
            "firstName":"Charles",
            "idLink":{
                "href":"http://example.com/bpm/api/3.0/identities/user/cdickens",
                "length":0,
                "rel":"self"
            },
            "levels":0,
            "title":"cdickens",
            "type":"user",
            "mobile":"300000001"
        },
        {
            "levels":0,
            "id":"LargeTestGroup",
            "type":"group",
            "email":"",
            "idLink":{
                "href":"http://example.com/bpm/api/3.0/identities/group/LargeTestGroup",
                "length":0,
                "rel":"self"
            }
        }
    ],
    "links":[
        {
            "href":"http://example.com/bpm/api/3.0/",
            "length":0,
            "rel":"back"
        },
        {
            "href":"http://example.com/bpm/api/3.0/identities?searchPattern=*&applicationId=",
            "length":0,
            "rel":"self"
        }
    ]
}

Examples

The following example shows a response body when retrieving roles, groups, and users.

    {
                      "totalResult": false,
                      "hasMore": false,
                      "items": [{
                      "levels": 0,
                      "title": "oraclesystemuser",
                      "id": "oraclesystemuser",
                      "type": "user",
                      "idLink": {
                      "href": "http://example.com/bpm/api/3.0/identities/user/oraclesystemuser",


                      "length": 0,
                      "rel": "self"
                                   },
                      "lastName": "OracleSystemUser"
                          }, {
                      "levels": 0,


                      "title": "jstein",
                      "id": "jstein",
                      "type": "user",
                      "idLink": {
                      "href": "http://example.com/bpm/api/3.0/identities/user/jstein",
                      "length": 0,
                      "rel": "self"
                       },

                      "lastName": "jstein"
                      }, {

                     "levels": 0,
                     "title": "cdickens",
                     "id": "cdickens",
                     "type": "user",
                     "email": "cdickens@emailExample.com",
                     "idLink": {
                     "href": "http://example.com/bpm/api/3.0/identities/user/cdickens",


                     "length": 0,
                     "rel": "self"
                         },
                     "firstName": "Charles",
                     "lastName": "Dickens",
                      "mobile": "300000001"
                     },
                      {
                       "levels": 0,


                      "id": "LargeTestGroup",
                     "type": "group",
                     "email": "",
                     "idLink": {
                      "href": "http://example.com/bpm/api/3.0/identities/group/LargeTestGroup",


                     "length": 0,
                       "rel": "self" 
                         }
                     }],
                     "links": [{
                     "href": "http://example.com/bpm/api/3.0/",
                     "length": 0,
                     "rel": "back"
                     }, {
                     "href": "http://example.com/bpm/api/3.0/identities?searchPattern=*&applicationId=",
                     "length": 0,
                      "rel": "self"
                     }]
                   }

For more information about cURL, see Use cURL