Axway · Example Payload

Axway User Remove Example

API ManagementEnterpriseIntegrationSecurity

Axway User Remove Example is an example object payload from Axway, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "user_remove",
  "method": "DELETE",
  "path": "/user/{user_id}",
  "summary": "Axway Remove User",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "400",
      "contentType": "application/json",
      "name": "NOT_FOUND",
      "example": {
        "$ref": "#/components/examples/NOT_FOUND/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "ORG_DELETE_UNAVAILABLE",
      "example": {
        "success": false,
        "description": "Your organization cannot be automatically deleted.",
        "code": 400
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "USER_IS_PRIMARY",
      "example": {
        "success": false,
        "description": "The primary contact of an organization cannot be removed.",
        "code": 400
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "FORBIDDEN",
      "example": {
        "$ref": "#/components/examples/FORBIDDEN/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "LOGIN_REQUIRED",
      "example": {
        "$ref": "#/components/examples/LOGIN_REQUIRED/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "AUTH_CODE_INVALID",
      "example": {
        "success": false,
        "description": "Invalid authorization code.",
        "code": 400
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "PARAM_INVALID",
      "example": {
        "$ref": "#/components/examples/PARAM_INVALID/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "PARAM_REQUIRED",
      "example": {
        "$ref": "#/components/examples/PARAM_REQUIRED/value"
      }
    }
  ]
}