Oracle Identity Governance Self ServiceのREST API

プロビジョニング・タスク(複数)の更新

put

/iam/governance/selfservice/api/v1/provtasks

ペイロード・リストの一部としてすべてのプロビジョニング・タスクを更新します。

リクエスト

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

application/json

プロビジョニング・タスクの入力

ルート・スキーマ: BulkProvisioningTaskRequest

型: object

ソースを表示

tasks(optional): array tasks

{
    "properties":{
        "tasks":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskRequest"
            }
        }
    }
}

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

型: array

ソースを表示

配列: オブジェクト TaskRequest

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

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

型: object

ソースを表示

fields(optional): array fields
id(optional): string
requestId(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        }
    }
}

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

型: array

ソースを表示

配列: オブジェクト Fields

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

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

型: object

ソースを表示

name(optional): string
value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

成功

ヘッダー

ResponseTime: string

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

ルート・スキーマ: BulkProvisioningTaskResponse

型: object

ソースを表示

links(optional): array links
tasks(optional): array tasks

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

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

型: array

ソースを表示

配列: オブジェクト LinkDataInstances

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

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

型: array

ソースを表示

配列: オブジェクト BulkProvisioningTaskResponseInstance

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

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

型: object

ソースを表示

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

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

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

型: object

ソースを表示

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

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

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

型: array

ソースを表示

配列: オブジェクト LinkDataInstances

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

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

リソースが見つからない

500レスポンス

内部サーバー・エラー

デフォルト・レスポンス

予期しないエラー

先頭に戻る

例

複数のプロビジョニング・タスクの更新方法を示す例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行して1つのリクエストで複数のプロビジョニング・タスクを更新する方法を示しています。ここで表示された情報は疑似システムに対するものであり、プロトタイプとして使用します。cURLの詳細は、「cURLの使用」を参照してください

curl  -H "Content-Type: application/json"  -H "X-Requested-By: <anyvalue>"  -X PUT  -u username:password  -d @put.json https://pseudo.com/iam/governance/selfservice/api/v1/provtasks

PUTリクエスト本文の例

次の例に、JSON形式のリクエスト本文のコンテンツを示します。

{
 "tasks":[
     {
	   "id" : "3016",
	   "requestId" : "10001",
           "action": "reassign",
	   "fields": [
		  {
			"name": "assignee",
			"value": "23"
		  },
		  {
			"name": "type",
			"value": "user"
		  }
	    ]
     },
     {
     	  "id" : "3018",
     	  "requestId" : "10002",
   	  "action": "reassign",
	  "fields": [
		  {
			"name": "assignee",
			"value": "23"
		  },
		  {
			"name": "type",
			"value": "user"
		  }
	    ]
     }
  ]
}

PUTレスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/provtasks"
        }
    ],
    "tasks": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": 
"https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/3018"
                }
            ],
            "id": "3018",
            "status": "SUCCESS",
            "requestId": "10002",
            "action": "reassign"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": 
"https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/3016"
                }
            ],
            "id": "3016",
            "status": "SUCCESS",
            "requestId": "10001",
            "action": "reassign"
        }
    ]
}

プロビジョニング・タスクの一括再試行方法を示す例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行してプロビジョニング・タスクを一括再試行する方法を示しています。ここで表示された情報は疑似システムに対するものであり、プロトタイプとして使用します。

 curl -X PUT --verbose -k -1  -H "Content-Type: application/json" -H "X-Requested-By: provtask"  -u username:password  -d '{
		"tasks": [
			{
				"id":"<Prov-Task_ID>",		
				"action":"retry",
				"taskId":"<Prov-Task_ID>" 
	     },
         { 
		      "id":"<Prov-Task_ID>", 
			  "action":"retry", 
			  "taskId":"<Prov-Task_ID>" 
	      }
        ]
  }'https://pseudo.com/iam/governance/selfservice/api/v1/provtasks

PUTリクエスト本文の例

次の例に、JSON形式のリクエスト本文のコンテンツを示します。

{
     "tasks": [
          { 
		     "id":"<Prov-Task_ID>", 
			 "action":"retry", 
			 "taskId":"<Prov-Task_ID>" 
	      },
          { 
		      "id":"<Prov-Task_ID>", 
			  "action":"retry", 
			  "taskId":"<Prov-Task_ID>" 
	      }
        ]
}

PUTレスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/provtasks"
        }
    ],
    "tasks": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/30"
                }
            ],
            "id": "30",
            "status": "FAIL",
            "action": "retry",
            "reason": "This task is not automated. If task is completed, set status to UC."
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "https://pseudo.com/iam/governance/selfservice/api/v1/provtasks/31"
                }
            ],
            "id": "31",
            "status": "FAIL",
            "action": "retry",
            "reason": "This task is not automated. If task is completed, set status to UC."
        }
    ]
}

先頭に戻る