ジャンプ先

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

リクエストIDに基づいたリクエストの更新

put

/iam/governance/selfservice/api/v1/requests/{reqid}

指定されたリクエストを更新します。Oracle Identity ManagerのリクエストIDは、パス・パラメータで指定する必要があります。リクエストを更新するための更新詳細は、ペイロードで指定する必要があります。リクエスト・データを更新したり、リクエスト・ステータスを更新できます。リクエスト・データを更新したり、リクエスト・ステータスを更新できます。指定されたアクション属性のタイプに基づいて、SOAまたはOIMアクションが実行されます。ここで、アクションは、APPROVE、RELEASE、RESUME、REASSIGN、REJECT、ESCALATE、SUSPEND、WITHDRAW、CLAIM、SAVE、CREATESUBTASK、SKIPASSIGNMENTにできます。これらに加えて、リクエスト上で実行可能なCLOSE操作もあります。追加のTaskIdをリクエストに指定すると、特定のタスク上で排他的に操作を実行できます。taskIdを指定しない場合、リスト内の最初のタスクがrequestIdでリクエストされた操作に選択されます。

リクエスト

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

• application/json

パス・パラメータ

• reqid: string
  リクエストID

本文()

更新するリクエストの属性リスト

ルート・スキーマ: ReqUpdateRequest

型: object

ソースを表示

• action(optional): string
• actionComment(optional): string
• assignees(optional): array assignees
• reqTargetEntities(optional): array reqTargetEntities
• requestId(optional): string
• taskId(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "taskId":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "actionComment":{
            "type":"string"
        },
        "assignees":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PendingApprovalsAssigneeNames"
            }
        },
        "reqTargetEntities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reqTargetEntityRequestPayload"
            }
        }
    }
}

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

型: array

ソースを表示

• [0]: object PendingApprovalsAssigneeNames

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

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

型: array

ソースを表示

• [0]: object reqTargetEntityRequestPayload

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

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

型: object

ソースを表示

• name(optional): string
• type(optional): string

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

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

型: object

ソースを表示

• appFormData(optional): array appFormData
• catalogId(optional): string
• entityId(optional): string
• entityName(optional): string
• entityType(optional): string
• parentAccountId(optional): integer
• parentAccountName(optional): string

{
    "properties":{
        "entityName":{
            "type":"string"
        },
        "entityId":{
            "type":"string"
        },
        "catalogId":{
            "type":"string"
        },
        "entityType":{
            "type":"string"
        },
        "parentAccountId":{
            "type":"integer"
        },
        "parentAccountName":{
            "type":"string"
        },
        "appFormData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Fields"
            }
        }
    }
}

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

型: array

ソースを表示

• [0]: object 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
  リクエストの処理にかかった時間(ミリ秒)を取得します。

本文()

ルート・スキーマ: ReqUpdateResponseEntity

型: object

ソースを表示

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

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

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

型: array

ソースを表示

• [0]: object LinkDataInstances

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

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

型: object

ソースを表示

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

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

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

リソースが見つからない

500レスポンス

内部サーバー・エラー

先頭に戻る

例

この例では、保留中リクエストを承認する機能を示します。

cURLの例

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

PUTリクエスト本文の例

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

{
  "requestId": "coder-1001",
  "taskId": "2c91aeca-9169-47fd-847f-466763af278a",
  "action": "approve"
}

PUTレスポンス本文の例

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

{
  "links": [
    {
      "rel": "self",
      "href": "https://pseudo.com/iam/governance/selfservice/api/v1/requests/1235"
    }
  ],
  "id": "1235",
  "requestId": "coder-1001",
  "status": "SUCCESS"
}

先頭に戻る