ジャンプ先

• リクエスト
• レスポンス
• 例

アプリケーション・インスタンスの取得

get

/iam/governance/selfservice/api/v1/applications

Oracle Identity Managerで使用できるすべてのアプリケーション・インスタンス・リストを返します。リストでは、カタログで非表示になっているアプリケーション・インスタンスも示します。フィルタ問合せパラメータを使用して、アプリケーション・インスタンスのサブセットを取得します。

リクエスト

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

• application/json

問合せパラメータ

• fields(optional): string
  結果に返される属性。カンマ区切り属性を受け入れます。
• q(optional): string
  レコードを取得する検索フィルタ。SCIMフィルタを受け入れます。属性値に空白は使用できません。属性値に空白を渡す場合、"::"に置き換えます。フィルタでサポートされている属性は、appInstanceName、appInstanceTypeおよびdisplayNameです。フィルタのサンプル値は、"appInstanceType eq DisconnectedまたはdisplayName eq Plan::ViewまたはappInstanceName eq ADAppInstance"です。フィルタでは、"offset"、"limit"、"orderBy"もサポートしています。例: offset=3&limit=5&orderBy=appInstanceName:descending

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

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

本文()

ルート・スキーマ: GetApplicationsResponse

型: object

ソースを表示

• applications(optional): array applications
• count(optional): integer
• links(optional): array links

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "applications":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GetApplicationsResponseEntity"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト GetApplicationsResponseEntity

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

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

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

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

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

型: object

ソースを表示

• description(optional): string
• displayName(optional): string
• id(optional): string
• links(optional): array links
• name(optional): string
• type(optional): string

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

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

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

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

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

型: object

ソースを表示

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

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

401レスポンス

未認可

404レスポンス

リソースが見つからない

500レスポンス

内部サーバー・エラー

デフォルト・レスポンス

予期しないエラー

先頭に戻る

例

この例では、OIMでアプリケーションを取得する機能を示します。ここで表示された情報は疑似システムに対するものであり、プロトタイプとして使用します。

cURLの例

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

GETレスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/applications/?
offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/applications/?
offset=1&limit=10"
        }
    ],
    "count": 3,
    "hasMore": false,
    "totalResult": -1,
    "applications": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/applications/2"
                }
            ],
            "id": "2",
            "name": "VisionPurchasing",
            "description": "Vision Purchasing Desc",
            "displayName": "Vision Purchasing Disp",
            "type": "DOBBased"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/applications/1"
                }
            ],
            "id": "1",
            "name": "VisionEmployeesDomain",
            "description": "Vision Employees Domain Desc",
            "displayName": "Vision Employees Domain Disp",
            "type": "DOBBased"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com/iam/governance/selfservice/api/v1/applications/3"
                }
            ],
            "id": "3",
            "name": "DisconnectedAppInstance1",
            "description": "DisconnectedAppInstance1",
            "displayName": "DisconnectedAppInstance1",
            "type": "Disconnected"
        }
    ]
}

先頭に戻る