Axway · Example Payload

Axway Auth Login Example

API ManagementEnterpriseIntegrationSecurity

Axway Auth Login 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": "auth_login",
  "method": "POST",
  "path": "/auth/login",
  "summary": "Axway Sign-in",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "AuthLogin200Example",
      "example": "example_value"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "FORBIDDEN",
      "example": {
        "$ref": "#/components/examples/FORBIDDEN/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "INVALID_LOGIN",
      "example": {
        "success": false,
        "description": "Invalid username or password.",
        "code": 400,
        "internalCode": 2
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "INVALID_LOGIN_HOSTNAME",
      "example": {
        "success": false,
        "description": "Sign-in not supported on this hostname.",
        "code": 400
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "INVALID_LOGIN_USERNAME",
      "example": {
        "success": false,
        "description": "Username must be a valid email address.",
        "code": 400,
        "internalCode": 2
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "LOGIN_EXTERNAL_CLI",
      "example": {
        "success": false,
        "description": "Your account is associated with an external identity provider. Please visit /user/credentials to set tooling credentials for your account.",
        "code": 400,
        "internalCode": 12
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "LOGIN_EXTERNAL_USER",
      "example": {
        "success": false,
        "description": "Your account is associated with an external identity provider. Please sign in via the service you created your account with.",
        "code": 400
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "MISSING_PASSWORD",
      "example": {
        "success": false,
        "description": "User must reset password.",
        "code": 400,
        "internalCode": 13
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "USER_NOT_ACTIVATED",
      "example": {
        "success": false,
        "description": "Your account has not been activated yet. Please check your email.",
        "code": 400,
        "internalCode": 3
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "INVALID_SWITCH_ORG",
      "example": {
        "success": false,
        "description": "You are not a member of this organization or it is no longer active. Please contact your administrator or the Amplify Platform support team.",
        "code": 400
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "IDP_REQUIRED",
      "example": {
        "$ref": "#/components/examples/IDP_REQUIRED/value"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "PROVIDER_CONSUMER_DISABLED",
      "example": {
        "success": false,
        "description": "Consumer organization access is disabled.",
        "code": 400,
        "internalCode": 431
      }
    },
    {
      "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": "401",
      "contentType": "application/json",
      "name": "USER_NOT_ACTIVE",
      "example": {
        "success": false,
        "description": "Your account is not active. Please contact your administrator or the Amplify Platform support team.",
        "code": 401,
        "internalCode": 4
      }
    },
    {
      "status": "403",
      "contentType": "application/json",
      "name": "NO_ACTIVE_ORGS",
      "example": {
        "success": false,
        "description": "You are not a member of any active organizations. Please contact your administrator or the Amplify Platform support team.",
        "code": 403,
        "internalCode": 626
      }
    },
    {
      "status": "403",
      "contentType": "application/json",
      "name": "PENDING_ORG",
      "example": {
        "success": false,
        "description": "Your organization requires approval. You will be notified by email when the organization is approved.",
        "code": 403,
        "internalCode": 7
      }
    }
  ]
}