アイデンティティの取得
get
/identities
ロール、グループおよびユーザーを取得します。
リクエスト
問合せパラメータ
- applicationId(オプション):
検索するアプリケーション
- email(オプション):
アイデンティティの検索基準となるユーザーの電子メール
- firstName(オプション):
アイデンティティの検索基準となるユーザーの名前
- lastName(オプション):
アイデンティティの検索基準となるユーザーの姓
- limit(オプション):
ページ当たりの項目の最大数。1から100を設定します。デフォルトは25です。
- offset(オプション):
リスト項目のページにある最初の項目の索引。デフォルトは1です。
- scope(オプション):
検索範囲 - all (デフォルト)、user、group、role
- searchPattern(オプション):
検索パターン、大文字と小文字の区別なし、デフォルト、たとえばidentities?searchPattern=j&scope=user
レスポンス
サポートされているメディア・タイプ
- application/json
- application/xml
200レスポンス
成功
ルート・スキーマ: schema
レスポンスの例(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"
}
]
}例
次の例に、ロール、グループおよびユーザーを取得する場合のレスポンス本文を示します。
{
"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"
}]
}
cURLの詳細は、「cURLの使用」を参照してください