Jump to

• Request
• Response
• Examples

Withdraw Requests

delete

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

Withdraws requests specified in the payload. The payload needs an array of objects containing the request ID which is to be withdrawn.

Request

Supported Media Types

• application/json

Body ()

Requests to withdraw.

Root Schema : BulkReqDeleteRequest

Type: object

Show Source

• requests(optional): array requests

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

Nested Schema : requests

Type: array

Show Source

• Array of: object ReqDeleteRequestEntity

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

Nested Schema : ReqDeleteRequestEntity

Type: object

Show Source

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

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : BulkReqDeleteResponse

Type: object

Show Source

• requests(optional): array requests

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

Nested Schema : requests

Type: array

Show Source

• Array of: object ReqDeleteResponseEntity

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

Nested Schema : ReqDeleteResponseEntity

Type: object

Show Source

• 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 Response

Unauthorized

403 Response

Forbidden

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

This example demonstrates the ability for bulk operation of the deleting of requests. It shows both success and failure. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

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

Example of DELETE Request Body

The following example shows the contents of the request body in JSON format.

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

Example of DELETE Response Body

The following example shows the contents of the response body in JSON format.

{
    "requests": [
        {
            "id": "2",
            "requestId": "3007",
            "status": "SUCCESS"
        },
        {
            "id": "3",
            "requestId": "2030",
            "status": "SUCCESS"
        }
    ]
}

Back to Top