Axway · Example Payload

Axway Org Userprimary Example

API ManagementEnterpriseIntegrationSecurity

Axway Org Userprimary 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": "org_userPrimary",
  "method": "PUT",
  "path": "/org/{org_id}/user/{user_guid}/primary",
  "summary": "Axway Sets the Primary Contract for the Org",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "OrgUserprimary200Example",
      "example": "example_value"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "PRIMARY_NOT_ADMIN",
      "example": {
        "success": false,
        "description": "The primary contact must be an administrator of the organization.",
        "code": 400
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "FORBIDDEN",
      "example": {
        "$ref": "#/components/examples/FORBIDDEN/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "NOT_FOUND",
      "example": {
        "$ref": "#/components/examples/NOT_FOUND/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "IDP_REQUIRED",
      "example": {
        "$ref": "#/components/examples/IDP_REQUIRED/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "USER_NOT_ADMIN",
      "example": {
        "$ref": "#/components/examples/USER_NOT_ADMIN/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "LOGIN_REQUIRED",
      "example": {
        "$ref": "#/components/examples/LOGIN_REQUIRED/value"
      }
    },
    {
      "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"
      }
    },
    {
      "status": "403",
      "contentType": "application/json",
      "name": "USER_NOT_MEMBER",
      "example": {
        "success": false,
        "description": "User is not a member of this organization.",
        "code": 403
      }
    }
  ]
}