ジャンプ先

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

リクエストの取下げ

delete

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

ペイロードで指定されたリクエストを取り下げます。ペイロードは、取り下げられるリクエストIDを含むオブジェクトの配列が必要です。

リクエスト

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

• application/json

本文()

取り下げるリクエスト。

ルート・スキーマ: BulkReqDeleteRequest

型: object

ソースを表示

• requests(optional): array requests

{
    "properties":{
        "requests":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReqDeleteRequestEntity"
            }
        }
    }
}

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

型: array

ソースを表示

• [0]: object ReqDeleteRequestEntity

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

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

型: object

ソースを表示

• id(optional): string
• requestId(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

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

本文()

ルート・スキーマ: BulkReqDeleteResponse

型: object

ソースを表示

• requests(optional): array requests

{
    "properties":{
        "requests":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReqDeleteResponseEntity"
            }
        }
    }
}

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

型: array

ソースを表示

• [0]: object ReqDeleteResponseEntity

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

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

型: object

ソースを表示

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

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        }
    }
}

401レスポンス

未認可

403レスポンス

禁止

500レスポンス

内部サーバー・エラー

デフォルト・レスポンス

予期しないエラー

先頭に戻る

例

この例では、バルク操作によるリクエスト削除の機能を示します。成功と失敗の両方を示しています。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

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

DELETEリクエスト本文の例

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

{
  "requests": [
    {
      "requestId": "3004",
      "id": "1"
    },
    {
      "requestId": "3007",
      "id": "2"
    },
    {
      "requestId": "2030",
      "id": "3"
    }
  ]
}

DELETEレスポンス本文の例

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

{
  "requests": [
    {
      "id": "1",
      "status": "FAILED",
      "reason": "User Test user1 can not withdraw request 3004 currently in Request Withdrawn stage."
    },
    {
      "id": "2",
      "requestId": "3007",
      "status": "SUCCESS"
    },
    {
      "id": "3",
      "requestId": "2030",
      "status": "FAILED",
      "reason": "User Test user1 can not withdraw request 2030 currently in Request Withdrawn stage."
    }
  ]
}

先頭に戻る