Axway auth API

openapi: 3.1.0
info:
  version: 16.10.0
  title: Amplify Platform API v1.0.0 aca auth API
  description: 'The Amplify Platform API provides the interface to perform the following:

    - Manage account settings and credentials

    - Manage organization settings, users, service accounts, and teams

    - Retrieve organization usage data

    - Register and manage applications

    - Retrieve application metrics and analytics

    - Retrieve user, organization, and application activity


    See the <a href="https://docs.axway.com/bundle/amplify-central/page/docs/integrate_with_central/platform-auth-examples/index.html" target="_blank">Amplify Guide</a> for documentation and examples on how to authorize API calls to platform services.


    For general documentation refer to the <a href="https://docs.axway.com/category/platform" target="_blank">Amplify Platform documentation</a>.


    &copy; Axway 2026. All rights reserved.'
  contact:
    email: support@axway.com
  termsOfService: https://www.axway.com/en/axway-platform-terms-of-use
servers:
- url: https://platform.axway.com/api/v1
tags:
- name: auth
paths:
  /auth/validatePassword:
    parameters: []
    post:
      summary: Axway Validates a User Password
      description: "Validates the supplied password is valid for the signed-in user.\n\n___Auth Requirement___\n - User password.\n\n\n_Allows consumer organization access_\n"
      tags:
      - auth
      operationId: auth_validatePassword
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                FORBIDDEN:
                  value:
                    $ref: '#/components/examples/FORBIDDEN/value'
                LOGIN_REQUIRED:
                  value:
                    $ref: '#/components/examples/LOGIN_REQUIRED/value'
                PARAM_INVALID:
                  value:
                    $ref: '#/components/examples/PARAM_INVALID/value'
                PARAM_REQUIRED:
                  value:
                    $ref: '#/components/examples/PARAM_REQUIRED/value'
      security:
      - Password: []
      - SessionCookie: []
      - BearerUser: []
      parameters:
      - in: header
        name: x-auth-password
        required: true
        schema:
          type: string
          description: Password to authorize the request.
        example: '********'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/terms:
    parameters: []
    put:
      summary: Axway Accept Terms & Conditions
      description: "Marks acceptance of Terms & Conditions.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n"
      tags:
      - auth
      operationId: auth_acceptTerms
      x-publishes:
      - platform.terms.accept
      responses:
        '200':
          $ref: '#/components/responses/SuccessResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                LOGIN_REQUIRED:
                  value:
                    $ref: '#/components/examples/LOGIN_REQUIRED/value'
                PARAM_INVALID:
                  value:
                    $ref: '#/components/examples/PARAM_INVALID/value'
      security:
      - SessionCookie: []
      - BearerUser: []
      parameters:
      - $ref: '#/components/parameters/fields'
        example: example_value
      - $ref: '#/components/parameters/exclude_fields'
        example: example_value
      - in: query
        name: grant
        required: false
        schema:
          type: string
          description: Optional grant value for use with Platform IdP
        example: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/switchLoggedInOrg:
    parameters: []
    post:
      summary: Axway Switch Signed-in Organization
      description: "Changes the current session's organization to another that the signed-in user can access.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n"
      tags:
      - auth
      operationId: auth_sessionSwitchOrg
      x-publishes:
      - platform.session.create
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/SessionInfo'
              examples:
                AuthSessionswitchorg200Example:
                  summary: Default auth_sessionSwitchOrg 200 response
                  x-microcks-default: true
                  value: example_value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                NOT_FOUND:
                  value:
                    $ref: '#/components/examples/NOT_FOUND/value'
                INVALID_SWITCH_ORG:
                  value:
                    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
                USER_NOT_ACTIVATED:
                  value:
                    success: false
                    description: Your account has not been activated yet. Please check your email.
                    code: 400
                    internalCode: 3
                IDP_REQUIRED:
                  value:
                    $ref: '#/components/examples/IDP_REQUIRED/value'
                LOGIN_REQUIRED:
                  value:
                    $ref: '#/components/examples/LOGIN_REQUIRED/value'
                PARAM_INVALID:
                  value:
                    $ref: '#/components/examples/PARAM_INVALID/value'
                PARAM_REQUIRED:
                  value:
                    $ref: '#/components/examples/PARAM_REQUIRED/value'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                NO_ACTIVE_ORGS:
                  value:
                    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
      security:
      - SessionCookie: []
      - BearerUser: []
      parameters:
      - $ref: '#/components/parameters/fields'
        example: example_value
      - $ref: '#/components/parameters/exclude_fields'
        example: example_value
      requestBody:
        content:
          '*/*':
            schema:
              properties:
                org_id:
                  type: string
                  description: '`guid` or `org_id` of the organization to switch the user to.'
              required:
              - org_id
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/signup:
    parameters: []
    post:
      summary: Axway Sign Up
      description: 'Sign up org and user.


        _Allows consumer organization access_

        '
      tags:
      - auth
      operationId: auth_signup
      x-publishes:
      - platform.org.create
      - platform.activation.send
      - platform.subscription.create
      - marketplace.consumer.signup
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                FORBIDDEN:
                  value:
                    $ref: '#/components/examples/FORBIDDEN/value'
                INVALID_EMAIL_DOMAIN:
                  value:
                    success: false
                    description: Sign-up is not allowed for this email domain.
                    code: 400
                    internalCode: 14
                NEW_USER_SIGNUP:
                  value:
                    success: false
                    description: You must be a new user to sign up.
                    code: 400
                NEW_USER_SIGNUP_INACTIVE:
                  value:
                    success: false
                    description: You must be a new user to sign up.
                    code: 400
                PASSWORD_USER_INFO:
                  value:
                    success: false
                    description: Passwords should not contain your name, email address, or other personally identifiable information.
                    code: 400
                    internalCode: 411
                SIGNUP_DISABLED:
                  value:
                    success: false
                    description: User signup attempts are temporarily disabled.
                    code: 400
                    internalCode: 430
                PROVIDER_SIGNUP_DISABLED:
                  value:
                    success: false
                    description: User signups are disabled.
                    code: 400
                    internalCode: 430
                PARAM_INVALID:
                  value:
                    $ref: '#/components/examples/PARAM_INVALID/value'
                PARAM_REQUIRED:
                  value:
                    $ref: '#/components/examples/PARAM_REQUIRED/value'
      requestBody:
        content:
          '*/*':
            schema:
              properties:
                admin:
                  type: string
                  description: Email address of the person who will be the org administrator. It cannot be an email address already registered in the platform.
                firstname:
                  type: string
                  description: First name of org administrator.
                from:
                  type: string
                  description: Optional flag saying where the request is coming from.
                lastname:
                  type: string
                  description: Last name of org administrator.
                onboarding:
                  $ref: '#/components/schemas/Org/properties/onboarding'
                org_name:
                  type: string
                  description: Name of the organization.
                password:
                  type: string
                  description: Password.
                provider_guid:
                  type: string
                  description: Optional GUID of a provider marketplace to which the org and user are a consumer.
                redirect:
                  type: string
                  description: URL to which admin user should be redirected after activation.
                region:
                  type: string
                  description: Data residency region.
                  enum:
                  - US
                  - EU
                  - AP
                  default: US
              required:
              - admin
              - firstname
              - lastname
              - org_name
              - password
              - provider_guid
              - region
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/password_policy:
    parameters: []
    get:
      summary: Axway Get Effective Password Policy
      description: 'Returns the combined most restrictive values for password policies along all organizations a user or provider belongs to and system wide password policy.


        _Allows consumer organization access_

        '
      tags:
      - auth
      operationId: auth_findPasswordPolicy
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/PasswordPolicy'
              examples:
                AuthFindpasswordpolicy200Example:
                  summary: Default auth_findPasswordPolicy 200 response
                  x-microcks-default: true
                  value: example_value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                PARAM_INVALID:
                  value:
                    $ref: '#/components/examples/PARAM_INVALID/value'
      parameters:
      - $ref: '#/components/parameters/fields'
        example: example_value
      - $ref: '#/components/parameters/exclude_fields'
        example: example_value
      - in: query
        name: provider_guid
        required: false
        schema:
          type: string
          description: Optional GUID of an owning provider if for marketplace consumer context
        example: example_value
      - in: query
        name: user_guid
        required: false
        schema:
          type: string
          description: Optional user guid to look up password policy for.
        example: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/onboarding:
    parameters: []
    put:
      summary: Axway Onboarding Capture
      description: "Capture required onboarding data prior to sessionc creation.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n"
      tags:
      - auth
      operationId: auth_onboarding
      x-publishes:
      - platform.org.update
      responses:
        '200':
          $ref: '#/components/responses/SuccessResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                LOGIN_REQUIRED:
                  value:
                    $ref: '#/components/examples/LOGIN_REQUIRED/value'
                PARAM_INVALID:
                  value:
                    $ref: '#/components/examples/PARAM_INVALID/value'
                PARAM_REQUIRED:
                  value:
                    $ref: '#/components/examples/PARAM_REQUIRED/value'
      security:
      - SessionCookie: []
      - BearerUser: []
      parameters:
      - $ref: '#/components/parameters/fields'
        example: example_value
      - $ref: '#/components/parameters/exclude_fields'
        example: example_value
      - in: query
        name: grant
        required: false
        schema:
          type: string
          description: Optional grant value for use with Platform IdP
        example: example_value
      requestBody:
        content:
          '*/*':
            schema:
              properties:
                onboarding:
                  type: object
              required:
              - onboarding
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/mfa/verify:
    parameters: []
    post:
      summary: Axway Verify an Authorization Code
      description: "Verify an authorization code. The code is expired once verified.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n"
      externalDocs:
        description: Managing Multi-factor Authentication
        url: https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/managing_credentials/index.html#manage-multi-factor-authentication
      tags:
      - auth
      operationId: auth_mfaVerify
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    result:
                      properties:
                        valid:
                          type: boolean
                        expired:
                          type: boolean
              examples:
                AuthMfaverify200Example:
                  summary: Default auth_mfaVerify 200 response
                  x-microcks-default: true
                  value: example_value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                LOGIN_REQUIRED:
                  value:
                    $ref: '#/components/examples/LOGIN_REQUIRED/value'
                PARAM_INVALID:
                  value:
                    $ref: '#/components/examples/PARAM_INVALID/value'
                PARAM_REQUIRED:
                  value:
                    $ref: '#/components/examples/PARAM_REQUIRED/value'
      security:
      - SessionCookie: []
      - BearerUser: []
      parameters:
      - $ref: '#/components/parameters/fields'
        example: example_value
      - $ref: '#/components/parameters/exclude_fields'
        example: example_value
      requestBody:
        content:
          '*/*':
            schema:
              properties:
                authcode:
                  type: string
                  description: Authorization code to verify.
                authcode_id:
                  type: string
                  description: guid of the authorization code to verify.
                purpose:
                  type: string
                  description: Purpose of the authorization code to verify.
                user_id:
                  type: string
                  description: '`guid` of the user to send an authorization code for. Staff only.'
              required:
              - authcode
              - user_id
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/mfa/send:
    parameters: []
    post:
      summary: Axway Send an Authorization Code
      description: "Send a code for the user to verify using their configured mfa method.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n"
      externalDocs:
        description: Managing Multi-factor Authentication
        url: https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/managing_credentials/index.html#manage-multi-factor-authentication
      tags:
      - auth
      operationId: auth_mfaSend
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    result:
                      properties:
                        guid:
                          type: string
                          description: Identifier for the auth code.
              examples:
                AuthMfasend200Example:
                  summary: Default auth_mfaSend 200 response
                  x-microcks-default: true
                  value: example_value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                LOGIN_REQUIRED:
                  value:
                    $ref: '#/components/examples/LOGIN_REQUIRED/value'
                PARAM_INVALID:
                  value:
                    $ref: '#/components/examples/PARAM_INVALID/value'
      security:
      - SessionCookie: []
      - BearerUser: []
      parameters:
      - $ref: '#/components/parameters/fields'
        example: example_value
      - $ref: '#/components/parameters/exclude_fields'
        example: example_value
      requestBody:
        content:
          '*/*':
            schema:
              properties:
                purpose:
                  type: string
                  description: Purpose for the auth code being sent. Any existing auth code for the same purpose will be replaced.
                template:
                  type: string
                  description: Name of the template for the message sent to the user.
                user_id:
                  type: string
                  description: '`guid` of the user to send an authorization code for. Staff only.'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/logout:
    parameters: []
    get:
      summary: Axway Sign-out
      description: 'Destroys the current session and signs the user out.


        _Allows consumer organization access_

        '
      tags:
      - auth
      operationId: auth_logout
      x-publishes:
      - platform.logout
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    result:
                      type: string
                      description: Signed-in state
              examples:
                AuthLogout200Example:
                  summary: Default auth_logout 200 response
                  x-microcks-default: true
                  value: example_value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                LOGIN_REQUIRED:
                  value:
                    $ref: '#/components/examples/LOGIN_REQUIRED/value'
                PARAM_INVALID:
                  value:
                    $ref: '#/components/examples/PARAM_INVALID/value'
      parameters:
      - $ref: '#/components/parameters/fields'
        example: example_value
      - $ref: '#/components/parameters/exclude_fields'
        example: example_value
      - in: query
        name: msg
        required: false
        schema:
          type: string
          description: Sign-in message
        example: example_value
      - in: query
        name: redirect
        required: false
        schema:
          type: string
          description: Redirect URL for browsers
        example: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/login:
    parameters: []
    post:
      summary: Axway Sign-in
      description: Attempts to sign a user in, creating a session for the user.
      externalDocs:
        description: Sign In Documentation
        url: https://docs.axway.com/bundle/platform-management/page/docs/getting_started_with_amplify_platform_management/sign_in/index.html
      tags:
      - auth
      operationId: auth_login
      x-publishes:
      - platform.login
      - platform.session.create
      - event: platform.login.failed
        text: If the sign in is unsuccessful.
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/SessionInfo'
              examples:
                AuthLogin200Example:
                  summary: Default auth_login 200 response
                  x-microcks-default: true
                  value: example_value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                FORBIDDEN:
                  value:
                    $ref: '#/components/examples/FORBIDDEN/value'
                INVALID_LOGIN:
                  value:
                    success: false
                    description: Invalid username or password.
                    code: 400
                    internalCode: 2
                INVALID_LOGIN_HOSTNAME:
                  value:
                    success: false
                    description: Sign-in not supported on this hostname.
                    code: 400
                INVALID_LOGIN_USERNAME:
                  value:
                    success: false
                    description: Username must be a valid email address.
                    code: 400
                    internalCode: 2
                LOGIN_EXTERNAL_CLI:
                  value:
                    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
                LOGIN_EXTERNAL_USER:
                  value:
                    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
                MISSING_PASSWORD:
                  value:
                    success: false
                    description: User must reset password.
                    code: 400
                    internalCode: 13
                USER_NOT_ACTIVATED:
                  value:
                    success: false
                    description: Your account has not been activated yet. Please check your email.
                    code: 400
                    internalCode: 3
                INVALID_SWITCH_ORG:
                  value:
                    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
                IDP_REQUIRED:
                  value:
                    $ref: '#/components/examples/IDP_REQUIRED/value'
                PROVIDER_CONSUMER_DISABLED:
                  value:
                    success: false
                    description: Consumer organization access is disabled.
                    code: 400
                    internalCode: 431
                PARAM_INVALID:
                  value:
                    $ref: '#/components/examples/PARAM_INVALID/value'
                PARAM_REQUIRED:
                  value:
                    $ref: '#/components/examples/PARAM_REQUIRED/value'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                USER_NOT_ACTIVE:
                  value:
                    success: false
                    description: Your account is not active. Please contact your administrator or the Amplify Platform support team.
                    code: 401
                    internalCode: 4
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                NO_ACTIVE_ORGS:
                  value:
                    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
                PENDING_ORG:
                  value:
                    success: false
                    description: Your organization requires approval. You will be notified by email when the organization is approved.
                    code: 403
                    internalCode: 7
      parameters:
      - $ref: '#/components/parameters/fields'
        example: example_value
      - $ref: '#/components/parameters/exclude_fields'
        example: example_value
      - in: query
        name: grant
        required: false
        schema:
          type: string
          description: Optional grant value for use with Platform IdP
        example: example_value
      requestBody:
        content:
          '*/*':
            schema:
              properties:
                from:
                  type: string
                  description: Flag indicating where the sign-in is coming from
                org_hint:
                  type: string
                  description: '`guid` or `org_id` of an organization to sign in to'
                password:
                  type: string
                  description: Password
                provider_guid:
                  type: string
                  description: guid of an owning provider if for marketplace consumer context
                username:
                  type: string
                  description: Username
              required:
              - password
              - username
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/impersonate:
    parameters: []
    delete:
      summary: Axway Unimpersonate User
      description: "Restores session of user impersonating another; accessible by staff or support only.\n\n___Auth Requirement___\n - Signed-in user.\n"
      tags:
      - auth
      operationId: auth_unimpersonate
      x-publishes:
      - platform.user.unimpersonate
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/SessionInfo'
              examples:
                AuthUnimpersonate200Example:
                  summary: Default auth_unimpersonate 200 response
                  x-microcks-default: true
                  value: example_value
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                FORBIDDEN:
                  value:
                    $ref: '#/components/examples/FORBIDDEN/value'
                NOT_FOUND:
                  value:
                    $ref: '#/components/examples/NOT_FOUND/value'
                INVALID_SWITCH_ORG:
                  value:
                    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
                USER_NOT_ACTIVATED:
                  value:
                    success: false
                    description: Your account has not been activated yet. Please check your email.
                    code: 400
                    internalCode: 3
                LOGIN_REQUIRED:
                  value:
                    $ref: '#/components/examples/LOGIN_REQUIRED/value'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                SOCKET_NOT_ALLOWED:
                  value:
                    success: false
                    description: This API cannot be accessed via sockets; please use HTTPS.
                    code: 403
                NO_ACTIVE_ORGS:
                  value:
                    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
      security:
      - SessionCookie: []
      - BearerUser: []
      parameters:
      - $ref: '#/components/parameters/fields'
        example: example_value
      - $ref: '#/components/parameters/exclude_fields'
        example: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth/forgot:
    parameters: []
    post:
      summary: Axway Send Forgot Password Link
      description: Send a fo

# --- truncated at 32 KB (126 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/axway/refs/heads/main/openapi/axway-auth-api-openapi.yml