OpenAPI Specification
openapi: 3.1.0
info:
version: 16.10.0
title: Amplify Platform API v1.0.0 aca org 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>.
© 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: org
paths:
/org/env:
parameters: []
get:
summary: Axway Find Organization Environments
description: "Returns the environments configured for the signed-in user's organization.\n\n___Auth Requirement___\n - `administrator`, `auditor`, `developer`, or `usage_reporter` access to the organization. Developer access may be restricted by the organization environments access control setting.\n"
tags:
- org
operationId: org_findEnvs
responses:
'200':
description: Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
result:
$ref: '#/components/schemas/EnvironmentList'
examples:
OrgFindenvs200Example:
summary: Default org_findEnvs 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'
IDP_REQUIRED:
value:
$ref: '#/components/examples/IDP_REQUIRED/value'
USER_NOT_ADMIN:
value:
$ref: '#/components/examples/USER_NOT_ADMIN/value'
LOGIN_REQUIRED:
value:
$ref: '#/components/examples/LOGIN_REQUIRED/value'
PARAM_INVALID:
value:
$ref: '#/components/examples/PARAM_INVALID/value'
security:
- BearerClient: []
- SessionCookie: []
- BearerUser: []
parameters:
- $ref: '#/components/parameters/fields'
example: example_value
- $ref: '#/components/parameters/exclude_fields'
example: example_value
- in: query
name: org_id
required: false
schema:
type: string
description: The `guid` or `org_id` of the organization.
example: 507f1f77bcf86cd799439011
- in: query
name: target
required: false
schema:
type: string
description: The target in the UI that the data is being requested for. Filters the results to only environments that include the target.
enum:
- api_central
example: api_central
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/org/{org_id}/user/{user_guid}/primary:
parameters: []
put:
summary: Axway Sets the Primary Contract for the Org
description: "Set which user is listed as the primary contact for the organization.\n\n___Auth Requirement___\n - `administrator` access to the organization.\n\n\n_Allows consumer organization access_\n"
externalDocs:
description: Managing Users
url: https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/managing_organizations/managing_users/index.html
tags:
- org
operationId: org_userPrimary
x-publishes:
- platform.org.user.primary
responses:
'200':
description: Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
result:
type: object
required:
- active
- guid
- name
- org_id
- region
- subscriptions
- users
unevaluatedProperties: false
allOf:
- $ref: '#/components/schemas/DefaultFields'
properties:
account_id:
type: integer
description: Account ID of the organization.
minimum: 10000
maximum: 999999
active:
type: boolean
description: Active state of the organization. Organizations become inactive after passing their end date.
default: true
analytics:
type: object
description: Analytics details for the organization
additionalProperties: false
properties:
token:
type: string
description: Token used to identify the organization.
branding:
type: object
description: Organization branding.
additionalProperties: false
properties:
logo:
type: string
description: Logo image of the company.
consumer_id:
type: string
description: Mapped ID of the consumer org from the configured Identity Provider.
guid:
type: string
format: uuid
description: GUID identifier for the organization
name:
type: string
description: Name of the organization.
minLength: 2
maxLength: 64
x-no-tags: true
onboarding_required:
type: array
readOnly: true
items:
type: string
pattern: '[\w-]{21}'
org_id:
type: integer
description: Identifier for the organization
origin:
type:
- string
- 'null'
description: Source from which the organization creation originated.
enum:
- '360'
- sfdc
- signup
pending:
type: boolean
description: Whether the organization is pending approval for a provider organization administator.
provider_guid:
type: string
format: uuid
description: GUID identifier of the owning provider if the organization is a consumer of a marketplace.
region:
type: string
description: The data residency region of the organization.
default: US
enum:
- US
- EU
- AP
security:
type: object
description: Security settings for the organization.
additionalProperties: false
properties:
access_controls:
type: object
description: Developer visibility controls.
additionalProperties: false
properties:
enviroments:
type: number
description: Developer access to environments. 0 - Developers cannot view environments, 1 - Developer may view all environemnts.
enum:
- 0
- 1
service_accounts:
type: number
description: Developer access to service accounts. 0 - Developers cannot view service accounts, 1 - Developers may view service accounts in their teams, 2 - Developer may view all service accounts.
enum:
- 0
- 1
- 2
usage:
type: number
description: Developer access to usage. 0 - Developers cannot view usage, 1 - Developer may view all usage.
enum:
- 0
- 1
users:
type: number
description: Developer access to users.0 - Developers cannot view users, 1 - Developers may view administrators and users in their teams, 2 - Developer may view all users.
enum:
- 0
- 1
- 2
allow_tooling:
type: boolean
description: Grant access using tooling credentials
disable_analytics:
type: boolean
description: Opt out from third-party support services.
password_policy:
$ref: '#/components/schemas/PasswordPolicy'
redact_personal:
type: boolean
description: Personal information like email addresses will be masked in UI.
default: false
subscriptions:
type: array
default: []
items:
$ref: '#/components/schemas/Subscription'
support_access_code:
type: integer
description: Support Access Code for the org.
minimum: 10000
maximum: 999999
users:
type: array
description: List of users that are members of the organization.
default: []
items:
type: object
required:
- guid
- roles
additionalProperties: false
properties:
guid:
type: string
format: uuid
description: GUID of the user.
idp:
type: string
description: GUID of the Identity Provider the user is required to authenticate with to access the organization.
primary:
type: boolean
description: Whether the user is the primary contact for the organization.
roles:
type: array
description: Roles within the organization.
items:
type: string
enum:
- administrator
- developer
- auditor
- consumer
- usage_reporter
- api_central_admin
api_central:
type: object
description: Engage provision status
readOnly: true
entitlements:
type: object
readOnly: true
allOf:
- $ref: '#/components/schemas/Entitlements'
examples:
OrgUserprimary200Example:
summary: Default org_userPrimary 200 response
x-microcks-default: true
value: example_value
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
PRIMARY_NOT_ADMIN:
value:
success: false
description: The primary contact must be an administrator of the organization.
code: 400
FORBIDDEN:
value:
$ref: '#/components/examples/FORBIDDEN/value'
NOT_FOUND:
value:
$ref: '#/components/examples/NOT_FOUND/value'
IDP_REQUIRED:
value:
$ref: '#/components/examples/IDP_REQUIRED/value'
USER_NOT_ADMIN:
value:
$ref: '#/components/examples/USER_NOT_ADMIN/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:
USER_NOT_MEMBER:
value:
success: false
description: User is not a member of this organization.
code: 403
security:
- BearerClient: []
- SessionCookie: []
- BearerUser: []
parameters:
- $ref: '#/components/parameters/fields'
example: example_value
- $ref: '#/components/parameters/exclude_fields'
example: example_value
- in: path
name: org_id
required: true
schema:
type: string
description: '`guid` or `org_id` of the org.'
example: 507f1f77bcf86cd799439011
- in: path
name: user_guid
required: true
schema:
type: string
description: guid of the user to set as the primary contact.
example: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/org/{org_id}/user/{user_guid}:
parameters: []
get:
summary: Axway Get Org User
description: "Returns single user for an org\n\n___Auth Requirement___\n - _One of_\n - Access to the organization, allowing consumer role.\n - Auth token.\n\n\n_Allows consumer organization access_\n"
externalDocs:
description: Managing Users
url: https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/managing_organizations/managing_users/index.html
tags:
- org
operationId: org_userFindOne
responses:
'200':
description: Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
result:
type: object
required:
- activated
- active
- email
- firstname
- guid
- lastname
- user_id
unevaluatedProperties: false
properties:
created:
$ref: '#/components/schemas/DefaultFields/properties/created'
activated:
type: boolean
description: Whether the user has activated.
default: false
active:
type: boolean
description: Whether the user is active.
default: false
date_activated:
type: string
format: date-time
description: When the user activated.
email:
type: string
format: email
description: Email address of the user.
maxLength: 217
external:
type: boolean
description: Whether the user is external.
firstname:
type: string
description: First name of the user.
default: ''
maxLength: 50
x-allow-empty: true
x-no-tags: true
guid:
type: string
description: GUID of the user.
lastname:
type: string
description: Last name of the user.
default: ''
maxLength: 50
x-allow-empty: true
x-no-tags: true
last_login:
type: string
format: date-time
description: When the user last signed in.
mfa:
type: boolean
description: Whether multi-factor authentication is enabled for the user.
user_id:
type: number
org_id:
type: integer
description: Identifier for the organization
role:
type: string
description: The users default role in the organization
name:
type: string
description: A display name for the user taken from email or firstname and lastname if available
primary:
type: boolean
description: Whether the user is the primary user for the organization
teams:
oneOf:
- type: integer
description: Count of teams the user belongs to in the organization.
- $ref: '#/components/schemas/UserTeams'
examples:
OrgUserfindone200Example:
summary: Default org_userFindOne 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'
IDP_REQUIRED:
value:
$ref: '#/components/examples/IDP_REQUIRED/value'
USER_NOT_ADMIN:
value:
$ref: '#/components/examples/USER_NOT_ADMIN/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:
- BearerClient: []
- SessionCookie: []
- BearerUser: []
- AuthToken: []
parameters:
- $ref: '#/components/parameters/fields'
example: example_value
- $ref: '#/components/parameters/exclude_fields'
example: example_value
- in: path
name: org_id
required: true
schema:
type: string
description: '`guid` or `org_id` of the org whose member you want to get'
example: 507f1f77bcf86cd799439011
- in: path
name: user_guid
required: true
schema:
type: string
description: guid of the user whose org and team info you want to get
example: example_value
- in: query
name: teams
required: false
deprecated: true
schema:
type: boolean
description: Include name, guid, default, and roles for teams user is members of; by default, `teams` includes count of teams user is member of
x-deprecated: This parameter has been deprecated and will be removed in a future release.
x-deprecated: This parameter has been deprecated and will be removed in a future release.
example: true
- in: header
name: x-auth-token
required: false
schema:
type: string
description: Token to authorize the request.
example: eyJhbGciOiJIUzI1NiJ9.example
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
summary: Axway Remove User
description: "Removes a user from the organization.\n\n___Auth Requirement___\n - `administrator` access to the organization.\n\n\n_Allows consumer organization access_\n"
externalDocs:
description: Managing Users
url: https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/managing_organizations/managing_users/index.html
tags:
- org
operationId: org_userRemove
x-publishes:
- com.appcelerator.platform.org.user.remove
- event: platform.user.remove
text: Sent if the user is no longer a member of any organizations.
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
USER_SOLE_ADMIN:
value:
success: false
description: The sole administrator of an organization cannot be removed.
code: 400
USER_IS_PRIMARY:
value:
success: false
description: The primary contact of an organization cannot be removed.
code: 400
FORBIDDEN:
value:
$ref: '#/components/examples/FORBIDDEN/value'
NOT_FOUND:
value:
$ref: '#/components/examples/NOT_FOUND/value'
IDP_REQUIRED:
value:
$ref: '#/components/examples/IDP_REQUIRED/value'
USER_NOT_ADMIN:
value:
$ref: '#/components/examples/USER_NOT_ADMIN/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:
- BearerClient: []
- SessionCookie: []
- BearerUser: []
parameters:
- in: path
name: org_id
required: true
schema:
type: string
description: '`guid` or `org_id` of the organization to remove the user from'
example: 507f1f77bcf86cd799439011
- in: path
name: user_guid
required: true
schema:
type: string
description: guid of the user who you want to remove
example: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
summary: Axway Update Org Member Association
description: "Updates a user's association to an org.\n\n___Auth Requirement___\n - `administrator` access to the organization.\n\n\n_Allows consumer organization access_\n"
externalDocs:
description: Managing Users
url: https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/managing_organizations/managing_users/index.html
tags:
- org
operationId: org_userUpdate
x-publishes:
- platform.org.user.role.update
- platform.org.user.idp.update
responses:
'200':
$ref: '#/components/responses/SuccessResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
NO_ADMIN_LEFT:
value:
success: false
description: Unable to demote user; one org admin is required.
code: 400
CONFLICTING_TEAM_ROLE:
value:
success: false
description: '"roles" contained an invalid value: The "%s" role assigned in the team "%s" requires one of the following organization roles: %s.'
code: 400
internalCode: 747
FORBIDDEN:
value:
$ref: '#/components/examples/FORBIDDEN/value'
NOT_FOUND:
value:
$ref: '#/components/examples/NOT_FOUND/value'
IDP_REQUIRED:
value:
$ref: '#/components/examples/IDP_REQUIRED/value'
USER_NOT_ADMIN:
value:
$ref: '#/components/examples/USER_NOT_ADMIN/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:
- BearerClient: []
- SessionCookie: []
- BearerUser: []
parameters:
- $ref: '#/components/parameters/fields'
example: example_value
- $ref: '#/components/parameters/exclude_fields'
example: example_value
- in: path
name: org_id
required: true
schema:
type: string
description: '`guid` or `org_id` of the org.'
example: 507f1f77bcf86cd799439011
- in: path
name: user_guid
required: true
schema:
type: string
description: guid of the user to update the association of.
example: example_value
requestBody:
content:
'*/*':
schema:
properties:
idp:
$ref: '#/components/schemas/Org/properties/users/items/properties/idp'
roles:
$ref: '#/components/schemas/Org/properties/users/items/properties/roles'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/org/{org_id}/user:
parameters: []
post:
summary: Axway Add User
description: "Adds a user to an organization.\n\n___Auth Requirement___\n - `administrator` access to the organization.\n\n\n_Allows consumer organization access_\n"
externalDocs:
description: Managing Users
url: https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/managing_organizations/managing_users/index.html
tags:
- org
operationId: org_userCreate
x-publishes:
- com.appcelerator.platform.org.user.create
- event: platform.activation.send
text: Sent if the user being added is not an activated user.
responses:
'200':
description: Response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
result:
properties:
guid:
type: string
description: The guid of the added user.
examples:
OrgUsercreate200Example:
summary: Default org_userCreate 200 response
x-microcks-default: true
value: example_value
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
EXISTING_ORG_MEMBER:
value:
success: false
description: User is already a member of this org.
code: 400
INVALID_EMAIL_DOMAIN:
value:
success: false
description: Sign-up is not allowed for this email domain.
code: 400
internalCode: 14
INVALID_STAFF_INVITE:
value:
success: false
description: User must be activated and have an email on an allowed domain (axway.com, 74software.com) to be added to the staff organization.
code: 400
ITEM_NOT_FOUND:
value:
$ref: '#/components/examples/ITEM_NOT_FOUND/value'
USER_INVITE_DISABLED:
value:
success: false
description: This organization has reached the maximum number of invited users. New user invitation is temporarily disabled. Please try again la
# --- truncated at 32 KB (138 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/axway/refs/heads/main/openapi/axway-org-api-openapi.yml