{ "opencollection": "1.0.0", "info": { "name": "Amplify Platform API v1.0.0 aca org API", "version": "16.10.0" }, "items": [ { "info": { "name": "org", "type": "folder" }, "items": [ { "info": { "name": "Axway Find Organization Environments", "type": "http" }, "http": { "method": "GET", "url": "https://platform.axway.com/api/v1/org/env", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A list of fields to include in the response." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A list of fields to exclude from the response." }, { "name": "org_id", "value": "507f1f77bcf86cd799439011", "type": "query" }, { "name": "target", "value": "api_central", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Axway Sets the Primary Contract for the Org", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.axway.com/api/v1/org/:org_id/user/:user_guid/primary", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A list of fields to include in the response." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A list of fields to exclude from the response." }, { "name": "org_id", "value": "507f1f77bcf86cd799439011", "type": "path" }, { "name": "user_guid", "value": "example_value", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Axway Get Org User", "type": "http" }, "http": { "method": "GET", "url": "https://platform.axway.com/api/v1/org/:org_id/user/:user_guid", "headers": [ { "name": "x-auth-token", "value": "eyJhbGciOiJIUzI1NiJ9.example" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "A list of fields to include in the response." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A list of fields to exclude from the response." }, { "name": "org_id", "value": "507f1f77bcf86cd799439011", "type": "path" }, { "name": "user_guid", "value": "example_value", "type": "path" }, { "name": "teams", "value": "true", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Axway Update Org Member Association", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.axway.com/api/v1/org/:org_id/user/:user_guid", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A list of fields to include in the response." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A list of fields to exclude from the response." }, { "name": "org_id", "value": "507f1f77bcf86cd799439011", "type": "path" }, { "name": "user_guid", "value": "example_value", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Axway Remove User", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.axway.com/api/v1/org/:org_id/user/:user_guid", "params": [ { "name": "org_id", "value": "507f1f77bcf86cd799439011", "type": "path" }, { "name": "user_guid", "value": "example_value", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Removes a user from the organization.\n\n___Auth Requirement___\n - `administrator` access to the organization.\n\n\n_Allows consumer organization access_\n" }, { "info": { "name": "Axway Get Members", "type": "http" }, "http": { "method": "GET", "url": "https://platform.axway.com/api/v1/org/:org_id/user", "headers": [ { "name": "x-auth-token", "value": "eyJhbGciOiJIUzI1NiJ9.example" } ], "params": [ { "name": "fields", "value": "example_value", "type": "query", "description": "A list of fields to include in the response." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A list of fields to exclude from the response." }, { "name": "add_fields", "value": "", "type": "query", "description": "A list of fields to add to the default field set in the response." }, { "name": "org_id", "value": "507f1f77bcf86cd799439011", "type": "path" }, { "name": "email", "value": "user@example.com", "type": "query" }, { "name": "primary", "value": "example_value", "type": "query" }, { "name": "roles", "value": "example_value", "type": "query" }, { "name": "term", "value": "example_value", "type": "query" }, { "name": "user_guid", "value": "example_value", "type": "query" }, { "name": "limit", "value": "1", "type": "query" }, { "name": "page", "value": "1", "type": "query" }, { "name": "skip", "value": "1", "type": "query" }, { "name": "sort", "value": "activated", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns members for an org\n\n___Auth Requirement___\n - _One of_\n - Access to the organization, allowing consumer role. Developer access may be restricted by the organization users access control setting.\n - Auth token.\n\n\n_Allows consumer organization access_\n" }, { "info": { "name": "Axway Add User", "type": "http" }, "http": { "method": "POST", "url": "https://platform.axway.com/api/v1/org/:org_id/user", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A list of fields to include in the response." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A list of fields to exclude from the response." }, { "name": "org_id", "value": "507f1f77bcf86cd799439011", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Adds a user to an organization.\n\n___Auth Requirement___\n - `administrator` access to the organization.\n\n\n_Allows consumer organization access_\n" }, { "info": { "name": "Axway Get Organization Stats", "type": "http" }, "http": { "method": "GET", "url": "https://platform.axway.com/api/v1/org/:org_id/stats", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A list of fields to include in the response." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A list of fields to exclude from the response." }, { "name": "org_id", "value": "507f1f77bcf86cd799439011", "type": "path" }, { "name": "env", "value": "example_value", "type": "query" }, { "name": "from", "value": "1", "type": "query" }, { "name": "product", "value": "APIM", "type": "query" }, { "name": "to", "value": "1", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns stats for organization and product\n\n___Auth Requirement___\n - _One of_\n - Access to the organization.\n - Support access.\n" }, { "info": { "name": "Axway Get Organization", "type": "http" }, "http": { "method": "GET", "url": "https://platform.axway.com/api/v1/org/:org_id", "headers": [ { "name": "authorization", "value": "example_value" }, { "name": "x-auth-token", "value": "eyJhbGciOiJIUzI1NiJ9.example" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "A list of fields to include in the response." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A list of fields to exclude from the response." }, { "name": "add_fields", "value": "", "type": "query", "description": "A list of fields to add to the default field set in the response." }, { "name": "org_id", "value": "507f1f77bcf86cd799439011", "type": "path" }, { "name": "onboarding", "value": "true", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a single organization\n\n___Auth Requirement___\n - _One of_\n - Access to the organization, allowing consumer role.\n - Service account access token for an internal client with `platform-org-view` access.\n - Auth token.\n\n\n_Allows consumer organization access_\n" }, { "info": { "name": "Axway Update Organization", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.axway.com/api/v1/org/:org_id", "headers": [ { "name": "authorization", "value": "example_value" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "A list of fields to include in the response." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A list of fields to exclude from the response." }, { "name": "org_id", "value": "507f1f77bcf86cd799439011", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "account_id", "type": "text", "value": "" }, { "name": "active", "type": "text", "value": "" }, { "name": "help_menu", "type": "text", "value": "" }, { "name": "logo", "type": "text", "value": "" }, { "name": "name", "type": "text", "value": "" }, { "name": "region", "type": "text", "value": "" }, { "name": "security", "type": "text", "value": "" }, { "name": "support_access_code", "type": "text", "value": "" } ] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates an organization.\n\n___Auth Requirement___\n - _One of_\n - `administrator` access to the organization.\n - Service account access token for an internal client with `platform-org-manage` access.\n\n\n_Allows consumer organization access_\n" }, { "info": { "name": "Axway Delete Organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.axway.com/api/v1/org/:org_id", "headers": [ { "name": "x-auth-token", "value": "eyJhbGciOiJIUzI1NiJ9.example" }, { "name": "x-auth-code", "value": "example_value" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "A list of fields to include in the response." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A list of fields to exclude from the response." }, { "name": "org_id", "value": "507f1f77bcf86cd799439011", "type": "path" }, { "name": "suppressEmail", "value": "true", "type": "query" } ], "auth": { "type": "apikey", "key": "connect.sid", "value": "{{connect.sid}}", "placement": "query" } }, "docs": "Deletes an organization and its related data from the platform and all third parties. This is a destructive and irreversible delete.\n\n___Auth Requirement___\n - _One of_\n - Staff access.\n - Auth token.\n - _All of_\n - Multi-factor authentication code (remove-org).\n - `primary` access to the organization.\n\n\n_Allows consumer organization access_\n" } ] } ], "bundled": true }