Oracle Identity Governance Self ServiceのREST API

リクエストの取得

get

/iam/governance/selfservice/api/v1/requests

Oracle Identity Managerで発生したすべてのリクエストを返します。ログイン・ユーザーのコンテキストでのリクエストが返されます。たとえば、エンド・ユーザーの場合、エンド・ユーザーに対して発生したリクエストまたはエンド・ユーザーによって発生したリクエストが表示されます。ただし、マネージャの場合、マネージャによって発生したかマネージャに対して発生したリクエスト、または直属の部下によって発生したか直属の部下に対して発生したリクエスト(あるいはその両方)が返されます。「セルフ・サービス」コンソールの「リクエストのトラッキング」タイルと「保留中の承認」タイルに対応する2つのビューがあります。取得されるビューは、trackRequestsまたはpendingApprovalsという値を指定できるパラメータ?viewによって決まります。デフォルトのビューはtrackRequestsです。たとえば、「保留中の承認」タイルに表示されるリクエストを確認するには、次を使用できます: GET /iam/governance/selfservice/api/v1/requests?view=pendingApprovals trackRequestsビューには、id、reqStatus、requester、reqCreatedOn、reqExpireOn、reqType、reqJustification、reqBeneficiaryListという属性が返されます。pendingApprovalsビューでは、id、title、creator、taskId、state、status、assignee、created、acquiredBy、expiresという属性が返されます。stateが問合せパラメータに含まれず、他の問合せパラメータが指定されない場合には、デフォルトの検索としてq=state eq Assignedが使用されることに注意してください。任意の状態のリクエストを取得するには、q=state eq Anyを使用します。q=title co abcなど他の問合せパラメータが使用されると、q=state eq Assignedというフィルタは自動的に適用されません。リクエストを問合せパラメータでフィルタして、結果セットを絞り込むことができます。次にview=trackRequestsの例をいくつか示します。trackRequestsはデフォルト・ビューであるため、パラメータview=trackRequestsの指定は任意です。requestIdが9のリクエストを取得します: GET /iam/governance/selfservice/api/v1/requests?view=trackRequests&q=id eq 9 reqStatusにwaitという文字列が含まれるリクエストをすべて取得します。この検索では大/小文字が区別されないことに注意してください: GET /iam/governance/selfservice/api/v1/requests?view=trackRequests&q=reqStatus co wait requesterのrequesterIdが15のリクエストをすべて取得します: GET /iam/governance/selfservice/api/v1/requests?view=trackRequests&q=beneficiary eq 15 作成時のタイムスタンプが特定の値であるリクエストをすべて取得します: GET /iam/governance/selfservice/api/v1/requests?limit=33&view=trackRequests&q=reqCreatedOn eq 2018-10-08T16:20:14Z reqTypeがCreate Roleのリクエストをすべて取得します。この検索では大/小文字が区別されないことに注意してください: GET /iam/governance/selfservice/api/v1/requests?view=trackRequests&q=reqType eq Create::Role 問合せパラメータ値のスペースを表すために"::"が使用されていることに注意してください。reqJustificationに文字列tempが含まれるすべてのリクエストを取得します。この検索では大/小文字が区別されないことに注意してください: GET /iam/governance/selfservice/api/v1/requests?view=trackRequests&q=reqJustification co temp 受益者リストにIDが17の受益者が含まれるリクエストをすべて取得します: GET /iam/governance/selfservice/api/v1/requests?view=trackRequests&q=beneficiary eq 17 問合せパラメータを組み合せられることと結果を制限できることに注意してください。たとえば、reqStatusに文字列「wait」が含まれ、requesterのrequesterIdが15であるリクエストを3つまで検索するには、次のようにします: GET /iam/governance/selfservice/api/v1/requests?limit=3&view=trackRequests&q=reqStatus co wait&requester eq 15 view=pendingApprovalsのフィルタ処理の例を次にいくつか示します。状態がASSIGNEDのすべてのリクエストを取得します。この検索では大/小文字が区別されないことに注意してください: GET /iam/governance/selfservice/api/v1/requests?view=pendingApprovals&q=state eq assigned stateについて問い合せるとき、指定可能な値は、Any、Assigned、Completed、Suspended、Withdrawn、Expired、Errored、Alerted、Deleted、Info_Requested、Staleです。stateが問合せパラメータに含まれず、他の問合せパラメータが指定されない場合には、デフォルトの検索としてstate eq assignedが使用されます。任意の状態のリクエストを取得するには、q=state eq Anyを使用します。IDが8であるリクエストを取得します: GET /iam/governance/selfservice/api/v1/requests?view=pendingApprovals&q=requestKey eq 8 titleに文字列"approval for Request ID 9"が含まれるリクエストをすべて取得します。この検索では大/小文字が区別されることに注意してください: GET /iam/governance/selfservice/api/v1/requests?view=pendingApprovals&q=title co approval::for::Request::ID::9 問合せパラメータ値のスペースを表すために"::"が使用されていることに注意してください。creator属性のユーザー・ログインの最初の文字がVであるリクエストをすべて取得します。この検索では大/小文字が区別されないことに注意してください: GET /iam/governance/selfservice/api/v1/requests?view=pendingApprovals&q=creator sw V taskIdに文字列"45e3-b94d"が含まれるリクエストをすべて取得します。この検索では大/小文字が区別されることに注意してください: GET /iam/governance/selfservice/api/v1/requests?view=pendingApprovals&q=taskId co 45e3-b94d

リクエスト

サポートされているメディア・タイプ

application/json

問合せパラメータ

fields(optional): string

結果に返される属性。RequestId属性は戻りリストで必須です。カンマ区切り属性を受け入れます。
q(optional): string

リクエストを取得する検索フィルタ。SCIMフィルタを受け入れます。フィルタ属性は、リクエスタ詳細または受益者詳細にできます。属性値に空白は使用できません。属性値に空白を渡す場合、"::"に置き換えます。フィルタのサンプル値は、"requester eq johnまたはbeneficiary eq avink"です。view=pendingApprovalsモードでは、フィルタ・パラメータ"q=state eq assigned"を使用して、保留中リクエストをフィルタできます
requestRaised: string

リクエストの発生元のユーザー
uuid(optional): string

ターゲット・ユーザーID
view(optional): string

ビューのタイプ。指定可能な値は、pendingApprovals/trackRequestsです

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

成功

ヘッダー

ResponseTime: string

リクエストの処理にかかった時間(ミリ秒)を取得します。

ルート・スキーマ: BulkReqGetResponse

型: object

ソースを表示

requests(optional): array requests
totalResult(optional): integer

{
    "properties":{
        "totalResult":{
            "type":"integer"
        },
        "requests":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserBulkRequest"
            }
        }
    }
}

ネストされたスキーマ: requests

型: array

ソースを表示

配列: オブジェクト UserBulkRequest

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserBulkRequest"
    }
}

ネストされたスキーマ: UserBulkRequest

型: object

ソースを表示

id(optional): string
links(optional): array links
reqCreatedOn(optional): string
reqExpireOn(optional): string
reqStatus(optional): string
reqType(optional): string
requester(optional): object Requester

{
    "properties":{
        "id":{
            "type":"string"
        },
        "reqStatus":{
            "type":"string"
        },
        "reqType":{
            "type":"string"
        },
        "requester":{
            "$ref":"#/definitions/Requester"
        },
        "reqCreatedOn":{
            "type":"string"
        },
        "reqExpireOn":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

配列: オブジェクト LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

ネストされたスキーマ: Requester

型: object

ソースを表示

id(optional): string
links(optional): array links

{
    "properties":{
        "id":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

ネストされたスキーマ: LinkDataInstances

型: object

ソースを表示

href(optional): string
rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

配列: オブジェクト LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

401レスポンス

未認可

404レスポンス

リソースが見つからない

500レスポンス

内部サーバー・エラー

デフォルト・レスポンス

予期しないエラー

先頭に戻る

例

この例では、すべてのリクエストのリクエスト情報を取得します。ここで表示された情報は疑似システムに対するものであり、プロトタイプとして使用します。

cURLの例

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/selfservice/api/v1/requests

GETレスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/?
offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/?
offset=1&limit=10"
        },
        {
            "rel": "next",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/?
offset=11&limit=10"
        }
    ],
    "count": 10,
    "hasMore": true,
    "totalResult": -1,
    "requests": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/12"
                }
            ],
            "id": "12",
            "reqStatus": "Request Completed",
            "requester": {
                "name": "requesterId",
                "value": "17",
                "link": {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                }
            },
            "reqCreatedOn": "2019-03-14T18:35:19Z",
            "reqExpireOn": "2019-03-14T18:54:57Z",
            "reqType": "Modify User Profile",
            "reqBeneficiaryList": [
                {
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                        }
                    ],
                    "id": "17"
                }
            ]
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/17"
                }
            ],
            "id": "17",
            "reqStatus": "Request Awaiting Approval",
            "requester": {
                "name": "requesterId",
                "value": "17",
                "link": {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                }
            },
            "reqCreatedOn": "2019-03-15T18:09:52Z",
            "reqType": "Modify User Profile",
            "reqBeneficiaryList": [
                {
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                        }
                    ],
                    "id": "17"
                }
            ]
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/19"
                }
            ],
            "id": "19",
            "reqStatus": "Request Completed",
            "requester": {
                "name": "requesterId",
                "value": "17",
                "link": {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                }
            },
            "reqCreatedOn": "2019-03-15T18:10:02Z",
            "reqExpireOn": "2019-03-18T19:14:43Z",
            "reqType": "Modify User Profile",
            "reqBeneficiaryList": [
                {
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                        }
                    ],
                    "id": "17"
                }
            ]
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/21"
                }
            ],
            "id": "21",
            "reqStatus": "Request Awaiting Approval",
            "requester": {
                "name": "requesterId",
                "value": "17",
                "link": {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                }
            },
            "reqCreatedOn": "2019-03-15T18:10:14Z",
            "reqType": "Modify User Profile",
            "reqBeneficiaryList": [
                {
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                        }
                    ],
                    "id": "17"
                }
            ]
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/1009"
                }
            ],
            "id": "1009",
            "reqStatus": "Request Awaiting Approval",
            "requester": {
                "name": "requesterId",
                "value": "17",
                "link": {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                }
            },
            "reqCreatedOn": "2019-03-18T20:47:34Z",
            "reqJustification": "Request role for sub-ordinate",
            "reqType": "Assign Roles",
            "reqBeneficiaryList": [
                {
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/24"
                        }
                    ],
                    "id": "24"
                }
            ]
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/1010"
                }
            ],
            "id": "1010",
            "reqStatus": "Request Awaiting Approval",
            "requester": {
                "name": "requesterId",
                "value": "17",
                "link": {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                }
            },
            "reqCreatedOn": "2019-03-18T20:51:02Z",
            "reqJustification": "Request role for sub-ordinate",
            "reqType": "Assign Roles",
            "reqBeneficiaryList": [
                {
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/24"
                        }
                    ],
                    "id": "24"
                }
            ]
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/11"
                }
            ],
            "id": "11",
            "reqStatus": "Request Awaiting Approval",
            "requester": {
                "name": "requesterId",
                "value": "17",
                "link": {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                }
            },
            "reqCreatedOn": "2019-03-14T18:33:44Z",
            "reqType": "Modify User Profile",
            "reqBeneficiaryList": [
                {
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                        }
                    ],
                    "id": "17"
                }
            ]
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/15"
                }
            ],
            "id": "15",
            "reqStatus": "Request Awaiting Approval",
            "requester": {
                "name": "requesterId",
                "value": "17",
                "link": {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                }
            },
            "reqCreatedOn": "2019-03-15T18:09:39Z",
            "reqType": "Modify User Profile",
            "reqBeneficiaryList": [
                {
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                        }
                    ],
                    "id": "17"
                }
            ]
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/16"
                }
            ],
            "id": "16",
            "reqStatus": "Request Awaiting Approval",
            "requester": {
                "name": "requesterId",
                "value": "17",
                "link": {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                }
            },
            "reqCreatedOn": "2019-03-15T18:09:47Z",
            "reqType": "Modify User Profile",
            "reqBeneficiaryList": [
                {
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                        }
                    ],
                    "id": "17"
                }
            ]
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/requests/18"
                }
            ],
            "id": "18",
            "reqStatus": "Request Completed",
            "requester": {
                "name": "requesterId",
                "value": "17",
                "link": {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                }
            },
            "reqCreatedOn": "2019-03-15T18:09:57Z",
            "reqExpireOn": "2019-03-18T19:14:10Z",
            "reqType": "Modify User Profile",
            "reqBeneficiaryList": [
                {
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/17"
                        }
                    ],
                    "id": "17"
                }
            ]
        }
    ]
}

先頭に戻る