apimgr

package module
v0.0.0-...-68c986e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 26, 2021 License: Apache-2.0 Imports: 23 Imported by: 1

README

Go API client for apimgr

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.3.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./apimgr"

Documentation for API Endpoints

All URIs are relative to http://localhost/api/portal/v1.3

Class Method HTTP request Description
APIDiscoveryApi DiscoveryApisGet Get /discovery/apis Lists all APIs/services virtualised in the API Server.
APIDiscoveryApi DiscoveryOauthresourcesGet Get /discovery/oauthresources Gets a list OAuth protected resources and their associated scopes.
APIDiscoveryApi DiscoveryScopesGet Get /discovery/scopes Retrieves every resource on the API Server that is protected by OAuth, and the scopes that cover those resources
APIDiscoveryApi DiscoverySdkIdPlatformGet Get /discovery/sdk/{id}/{platform} Generates an SDK package for the specified API based on the type of the client requested
APIDiscoveryApi DiscoverySwaggerApiIdIdGet Get /discovery/swagger/api/id/{id} Retrieves an extended Swagger feed for the specified API.
APIDiscoveryApi DiscoverySwaggerApiNameGet Get /discovery/swagger/api/{name} Retrieves an extended Swagger feed for the specified API.
APIDiscoveryApi DiscoverySwaggerApisGet Get /discovery/swagger/apis Convenience method for retrieving all Swagger feeds for all virtualised services.
APIDiscoveryApi DiscoverySwaggerApisIdImageGet Get /discovery/swagger/apis/{id}/image Retrieves the API image
APIDiscoveryApi DiscoverySwaggerApisIdServiceDefinitionGet Get /discovery/swagger/apis/{id}/service-definition Retrieves the service definition of the API.
APIManagerServicesApi AlertsGet Get /alerts Gets the alerts configured for the API Manager
APIManagerServicesApi AlertsPost Post /alerts Updates the API Manager alerts configuration
APIManagerServicesApi AppinfoGet Get /appinfo Gets API Manager feature information.
APIManagerServicesApi CertinfoPost Post /certinfo Extracts certificate information from the supplied data
APIManagerServicesApi ConfigGet Get /config Gets API Manager configuration
APIManagerServicesApi ConfigPut Put /config Updates the API Manager configuration
APIManagerServicesApi ConnectorsConnectorIdGet Get /connectors/{connectorId} Return a list of APIs for the specified connector
APIManagerServicesApi ConnectorsConnectorIdLoginPost Post /connectors/{connectorId}/login Login to an external service from which APIs will be imported
APIManagerServicesApi ConnectorsGet Get /connectors Return a list of API connectors
APIManagerServicesApi FiledataPost Post /filedata Returns the DataURI representation of the uploaded file
APIManagerServicesApi LicenseGet Get /license Checks that the API Manager has a valid license
APIManagerServicesApi ListenersGet Get /listeners Gets the API Manager listeners
APIManagerServicesApi OauthclientprofilesGet Get /oauthclientprofiles Get a list of OAuth profiles for use in backend API authorisation
APIManagerServicesApi PoliciesGet Get /policies Gets a list of the specified policies
APIManagerServicesApi RemotehostsGet Get /remotehosts Returns a list of remote hosts
APIManagerServicesApi RemotehostsIdDelete Delete /remotehosts/{id} Deletes a remote host.
APIManagerServicesApi RemotehostsIdPut Put /remotehosts/{id} Updates a remote host
APIManagerServicesApi RemotehostsPost Post /remotehosts Creates a new remote host
APIManagerServicesApi ServiceDiscoveryInstanceTypePost Post /service-discovery/{instance}/{type} Returns a list of services hosted on the specified Gateway instance
APIManagerServicesApi SysconfigGet Get /sysconfig Gets API Manager system configuration
APIManagerServicesApi SysconfigPut Put /sysconfig Update API Manager system configuration
APIManagerServicesApi TitleGet Get /title Gets the API Manager's title
APIManagerServicesApi TokenstoresGet Get /tokenstores Gets a list of Token Stores
APIManagerServicesApi TopologyPost Post /topology Retrieves the Topology from the specified Admin Node Manager
APIProxyRegistrationApi ProxiesExportIdGet Get /proxies/export/{id} Downloads an API export.
APIProxyRegistrationApi ProxiesExportPost Post /proxies/export Creates an API export.
APIProxyRegistrationApi ProxiesGet Get /proxies Queries a list of frontend API.
APIProxyRegistrationApi ProxiesGrantaccessPost Post /proxies/grantaccess Macro function to grant API access.
APIProxyRegistrationApi ProxiesIdDelete Delete /proxies/{id} Deletes an API proxy.
APIProxyRegistrationApi ProxiesIdDeprecatePost Post /proxies/{id}/deprecate Deprecates the API.
APIProxyRegistrationApi ProxiesIdGet Get /proxies/{id} Gets a frontend API by ID.
APIProxyRegistrationApi ProxiesIdImageGet Get /proxies/{id}/image Gets the image for the API.
APIProxyRegistrationApi ProxiesIdImagePost Post /proxies/{id}/image Set the image for the frontend API.
APIProxyRegistrationApi ProxiesIdOperationsGet Get /proxies/{id}/operations Gets a list of methods that are avilable to the API proxy.
APIProxyRegistrationApi ProxiesIdOperationsOperationIdDelete Delete /proxies/{id}/operations/{operationId} Deletes an API method by ID.
APIProxyRegistrationApi ProxiesIdOperationsOperationIdGet Get /proxies/{id}/operations/{operationId} Gets an API method by ID.
APIProxyRegistrationApi ProxiesIdOperationsOperationIdPut Put /proxies/{id}/operations/{operationId} Updates an API proxy operation.
APIProxyRegistrationApi ProxiesIdPublishPost Post /proxies/{id}/publish Publish the API.
APIProxyRegistrationApi ProxiesIdPut Put /proxies/{id} Updates an API proxy.
APIProxyRegistrationApi ProxiesIdUndeprecatePost Post /proxies/{id}/undeprecate Undeprecates the API.
APIProxyRegistrationApi ProxiesIdUnpublishPost Post /proxies/{id}/unpublish Unpublish the API.
APIProxyRegistrationApi ProxiesImportFromUrlPost Post /proxies/importFromUrl Imports a previously exported API.
APIProxyRegistrationApi ProxiesImportPost Post /proxies/import Imports a previously exported API.
APIProxyRegistrationApi ProxiesPost Post /proxies Creates a new API proxy from a backend API.
APIProxyRegistrationApi ProxiesPromotePost Post /proxies/promote Invokes the internal API promotion policy for the specified API.
APIProxyRegistrationApi ProxiesUpgradeIdPost Post /proxies/upgrade/{id} Upgrades an existing frontend API to a newer frontend API.
APIRepositoryApi ApirepoGet Get /apirepo Get the list of API
APIRepositoryApi ApirepoIdDelete Delete /apirepo/{id} Deletes an API.
APIRepositoryApi ApirepoIdDownloadGet Get /apirepo/{id}/download Downloads an API by ID.
APIRepositoryApi ApirepoIdGet Get /apirepo/{id} Get an API by ID
APIRepositoryApi ApirepoIdMethodsGet Get /apirepo/{id}/methods Queries the list of API methods
APIRepositoryApi ApirepoIdMethodsMethodIdDelete Delete /apirepo/{id}/methods/{methodId} Delete an API method
APIRepositoryApi ApirepoIdMethodsMethodIdGet Get /apirepo/{id}/methods/{methodId} Get API method by ID.
APIRepositoryApi ApirepoIdMethodsMethodIdPut Put /apirepo/{id}/methods/{methodId} Update an API method
APIRepositoryApi ApirepoIdMethodsPost Post /apirepo/{id}/methods Create an API method
APIRepositoryApi ApirepoIdPut Put /apirepo/{id} Updates an API
APIRepositoryApi ApirepoImportFromExternalPost Post /apirepo/importFromExternal Create one or more backend APIs for an external service
APIRepositoryApi ApirepoImportFromGwPost Post /apirepo/importFromGw Create an API definition by importing a PolicyStudio-registered web service (REST or WSDL) hosted on the the API Gateway
APIRepositoryApi ApirepoImportFromUrlPost Post /apirepo/importFromUrl Create an API by loading a file from URL.
APIRepositoryApi ApirepoImportPost Post /apirepo/import Create an API by uploading a file
APIRepositoryApi ApirepoPost Post /apirepo Create an API definition
ApplicationsApi ApplicationsGet Get /applications Get the list of applications
ApplicationsApi ApplicationsIdApikeysApikeyidPut Put /applications/{id}/apikeys/{apikeyid} Updates an API Key
ApplicationsApi ApplicationsIdApikeysGet Get /applications/{id}/apikeys Returns the API Keys associated with an application
ApplicationsApi ApplicationsIdApikeysKeyIdDelete Delete /applications/{id}/apikeys/{keyId} Delete an API Key
ApplicationsApi ApplicationsIdApikeysPost Post /applications/{id}/apikeys Creates a new API Key and secret for the application
ApplicationsApi ApplicationsIdApisApiAccessIdApprovePost Post /applications/{id}/apis/{apiAccessId}/approve Creates an API access request to an API for an application.
ApplicationsApi ApplicationsIdApisApiAccessIdDelete Delete /applications/{id}/apis/{apiAccessId} Deletes access to an API for an application
ApplicationsApi ApplicationsIdApisApiAccessIdPut Put /applications/{id}/apis/{apiAccessId} Updates access to an API for an application
ApplicationsApi ApplicationsIdApisGet Get /applications/{id}/apis Get the list of APIs that the application can access
ApplicationsApi ApplicationsIdApisPost Post /applications/{id}/apis Create a request for an application to access an API.
ApplicationsApi ApplicationsIdApprovePost Post /applications/{id}/approve Approves a pending application request
ApplicationsApi ApplicationsIdAvailablescopesGet Get /applications/{id}/availablescopes Returns the scopes available to an application
ApplicationsApi ApplicationsIdDelete Delete /applications/{id} Delete an application
ApplicationsApi ApplicationsIdExtclientsGet Get /applications/{id}/extclients Returns the external clients associated with an application
ApplicationsApi ApplicationsIdExtclientsObjectIdDelete Delete /applications/{id}/extclients/{objectId} Delete an external client
ApplicationsApi ApplicationsIdExtclientsObjectIdPut Put /applications/{id}/extclients/{objectId} Updates an external client for the application
ApplicationsApi ApplicationsIdExtclientsPost Post /applications/{id}/extclients Maps a new external client to the application
ApplicationsApi ApplicationsIdGet Get /applications/{id} Get an application
ApplicationsApi ApplicationsIdImageGet Get /applications/{id}/image Get the image for an application
ApplicationsApi ApplicationsIdImagePost Post /applications/{id}/image Adds a JPEG image to an application
ApplicationsApi ApplicationsIdOauthClientIdPut Put /applications/{id}/oauth/{clientId} Updates an OAuth Credential for the application
ApplicationsApi ApplicationsIdOauthClientidNewsecretPut Put /applications/{id}/oauth/{clientid}/newsecret Updates an OAuth Credential for an application by generating a new secret
ApplicationsApi ApplicationsIdOauthGet Get /applications/{id}/oauth Returns the OAuth Credentials associated with an application
ApplicationsApi ApplicationsIdOauthOauthIdDelete Delete /applications/{id}/oauth/{oauthId} Delete an OAuth client ID and secret
ApplicationsApi ApplicationsIdOauthPost Post /applications/{id}/oauth Creates a new OAuth client ID and secret for the application
ApplicationsApi ApplicationsIdOauthresourceGet Get /applications/{id}/oauthresource Returns the OAuth protected resources (scopes) associated with an application
ApplicationsApi ApplicationsIdOauthresourcePost Post /applications/{id}/oauthresource Adds an OAuth protected resource to an application
ApplicationsApi ApplicationsIdOauthresourceResourceIdDelete Delete /applications/{id}/oauthresource/{resourceId} Remove an OAuth protected resource from an application
ApplicationsApi ApplicationsIdOauthresourceResourceIdPut Put /applications/{id}/oauthresource/{resourceId} Updates a protected resource associate with an application, sets enabled to true/false
ApplicationsApi ApplicationsIdPermissionsGet Get /applications/{id}/permissions Get the list of permissions.
ApplicationsApi ApplicationsIdPermissionsPermIdDelete Delete /applications/{id}/permissions/{permId} Remove a permission
ApplicationsApi ApplicationsIdPermissionsPermIdPut Put /applications/{id}/permissions/{permId} Modify a permission
ApplicationsApi ApplicationsIdPermissionsPost Post /applications/{id}/permissions Create a new permission.
ApplicationsApi ApplicationsIdPut Put /applications/{id} Update an application
ApplicationsApi ApplicationsIdQuotaDelete Delete /applications/{id}/quota Deletes a quota from an application
ApplicationsApi ApplicationsIdQuotaGet Get /applications/{id}/quota Returns the quota associated with an application.
ApplicationsApi ApplicationsIdQuotaPost Post /applications/{id}/quota Creates a new quota constraint for the application
ApplicationsApi ApplicationsIdQuotaPut Put /applications/{id}/quota Updates a quota contraint for an application
ApplicationsApi ApplicationsIdScopeGet Get /applications/{id}/scope Returns the scopes associated with an application
ApplicationsApi ApplicationsIdScopePost Post /applications/{id}/scope Adds an OAuth protected resource to an application
ApplicationsApi ApplicationsIdScopeScopeIdDelete Delete /applications/{id}/scope/{scopeId} Remove an OAuth protected resource from an application
ApplicationsApi ApplicationsIdScopeScopeIdPut Put /applications/{id}/scope/{scopeId} Updates a scope associated with an application, sets default to true/false
ApplicationsApi ApplicationsOauthclientClientIdGet Get /applications/oauthclient/{clientId} Get an application associated with an OAuth Client ID
ApplicationsApi ApplicationsPost Post /applications Creates a new application.
CurrentUserApi CurrentuserChangepasswordPost Post /currentuser/changepassword Modify the current user's password
CurrentUserApi CurrentuserGet Get /currentuser Get the current user
CurrentUserApi CurrentuserPut Put /currentuser Modify the current user
LoginApi LoginDelete Delete /login Logout from API Manager
LoginApi LoginPost Post /login Login to API Manager
MetricsApi MetricsFieldsGet Get /metrics/fields Gets a list of metric field names available for summary and timeline queries.
MetricsApi MetricsReportsTypeSummaryLevelGet Get /metrics/reports/{type}/summary/{level} Gets a summary report for application usage
MetricsApi MetricsReportsTypeTimelineLevelMetricTypeGet Get /metrics/reports/{type}/timeline/{level}/{metricType} Gets a timeline report for application usage
MigrateApi MigrateApplicationsExportCreatePost Post /migrate/applications/export/create Creates a set of export options associated with the current http session
MigrateApi MigrateApplicationsExportDownloadGet Get /migrate/applications/export/download Exports Application data for migration to other API Gateways
MigrateApi MigrateApplicationsExportJsonPost Post /migrate/applications/export/json Creates an export of applications based on the export options posted as a JSON object
MigrateApi MigrateApplicationsExportPost Post /migrate/applications/export Creates an export of applications based on the export options posted in a form data
MigrateApi MigrateApplicationsImportPost Post /migrate/applications/import Imports applications to the API Gateway
OAuthAuthorizationsApi AuthorizationsAuthzidDelete Delete /authorizations/{authzid} Delete the OAuth Authorization for the given authorization id.
OAuthAuthorizationsApi AuthorizationsGet Get /authorizations Retrieve all stored OAuth Authorizations for the logged in user.
OAuthAuthorizationsApi AuthorizationsOwnerSubjectidApplicationAppidDelete Delete /authorizations/owner/{subjectid}/application/{appid}
OrganizationsApi OrganizationsGet Get /organizations List all organizations
OrganizationsApi OrganizationsIdApisApiAccessIdDelete Delete /organizations/{id}/apis/{apiAccessId} Deletes access to an API for an organization
OrganizationsApi OrganizationsIdApisApiAccessIdPut Put /organizations/{id}/apis/{apiAccessId} Updates access to an API for an organization
OrganizationsApi OrganizationsIdApisGet Get /organizations/{id}/apis Get the list of approved APIs for the organization
OrganizationsApi OrganizationsIdApisPost Post /organizations/{id}/apis Grants access to an API for an organization.
OrganizationsApi OrganizationsIdDelete Delete /organizations/{id} Delete an organization
OrganizationsApi OrganizationsIdGet Get /organizations/{id} Get an organization
OrganizationsApi OrganizationsIdImageGet Get /organizations/{id}/image Get the image for an organization
OrganizationsApi OrganizationsIdImagePost Post /organizations/{id}/image Set the image for an organization
OrganizationsApi OrganizationsIdPut Put /organizations/{id} Update the details of an organization
OrganizationsApi OrganizationsIdTokensGet Get /organizations/{id}/tokens Get registration codes for an organization
OrganizationsApi OrganizationsIdTokensPost Post /organizations/{id}/tokens Create a registration code
OrganizationsApi OrganizationsIdTokensTokenDelete Delete /organizations/{id}/tokens/{token} Delete the registration code
OrganizationsApi OrganizationsIdTokensTokenGet Get /organizations/{id}/tokens/{token} Get registration code
OrganizationsApi OrganizationsIdTokensTokenPut Put /organizations/{id}/tokens/{token} Update a registration code
OrganizationsApi OrganizationsPost Post /organizations Creates a new organization
QuotasApi QuotasGet Get /quotas Returns all quotas
QuotasApi QuotasIdDelete Delete /quotas/{id} Deletes a quota
QuotasApi QuotasIdGet Get /quotas/{id} Returns the quota with the given ID
QuotasApi QuotasIdPut Put /quotas/{id} Updates a quota
QuotasApi QuotasPost Post /quotas Creates a new quota
UsersApi UsersForgotpasswordPost Post /users/forgotpassword Allows a user to reset their password.
UsersApi UsersGet Get /users Obtains a list of users
UsersApi UsersIdApprovePost Post /users/{id}/approve Grants approval to a request to create a new user on the system.
UsersApi UsersIdChangepasswordPost Post /users/{id}/changepassword Updates the password for a given user.
UsersApi UsersIdDelete Delete /users/{id} Deletes a user.
UsersApi UsersIdGet Get /users/{id} Retrieves the details for a given user.
UsersApi UsersIdImageGet Get /users/{id}/image Get the image for a user
UsersApi UsersIdImagePost Post /users/{id}/image Set the image for a user
UsersApi UsersIdPut Put /users/{id} Updates the details for a given user.
UsersApi UsersIdResetpasswordPut Put /users/{id}/resetpassword Admin level function to reset the password for a given user.
UsersApi UsersPost Post /users Admin function to create a new user on the system
UsersApi UsersRegisterPost Post /users/register Register a new user.
UsersApi UsersResetpasswordGet Get /users/resetpassword Validates the user /forgotpassword password request.
UsersApi UsersValidateuserGet Get /users/validateuser Validates the user /register request.

Documentation For Models

Documentation For Authorization

basic

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

support@axway.com

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	APIDiscoveryApi *APIDiscoveryApiService

	APIManagerServicesApi *APIManagerServicesApiService

	APIProxyRegistrationApi *APIProxyRegistrationApiService

	APIRepositoryApi *APIRepositoryApiService

	ApplicationsApi *ApplicationsApiService

	CurrentUserApi *CurrentUserApiService

	LoginApi *LoginApiService

	MetricsApi *MetricsApiService

	MigrateApi *MigrateApiService

	OAuthAuthorizationsApi *OAuthAuthorizationsApiService

	OrganizationsApi *OrganizationsApiService

	QuotasApi *QuotasApiService

	UsersApi *UsersApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the API Manager API v1.3 API v1.3.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIDiscoveryApiService 

type APIDiscoveryApiService service

APIDiscoveryApiService APIDiscoveryApi service

func (*APIDiscoveryApiService) DiscoveryApisGet 

func (a *APIDiscoveryApiService) DiscoveryApisGet(ctx _context.Context) ([]DiscoveryApi, *_nethttp.Response, error)

DiscoveryApisGet Lists all APIs/services virtualised in the API Server. Lists all APIs/services virtualised in the API Server. API Administrators see all APIs/services. Users see APIs/services for their organization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []DiscoveryApi

func (*APIDiscoveryApiService) DiscoveryOauthresourcesGet 

func (a *APIDiscoveryApiService) DiscoveryOauthresourcesGet(ctx _context.Context) (*_nethttp.Response, error)

DiscoveryOauthresourcesGet Gets a list OAuth protected resources and their associated scopes. Gets a list OAuth protected resources and their associated scopes.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*APIDiscoveryApiService) DiscoveryScopesGet 

func (a *APIDiscoveryApiService) DiscoveryScopesGet(ctx _context.Context) ([]OAuthProtectedResource, *_nethttp.Response, error)

DiscoveryScopesGet Retrieves every resource on the API Server that is protected by OAuth, and the scopes that cover those resources Retrieves every resource on the API Server that is protected by OAuth, and the scopes that cover those resources. Only API Administrators will be able to retrieve information.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []OAuthProtectedResource

func (*APIDiscoveryApiService) DiscoverySdkIdPlatformGet 

func (a *APIDiscoveryApiService) DiscoverySdkIdPlatformGet(ctx _context.Context, id string, platform string, localVarOptionals *DiscoverySdkIdPlatformGetOpts) (*_nethttp.Response, error)

DiscoverySdkIdPlatformGet Generates an SDK package for the specified API based on the type of the client requested Generates a client SDK package for the specified API based on the platform. Supported platform are Android, iOS-swift, NodeJS, Titanium

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The name of the API to generate the client SDK package for
  • @param platform Generated client type, one of: android, iOS-swift, nodejS, titanium
  • @param optional nil or *DiscoverySdkIdPlatformGetOpts - Optional Parameters:
  • @param "Packagename" (optional.String) - Java package name generated only for Android platform. It must be a valid java package name.

func (*APIDiscoveryApiService) DiscoverySwaggerApiIdIdGet 

func (a *APIDiscoveryApiService) DiscoverySwaggerApiIdIdGet(ctx _context.Context, id string, localVarOptionals *DiscoverySwaggerApiIdIdGetOpts) (*_nethttp.Response, error)

DiscoverySwaggerApiIdIdGet Retrieves an extended Swagger feed for the specified API. Retrieves an extended Swagger feed for the specified API. API Administrators will always see the API. Users will only see the API if it is available for their organization.If __filename__ is supplied, the download will use it as the `Content-Disposition` filename attachment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The unique ID of the API to return
  • @param optional nil or *DiscoverySwaggerApiIdIdGetOpts - Optional Parameters:
  • @param "Filename" (optional.String) - Override the default filename for download
  • @param "SwaggerVersion" (optional.String) - The Swagger version of the feed, either 1.1 (default) or 2.0.
  • @param "Extensions" (optional.Bool) - If true, extensions such as the x-axway object are returned in the Swagger definitions (default=true)

func (*APIDiscoveryApiService) DiscoverySwaggerApiNameGet 

func (a *APIDiscoveryApiService) DiscoverySwaggerApiNameGet(ctx _context.Context, name string, localVarOptionals *DiscoverySwaggerApiNameGetOpts) (*_nethttp.Response, error)

DiscoverySwaggerApiNameGet Retrieves an extended Swagger feed for the specified API. Retrieves an extended Swagger feed for the specified API. API Administrators will always see the API. Users will only see the API if it is available for their organization.If __filename__ is supplied, the download will use it as the `Content-Disposition` filename attachment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name The name of the API to return
  • @param optional nil or *DiscoverySwaggerApiNameGetOpts - Optional Parameters:
  • @param "Filename" (optional.String) - Override the default filename for download
  • @param "ApiVersion" (optional.String) - The version of the API. Should always be provided if there is more than one version
  • @param "SwaggerVersion" (optional.String) - The Swagger version of the feed, either 1.1 (default) or 2.0.
  • @param "Extensions" (optional.Bool) - If true, extensions such as the x-axway object are returned in the Swagger definitions (default=true)

func (*APIDiscoveryApiService) DiscoverySwaggerApisGet 

func (a *APIDiscoveryApiService) DiscoverySwaggerApisGet(ctx _context.Context, localVarOptionals *DiscoverySwaggerApisGetOpts) (*_nethttp.Response, error)

DiscoverySwaggerApisGet Convenience method for retrieving all Swagger feeds for all virtualised services. Convenience method for retrieving all Swagger feeds for all virtualised services that are visible to the authenticated user. The list of APIs can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of: id : Matches the API by the specified ID name : Matches the API by the specified name description : Matches the API by the specified description summary : Matches the API by the specified summary version : Matches the API by the specified version type : Matches the API by the specified type. Type can be 'rest' or 'wsdl' resourcepath : Matches the API by the specified inbound path taggroup : Matches the API by the specified tag group tag : Matches the API by the specified tag value methodtaggroup : Matches the API by the specified method tag group, i.e. if the API contains a method that contains a tag group matching that specified methodtag : Matches the API by the specified method tag value, i.e. if the API contains a method that contains a tag value matching that specified The __op__ is an operation and is one of: eq : Equal ne : Not equal gt : Greater than lt : Less than ge : Greater than or equal le : Less than or equal like : Like gete : Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10 The __value__ will be compared against the __field__, according to the supplied __op__.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *DiscoverySwaggerApisGetOpts - Optional Parameters:
  • @param "ApiVersion" (optional.String) - The Swagger API version
  • @param "SwaggerVersion" (optional.String) - The Swagger version
  • @param "Extensions" (optional.Bool) - If true, extensions such as the x-axway object are returned in the Swagger definitions (default=true)
  • @param "Field" (optional.Interface of []string) - Filter field name.
  • @param "Op" (optional.Interface of []string) - Filter operation.
  • @param "Value" (optional.Interface of []string) - Filter value

func (*APIDiscoveryApiService) DiscoverySwaggerApisIdImageGet 

func (a *APIDiscoveryApiService) DiscoverySwaggerApisIdImageGet(ctx _context.Context, id string) (*_nethttp.Response, error)

DiscoverySwaggerApisIdImageGet Retrieves the API image

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The API identifier

func (*APIDiscoveryApiService) DiscoverySwaggerApisIdServiceDefinitionGet 

func (a *APIDiscoveryApiService) DiscoverySwaggerApisIdServiceDefinitionGet(ctx _context.Context, id string) (*_nethttp.Response, error)

DiscoverySwaggerApisIdServiceDefinitionGet Retrieves the service definition of the API.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The API identifier

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIManagerServicesApiService 

type APIManagerServicesApiService service

APIManagerServicesApiService APIManagerServicesApi service

func (*APIManagerServicesApiService) AlertsGet 

func (a *APIManagerServicesApiService) AlertsGet(ctx _context.Context) (AlertConfig, *_nethttp.Response, error)

AlertsGet Gets the alerts configured for the API Manager Gets the alerts configured for the API Manager that shows which alerts are enabled/disabled for the application. Only the API Administrator may call this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AlertConfig

func (*APIManagerServicesApiService) AlertsPost 

func (a *APIManagerServicesApiService) AlertsPost(ctx _context.Context, localVarOptionals *AlertsPostOpts) (AlertConfig, *_nethttp.Response, error)

AlertsPost Updates the API Manager alerts configuration Updates the API Manager alerts configuration. Only the API Administrator may call this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AlertsPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of AlertConfig) -

@return AlertConfig

func (*APIManagerServicesApiService) AppinfoGet 

func (a *APIManagerServicesApiService) AppinfoGet(ctx _context.Context) (Config, *_nethttp.Response, error)

AppinfoGet Gets API Manager feature information. Returns an API Manager configuration object describing the application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return Config

func (*APIManagerServicesApiService) CertinfoPost 

func (a *APIManagerServicesApiService) CertinfoPost(ctx _context.Context, localVarOptionals *CertinfoPostOpts) ([]CaCert, *_nethttp.Response, error)

CertinfoPost Extracts certificate information from the supplied data Extracts certificate information from the supplied data.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CertinfoPostOpts - Optional Parameters:
  • @param "Username" (optional.String) -
  • @param "File" (optional.Interface of *os.File) -
  • @param "Passphrase" (optional.String) -
  • @param "Inbound" (optional.Bool) -
  • @param "Outbound" (optional.Bool) -

@return CaCert

func (*APIManagerServicesApiService) ConfigGet 

func (a *APIManagerServicesApiService) ConfigGet(ctx _context.Context) (Config, *_nethttp.Response, error)

ConfigGet Gets API Manager configuration Returns an API Manager configuration object.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return Config

func (*APIManagerServicesApiService) ConfigPut 

func (a *APIManagerServicesApiService) ConfigPut(ctx _context.Context, localVarOptionals *ConfigPutOpts) (Config, *_nethttp.Response, error)

ConfigPut Updates the API Manager configuration Updates the API Manager configuration. Only the API Administrator may call this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ConfigPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of Config) -

@return Config

func (*APIManagerServicesApiService) ConnectorsConnectorIdGet 

func (a *APIManagerServicesApiService) ConnectorsConnectorIdGet(ctx _context.Context, connectorId string) ([]map[string]map[string]interface{}, *_nethttp.Response, error)

ConnectorsConnectorIdGet Return a list of APIs for the specified connector Return a list of APIs for the specified connector.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param connectorId ID of the connector for which APIs should be returned. Connector IDs can be retrieved by calling /connectors.

@return []map[string]map[string]interface{}

func (*APIManagerServicesApiService) ConnectorsConnectorIdLoginPost 

func (a *APIManagerServicesApiService) ConnectorsConnectorIdLoginPost(ctx _context.Context, connectorId string, username string, password string) (string, *_nethttp.Response, error)

ConnectorsConnectorIdLoginPost Login to an external service from which APIs will be imported Login to an external service from which APIs will be imported.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param connectorId ID of the API connector. Connector IDs can be retrieved by calling /connectors.
  • @param username External service username
  • @param password External service password

@return string

func (*APIManagerServicesApiService) ConnectorsGet 

func (a *APIManagerServicesApiService) ConnectorsGet(ctx _context.Context) ([]map[string]map[string]interface{}, *_nethttp.Response, error)

ConnectorsGet Return a list of API connectors Return a list of API connectors.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []map[string]map[string]interface{}

func (*APIManagerServicesApiService) FiledataPost 

func (a *APIManagerServicesApiService) FiledataPost(ctx _context.Context, localVarOptionals *FiledataPostOpts) (*_nethttp.Response, error)

FiledataPost Returns the DataURI representation of the uploaded file Returns the DataURI representation of the uploaded file.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *FiledataPostOpts - Optional Parameters:
  • @param "File" (optional.Interface of *os.File) -

func (*APIManagerServicesApiService) LicenseGet 

func (a *APIManagerServicesApiService) LicenseGet(ctx _context.Context) (string, *_nethttp.Response, error)

LicenseGet Checks that the API Manager has a valid license Returns an API Manager license configuration object. Does not require authentication.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*APIManagerServicesApiService) ListenersGet 

func (a *APIManagerServicesApiService) ListenersGet(ctx _context.Context) ([]PortalTrafficListener, *_nethttp.Response, error)

ListenersGet Gets the API Manager listeners Returns a list of API Manager listeners.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PortalTrafficListener

func (*APIManagerServicesApiService) OauthclientprofilesGet 

func (a *APIManagerServicesApiService) OauthclientprofilesGet(ctx _context.Context) ([]ReferencedEntity, *_nethttp.Response, error)

OauthclientprofilesGet Get a list of OAuth profiles for use in backend API authorisation Return a list of OAuth Client Profiles for use in authorising API access to backend APIs.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []ReferencedEntity

func (*APIManagerServicesApiService) PoliciesGet 

func (a *APIManagerServicesApiService) PoliciesGet(ctx _context.Context, type_ string) ([]ReferencedEntity, *_nethttp.Response, error)

PoliciesGet Gets a list of the specified policies Returns the list of policies (of the specified type) that are available to Portal-registered APIs. __type__ is one of: faulthandler, globalrequest, globalresponse, request, routing, response, promotion, authentication or token-info.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param type_ The type of policy to return. Possible values are: 'faulthandler', 'globalrequest', 'globalresponse', 'request', 'routing', 'response', 'authentication', 'oauthtokeninfo', 'promotion'

@return []ReferencedEntity

func (*APIManagerServicesApiService) RemotehostsGet 

func (a *APIManagerServicesApiService) RemotehostsGet(ctx _context.Context) ([]RemoteHost, *_nethttp.Response, error)

RemotehostsGet Returns a list of remote hosts Returns a list of API Manager-registered remote hosts.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []RemoteHost

func (*APIManagerServicesApiService) RemotehostsIdDelete 

func (a *APIManagerServicesApiService) RemotehostsIdDelete(ctx _context.Context, id string) (*_nethttp.Response, error)

RemotehostsIdDelete Deletes a remote host. Deletes an API Manager-registered remote host. Dynamically removes the remote host from the API Gateway runtime.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote host identifier.

func (*APIManagerServicesApiService) RemotehostsIdPut 

func (a *APIManagerServicesApiService) RemotehostsIdPut(ctx _context.Context, id string, localVarOptionals *RemotehostsIdPutOpts) (RemoteHost, *_nethttp.Response, error)

RemotehostsIdPut Updates a remote host Updates an API Manager-registered remote host. Dynamically updates the API Gateway runtime so that the new remote host settings are available.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote host identifier.
  • @param optional nil or *RemotehostsIdPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of RemoteHost) -

@return RemoteHost

func (*APIManagerServicesApiService) RemotehostsPost 

func (a *APIManagerServicesApiService) RemotehostsPost(ctx _context.Context, localVarOptionals *RemotehostsPostOpts) (RemoteHost, *_nethttp.Response, error)

RemotehostsPost Creates a new remote host Creates a new API Manager-regsitered remote host. Dynamically updates the API Gateway runtime so that the remote host is available.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *RemotehostsPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of RemoteHost) -

@return RemoteHost

func (*APIManagerServicesApiService) ServiceDiscoveryInstanceTypePost 

func (a *APIManagerServicesApiService) ServiceDiscoveryInstanceTypePost(ctx _context.Context, instance string, type_ string, localVarOptionals *ServiceDiscoveryInstanceTypePostOpts) ([]Swagger, *_nethttp.Response, error)

ServiceDiscoveryInstanceTypePost Returns a list of services hosted on the specified Gateway instance Returns a list of services hosted on the specified Gateway instance. __type__ is one of: rest, wsdl.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param instance
  • @param type_ The type of service to return. Possible values are: 'rest', 'wsdl'
  • @param optional nil or *ServiceDiscoveryInstanceTypePostOpts - Optional Parameters:
  • @param "Host" (optional.String) -
  • @param "Port" (optional.String) -
  • @param "Username" (optional.String) -
  • @param "Password" (optional.String) -

@return []Swagger

func (*APIManagerServicesApiService) SysconfigGet 

func (a *APIManagerServicesApiService) SysconfigGet(ctx _context.Context) (SystemConfig, *_nethttp.Response, error)

SysconfigGet Gets API Manager system configuration Returns an API Manager system configuration object.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SystemConfig

func (*APIManagerServicesApiService) SysconfigPut 

func (a *APIManagerServicesApiService) SysconfigPut(ctx _context.Context, localVarOptionals *SysconfigPutOpts) (SystemConfig, *_nethttp.Response, error)

SysconfigPut Update API Manager system configuration Returns an API Manager system configuration object.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SysconfigPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of SystemConfig) -

@return SystemConfig

func (*APIManagerServicesApiService) TitleGet 

func (a *APIManagerServicesApiService) TitleGet(ctx _context.Context) (string, *_nethttp.Response, error)

TitleGet Gets the API Manager's title Returns the API Manager title. Does not require authentication.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*APIManagerServicesApiService) TokenstoresGet 

func (a *APIManagerServicesApiService) TokenstoresGet(ctx _context.Context) ([]ReferencedEntity, *_nethttp.Response, error)

TokenstoresGet Gets a list of Token Stores Returns a list of Token Stores to be used by OAuth Security Devices for inbound security on portal-registered APIs.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []ReferencedEntity

func (*APIManagerServicesApiService) TopologyPost 

func (a *APIManagerServicesApiService) TopologyPost(ctx _context.Context, host string, port string, username string, password string) (Topology, *_nethttp.Response, error)

TopologyPost Retrieves the Topology from the specified Admin Node Manager Retrieves the Topology from the specified Admin Node Manager

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param host The host on which the Admin Node Manager is running
  • @param port The Admin Node Manager management port.
  • @param username Username to use for Admin Node Manager authentication .
  • @param password Password to use for Admin Node Manager authentication.

@return Topology

type APIProxyRegistrationApiService 

type APIProxyRegistrationApiService service

APIProxyRegistrationApiService APIProxyRegistrationApi service

func (*APIProxyRegistrationApiService) ProxiesExportIdGet 

func (a *APIProxyRegistrationApiService) ProxiesExportIdGet(ctx _context.Context, id string, filename string) (ApiPromotion, *_nethttp.Response, error)

ProxiesExportIdGet Downloads an API export. The API export is produced from [/exportApis](APIProxyRegistration.html#APIProxyRegistrationexportApis). If __filename__ is supplied, the download will use it as the `Content-Disposition` filename attachment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The export identifier.
  • @param filename The export will be downloaded using a Content-Dispostion using the supplied filename

@return ApiPromotion

func (*APIProxyRegistrationApiService) ProxiesExportPost 

func (a *APIProxyRegistrationApiService) ProxiesExportPost(ctx _context.Context, id []string, password string, filename string) (*_nethttp.Response, error)

ProxiesExportPost Creates an API export. Creates an export for use in promoting the API to a new environment. The export contains the frontend [VirtualizedAPI](VirtualizedAPI.html), their settings, and all backend [APIDefinition](APIDefinition.html) that are required for the frontend API. If **password** is supplied, the exported file will be encrypted with the password. If successful, returns **201 Created**, and the HTTP `Location` header contain the of the URL of the export. The export is temporary, and may only be downloaded once.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier(s) to export.
  • @param password Encrypts the list of API using the password.
  • @param filename Optional filename to use in response.

func (*APIProxyRegistrationApiService) ProxiesGet 

func (a *APIProxyRegistrationApiService) ProxiesGet(ctx _context.Context, localVarOptionals *ProxiesGetOpts) ([]VirtualizedApi, *_nethttp.Response, error)

ProxiesGet Queries a list of frontend API. Returns a list of API that are visible to the authenticated user. The list of API can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of: name : The name of the API apiid : Matches the API if the API is virtualized from the specified backend API createdOn : The date the user was created on, time in ms, e.g.: 1372755998542 deprecated : The deprecated state of the API, one of: true or false retired : The retired state of the API, one of: true or false state : The API's state, one of: unpublished, pending, or published The __op__ is an operation and is one of: eq : Equal ne : Not equal gt : Greater than lt : Less than ge : Greater than or equal le : Less than or equal like : Like gete : Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10 The __value__ will be compared against the __field__, according to the supplied __op__.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ProxiesGetOpts - Optional Parameters:
  • @param "Field" (optional.Interface of []string) - Filter field name.
  • @param "Op" (optional.Interface of []string) - Filter operation.
  • @param "Value" (optional.Interface of []string) - Filter value

@return []VirtualizedApi

func (*APIProxyRegistrationApiService) ProxiesGrantaccessPost 

func (a *APIProxyRegistrationApiService) ProxiesGrantaccessPost(ctx _context.Context, action string, apiId []string, grantOrgId []string, grantApiId []string) (*_nethttp.Response, error)

ProxiesGrantaccessPost Macro function to grant API access. Function to macro-apply access to selected API. The access can be granted to organizations or entities having access to specified API. If **action** is _all_orgs_, access will be granted to all organizations; if **action** is _orgs_, access will be granted to the organization(s) specified by **grantOrganizations**; if **action** is _orgs\\_with\\_apis_, access will be granted to the organizations with access to the apis specified by **grantApis**.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param action Grant action to perform. Possible values are: all\\\\_orgs, orgs, and orgs\\\\_with\\\\_apis.
  • @param apiId List of API ID to which access will be granted.
  • @param grantOrgId List of target organization ID to which access to _apiId_ will be granted (action is _orgs_)
  • @param grantApiId List of API ID to which access to to _apiId_ will be granted (action is _orgs\\_with\\_apis_).

func (*APIProxyRegistrationApiService) ProxiesIdDelete 

func (a *APIProxyRegistrationApiService) ProxiesIdDelete(ctx _context.Context, id string) (*_nethttp.Response, error)

ProxiesIdDelete Deletes an API proxy. Deletes an API proxy, removing all API access in the process.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.

func (*APIProxyRegistrationApiService) ProxiesIdDeprecatePost 

func (a *APIProxyRegistrationApiService) ProxiesIdDeprecatePost(ctx _context.Context, id string, localVarOptionals *ProxiesIdDeprecatePostOpts) (VirtualizedApi, *_nethttp.Response, error)

ProxiesIdDeprecatePost Deprecates the API. Only an API Administrator may deprecate an API, and only _published_ API may be deprecated. When an API is _deprecated_, the API can still be used, but users will be informed that the API has been deprecated. Optionally, a **retirementDate** may be set which will schedule the API to be automatically retired and removed from use. If specified, the **retirementDate** should be in the ISO-8601 format of yyyy-MM-ddTHH:mm:ssZ (e.g. 2015-01-01T12:00:00Z).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.
  • @param optional nil or *ProxiesIdDeprecatePostOpts - Optional Parameters:
  • @param "RetirementDate" (optional.String) - Optional API retirement date specified in supported ISO-8601 format. Set to the past to retire immediately.

@return VirtualizedApi

func (*APIProxyRegistrationApiService) ProxiesIdGet 

func (a *APIProxyRegistrationApiService) ProxiesIdGet(ctx _context.Context, id string) (VirtualizedApi, *_nethttp.Response, error)

ProxiesIdGet Gets a frontend API by ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.

@return VirtualizedApi

func (*APIProxyRegistrationApiService) ProxiesIdImageGet 

func (a *APIProxyRegistrationApiService) ProxiesIdImageGet(ctx _context.Context, id string) (*_nethttp.Response, error)

ProxiesIdImageGet Gets the image for the API. Returns the jpeg image associated with the API.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.

func (*APIProxyRegistrationApiService) ProxiesIdImagePost 

func (a *APIProxyRegistrationApiService) ProxiesIdImagePost(ctx _context.Context, id string, localVarOptionals *ProxiesIdImagePostOpts) (*_nethttp.Response, error)

ProxiesIdImagePost Set the image for the frontend API. Set the jpeg image to be associated with the API.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.
  • @param optional nil or *ProxiesIdImagePostOpts - Optional Parameters:
  • @param "Type_" (optional.String) -
  • @param "File" (optional.Interface of *os.File) -

func (*APIProxyRegistrationApiService) ProxiesIdOperationsGet 

func (a *APIProxyRegistrationApiService) ProxiesIdOperationsGet(ctx _context.Context, id string) ([]VirtualizedApiMethod, *_nethttp.Response, error)

ProxiesIdOperationsGet Gets a list of methods that are avilable to the API proxy.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.

@return []VirtualizedApiMethod

func (*APIProxyRegistrationApiService) ProxiesIdOperationsOperationIdDelete 

func (a *APIProxyRegistrationApiService) ProxiesIdOperationsOperationIdDelete(ctx _context.Context, id string, operationId string) (*_nethttp.Response, error)

ProxiesIdOperationsOperationIdDelete Deletes an API method by ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.
  • @param operationId The frontend API method identifier.

func (*APIProxyRegistrationApiService) ProxiesIdOperationsOperationIdGet 

func (a *APIProxyRegistrationApiService) ProxiesIdOperationsOperationIdGet(ctx _context.Context, id string, operationId string) (VirtualizedApiMethod, *_nethttp.Response, error)

ProxiesIdOperationsOperationIdGet Gets an API method by ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.
  • @param operationId The frontend API method identifier.

@return VirtualizedApiMethod

func (*APIProxyRegistrationApiService) ProxiesIdOperationsOperationIdPut 

func (a *APIProxyRegistrationApiService) ProxiesIdOperationsOperationIdPut(ctx _context.Context, id string, operationId string, body VirtualizedApiMethod) (VirtualizedApiMethod, *_nethttp.Response, error)

ProxiesIdOperationsOperationIdPut Updates an API proxy operation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.
  • @param operationId The frontend API method identifier.
  • @param body The method to update.

@return VirtualizedApiMethod

func (*APIProxyRegistrationApiService) ProxiesIdPublishPost 

func (a *APIProxyRegistrationApiService) ProxiesIdPublishPost(ctx _context.Context, id string, name string, vhost string) (VirtualizedApi, *_nethttp.Response, error)

ProxiesIdPublishPost Publish the API. If called by an API Administrator, then the API state will be _published_, otherwise the API state will be _pending_, and an email notification will be sent to the API Administrators, notifying them of the event. Optionally, on publishing, a new **name** for the API may be specified. Similarly, an optional **vhost** may be specified. The **vhost** is an externally resolvable virtual host from which the API will be accessed.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.
  • @param name The name on which to publish this API.
  • @param vhost The optional virtual host on which to publish this API.

@return VirtualizedApi

func (*APIProxyRegistrationApiService) ProxiesIdPut 

func (a *APIProxyRegistrationApiService) ProxiesIdPut(ctx _context.Context, id string, body VirtualizedApi) (VirtualizedApi, *_nethttp.Response, error)

ProxiesIdPut Updates an API proxy.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.
  • @param body The virtualized API to update

@return VirtualizedApi

func (*APIProxyRegistrationApiService) ProxiesIdUndeprecatePost 

func (a *APIProxyRegistrationApiService) ProxiesIdUndeprecatePost(ctx _context.Context, id string) (VirtualizedApi, *_nethttp.Response, error)

ProxiesIdUndeprecatePost Undeprecates the API. Only an API Administrator may undeprecate an API, and only _published_ API, that are deprecated, may be undeprecated.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.

@return VirtualizedApi

func (*APIProxyRegistrationApiService) ProxiesIdUnpublishPost 

func (a *APIProxyRegistrationApiService) ProxiesIdUnpublishPost(ctx _context.Context, id string) (VirtualizedApi, *_nethttp.Response, error)

ProxiesIdUnpublishPost Unpublish the API. Only an API Administrator may unpublish an API. When an API is _unpublished_, all access to the API is revoked from all applications, and all organizations, save the API development organization that owns the API.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The frontend API identifier.

@return VirtualizedApi

func (*APIProxyRegistrationApiService) ProxiesImportFromUrlPost 

func (a *APIProxyRegistrationApiService) ProxiesImportFromUrlPost(ctx _context.Context, organizationId string, url string, password string) (*_nethttp.Response, error)

ProxiesImportFromUrlPost Imports a previously exported API. Imports API, previously exported using [/exportApis](APIProxyRegistration.html#APIProxyRegistrationexportApis). If the API was exported using a password, then the file is encrypted, and a **password** argument must be provided to decrypt. The import will create [VirtualizedAPI](VirtualizedAPI.html), their settings, and all backend [APIDefinition](APIDefinition.html) necessary to support the frontend API. The **url** should be a [data URI scheme](http://en.wikipedia.org/wiki/Data_URI_scheme).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param organizationId The organization identifier.
  • @param url The data URI.
  • @param password Optional password to decrypt the import file.

func (*APIProxyRegistrationApiService) ProxiesImportPost 

func (a *APIProxyRegistrationApiService) ProxiesImportPost(ctx _context.Context, organizationId string, password string, file *os.File) (*_nethttp.Response, error)

ProxiesImportPost Imports a previously exported API. Imports API, previously exported using [/exportApis](APIProxyRegistration.html#APIProxyRegistrationexportApis). If the API was exported using a password, then the file is encrypted, and a **password** argument must be provided to decrypt. The import will create [VirtualizedAPI](VirtualizedAPI.html), their settings, and all backend [APIDefinition](APIDefinition.html) necessary to support the frontend API. This method is similar to [/importFromUrl](APIProxyRegistration.html#APIProxyRegistrationimportFromUrl), save that this method supports traditional form-based file upload, using `multipart/form-data`.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param organizationId The organization identifier.
  • @param password Optional password to decrypt the import file.
  • @param file The data file to import.

func (*APIProxyRegistrationApiService) ProxiesPost 

func (a *APIProxyRegistrationApiService) ProxiesPost(ctx _context.Context, body VirtualizedApi) (VirtualizedApi, *_nethttp.Response, error)

ProxiesPost Creates a new API proxy from a backend API. The [VirtualizedAPI apiId](VirtualizedAPI.html#apiId) is required. If creating the APIas an API administrator, the [VirtualizedAPI organizationId](VirtualizedAPI.html#organizationId) must also be specified.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The frontend API to create.

@return VirtualizedApi

func (*APIProxyRegistrationApiService) ProxiesPromotePost 

func (a *APIProxyRegistrationApiService) ProxiesPromotePost(ctx _context.Context, apiId []string) (*_nethttp.Response, error)

ProxiesPromotePost Invokes the internal API promotion policy for the specified API. In API Manager, API promotion must first be enabled in Settings. Also, in Policy Studio (Server Settings -> API Manager -> API Promotion) a promotion policy must be selected. By default a sample promotion policy is installed

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param apiId The frontend API identifier(s) to promote

func (*APIProxyRegistrationApiService) ProxiesUpgradeIdPost 

func (a *APIProxyRegistrationApiService) ProxiesUpgradeIdPost(ctx _context.Context, id string, upgradeApiId string, deprecate bool, retire bool, retirementDate string) (*_nethttp.Response, error)

ProxiesUpgradeIdPost Upgrades an existing frontend API to a newer frontend API. During an API lifecycle, it is necessary to upgrade users to use a newer frontend API. The idea being that the old frontend API should be phased-out, and developers should move their applications to use the newer frontend API. This method assigns all organizations and applications the same access to the new frontend API (identified by **upgradeApiId**) that they have to the old API (identified by **id**). Optionally, the old frontend API may be deprecated or retired using **deprecate**, **retire**, or scheduled to be retired using **retirementDate**. If specified, the **retirementDate** should be in the ISO-8601 format of yyyy-MM-ddTHH:mm:ssZ (e.g. 2015-01-01T12:00:00Z).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param upgradeApiId The id of the frontend API which will be used to upgrade this virtualized API
  • @param deprecate Specifies whether or not the API being upgraded should be depreated
  • @param retire Specifies whether or not the API being upgraded should be retired
  • @param retirementDate Specifies the retirement date of the the API being upgraded if its being retired

type APIRepositoryApiService 

type APIRepositoryApiService service

APIRepositoryApiService APIRepositoryApi service

func (*APIRepositoryApiService) ApirepoGet 

func (a *APIRepositoryApiService) ApirepoGet(ctx _context.Context, localVarOptionals *ApirepoGetOpts) ([]ApiDefinition, *_nethttp.Response, error)

ApirepoGet Get the list of API Get the list of API from the API repository. The list of API can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of: id : Matches the API by ID name : Matches the API by name The __op__ is an operation and is one of: eq : Equal ne : Not equal gt : Greater than lt : Less than ge : Greater than or equal le : Less than or equal like : Like gete : Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10 The __value__ will be compared against the __field__, according to the supplied __op__.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ApirepoGetOpts - Optional Parameters:
  • @param "Filename" (optional.String) -
  • @param "Field" (optional.Interface of []string) - Filter field name.
  • @param "Op" (optional.Interface of []string) - Filter operation.
  • @param "Value" (optional.Interface of []string) - Filter value

@return []ApiDefinition

func (*APIRepositoryApiService) ApirepoIdDelete 

func (a *APIRepositoryApiService) ApirepoIdDelete(ctx _context.Context, id string) (*_nethttp.Response, error)

ApirepoIdDelete Deletes an API. Deletes a backend API.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The API identifier.

func (*APIRepositoryApiService) ApirepoIdDownloadGet 

func (a *APIRepositoryApiService) ApirepoIdDownloadGet(ctx _context.Context, id string, filename string, original bool) (*_nethttp.Response, error)

ApirepoIdDownloadGet Downloads an API by ID. Downloads an API by ID. If __filename__ is not supplied, the API name will be used. If the API was imported using [/import](#importApisFromFile) or [/import](#createApiFromUrl), then it is possible to download the original API definition by setting __original__ to __true__.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param filename Override the default filename for download
  • @param original If true, and the API was imported, this will download the original definition

func (*APIRepositoryApiService) ApirepoIdGet 

func (a *APIRepositoryApiService) ApirepoIdGet(ctx _context.Context, id string) (ApiDefinition, *_nethttp.Response, error)

ApirepoIdGet Get an API by ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id

@return ApiDefinition

func (*APIRepositoryApiService) ApirepoIdMethodsGet 

func (a *APIRepositoryApiService) ApirepoIdMethodsGet(ctx _context.Context, id string, localVarOptionals *ApirepoIdMethodsGetOpts) ([]Method, *_nethttp.Response, error)

ApirepoIdMethodsGet Queries the list of API methods Get the list of API methods from the API repository. The list of methods can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of: id : Matches the API by ID name : Matches the API by name The __op__ is an operation and is one of: eq : Equal ne : Not equal gt : Greater than lt : Less than ge : Greater than or equal le : Less than or equal like : Like gete : Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10 The __value__ will be compared against the __field__, according to the supplied __op__.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param optional nil or *ApirepoIdMethodsGetOpts - Optional Parameters:
  • @param "Field" (optional.Interface of []string) - Filter field name.
  • @param "Op" (optional.Interface of []string) - Filter operation.
  • @param "Value" (optional.Interface of []string) - Filter value

@return []Method

func (*APIRepositoryApiService) ApirepoIdMethodsMethodIdDelete 

func (a *APIRepositoryApiService) ApirepoIdMethodsMethodIdDelete(ctx _context.Context, id string, methodId string) (*_nethttp.Response, error)

ApirepoIdMethodsMethodIdDelete Delete an API method Deletes a backend API method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The API identifier.
  • @param methodId The method identifier.

func (*APIRepositoryApiService) ApirepoIdMethodsMethodIdGet 

func (a *APIRepositoryApiService) ApirepoIdMethodsMethodIdGet(ctx _context.Context, id string, methodId string) (Method, *_nethttp.Response, error)

ApirepoIdMethodsMethodIdGet Get API method by ID. Retrieves a method for a given API.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The API identifier.
  • @param methodId The API method ID.

@return Method

func (*APIRepositoryApiService) ApirepoIdMethodsMethodIdPut 

func (a *APIRepositoryApiService) ApirepoIdMethodsMethodIdPut(ctx _context.Context, id string, methodId string, method Method) (Method, *_nethttp.Response, error)

ApirepoIdMethodsMethodIdPut Update an API method

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The API identifierentifier to create a method.
  • @param methodId The method identifier.
  • @param method The method to update.

@return Method

func (*APIRepositoryApiService) ApirepoIdMethodsPost 

func (a *APIRepositoryApiService) ApirepoIdMethodsPost(ctx _context.Context, id string, method Method) (Method, *_nethttp.Response, error)

ApirepoIdMethodsPost Create an API method

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The API identifierentifier to create a method.
  • @param method The method to create.

@return Method

func (*APIRepositoryApiService) ApirepoIdPut 

func (a *APIRepositoryApiService) ApirepoIdPut(ctx _context.Context, id string, localVarOptionals *ApirepoIdPutOpts) (ApiDefinition, *_nethttp.Response, error)

ApirepoIdPut Updates an API

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The API identifier.
  • @param optional nil or *ApirepoIdPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of ApiDefinition) -

@return ApiDefinition

func (*APIRepositoryApiService) ApirepoImportFromExternalPost 

func (a *APIRepositoryApiService) ApirepoImportFromExternalPost(ctx _context.Context, organizationId string, connectorId string, name string, description string, api string) ([]ApiDefinition, *_nethttp.Response, error)

ApirepoImportFromExternalPost Create one or more backend APIs for an external service Create one or more backend APIs for an external service. External APIs are imported via a connector. If the connector configuration specifies that all external APIs should be merged into a single new backend API, the name and description parameters are applied to this new API. Alternatively, if the connector specifies that a separate backend API should be created for each external API, the name and description parameters are ignored, and the names and descriptions of the new backend APIs are taken from the external service definitions.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param organizationId The API development organization that owns the new APIs
  • @param connectorId The API connector through which new APIs should be created
  • @param name The name of the merged API (see description)
  • @param description A description of the merged API (see description)
  • @param api List of external APIs to be imported

@return []ApiDefinition

func (*APIRepositoryApiService) ApirepoImportFromGwPost 

func (a *APIRepositoryApiService) ApirepoImportFromGwPost(ctx _context.Context, id string, name string, organizationId string, localVarOptionals *ApirepoImportFromGwPostOpts) (ApiDefinition, *_nethttp.Response, error)

ApirepoImportFromGwPost Create an API definition by importing a PolicyStudio-registered web service (REST or WSDL) hosted on the the API Gateway Imports an API definition from a Policy Studio REST or WSDL service hosted on the API Gateway. On import, a Swagger representation of the original API definition is retained, but the API is converted to an internal format for processing.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the PolicyStudio-registered service to import.
  • @param name The service name.
  • @param organizationId The API development organization ID that owns the import.
  • @param optional nil or *ApirepoImportFromGwPostOpts - Optional Parameters:
  • @param "Instance" (optional.String) -
  • @param "Host" (optional.String) -
  • @param "Port" (optional.String) -
  • @param "Username" (optional.String) -
  • @param "Password" (optional.String) -

@return ApiDefinition

func (*APIRepositoryApiService) ApirepoImportFromUrlPost 

func (a *APIRepositoryApiService) ApirepoImportFromUrlPost(ctx _context.Context, organizationId string, type_ string, url string, localVarOptionals *ApirepoImportFromUrlPostOpts) (ApiDefinition, *_nethttp.Response, error)

ApirepoImportFromUrlPost Create an API by loading a file from URL. Imports an API definition from a valid standard Swagger or WADL definition from the specified __url__. It is possible to supply an optional __username__ and __password__ if the __url__ requires HTTP Basic authentication. On import, the original API definition is retained, but the API is converted to an internal format for processing. The API name currently defaults to the filename but this will be deprecated in a future release. The name parameter should be used to name the API and will be required in a future release.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param organizationId The API development organization ID that owns the import.
  • @param type_ The type of import, one of: swagger, wadl, raml.
  • @param url The URL to import.
  • @param optional nil or *ApirepoImportFromUrlPostOpts - Optional Parameters:
  • @param "Name" (optional.String) - The name of the API.
  • @param "FileName" (optional.String) - The file name of the import.
  • @param "Username" (optional.String) - HTTP Basic username to use for connection.
  • @param "Password" (optional.String) - HTTP Basic password to use for connection.

@return ApiDefinition

func (*APIRepositoryApiService) ApirepoImportPost 

func (a *APIRepositoryApiService) ApirepoImportPost(ctx _context.Context, organizationId string, name string, type_ string, file *os.File) (ApiDefinition, *_nethttp.Response, error)

ApirepoImportPost Create an API by uploading a file Imports an API definition from a valid standard Swagger or WADL definition. On import, the original API definition is retained, but the API is converted to an internal format for processing.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param organizationId The API development organization ID that owns the import.
  • @param name The API name.
  • @param type_ The type of import, one of: swagger, wadl, raml
  • @param file The API definition file to import

@return ApiDefinition

func (*APIRepositoryApiService) ApirepoPost 

func (a *APIRepositoryApiService) ApirepoPost(ctx _context.Context, api ApiDefinition) (ApiDefinition, *_nethttp.Response, error)

ApirepoPost Create an API definition When creating an API, the __name__ and __basePath__ are required.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param api The API resource to create.

@return ApiDefinition

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AlertConfig 

type AlertConfig struct {
	RunSysquotaExceeded    bool `json:"runSysquotaExceeded,omitempty"`
	RunSysquotaWarning     bool `json:"runSysquotaWarning,omitempty"`
	RunAppquotaExceeded    bool `json:"runAppquotaExceeded,omitempty"`
	RunAppquotaWarning     bool `json:"runAppquotaWarning,omitempty"`
	QuotaOverrideChanged   bool `json:"quotaOverrideChanged,omitempty"`
	QuotaOverrideDeleted   bool `json:"quotaOverrideDeleted,omitempty"`
	QuotaDefaultChanged    bool `json:"quotaDefaultChanged,omitempty"`
	QuotaSystemChanged     bool `json:"quotaSystemChanged,omitempty"`
	OrganizationCreate     bool `json:"organizationCreate,omitempty"`
	OrganizationDelete     bool `json:"organizationDelete,omitempty"`
	OrganizationEnable     bool `json:"organizationEnable,omitempty"`
	OrganizationDisable    bool `json:"organizationDisable,omitempty"`
	OrganizationAddapi     bool `json:"organizationAddapi,omitempty"`
	OrganizationRemoveapi  bool `json:"organizationRemoveapi,omitempty"`
	OrganizationEnableapi  bool `json:"organizationEnableapi,omitempty"`
	OrganizationDisableapi bool `json:"organizationDisableapi,omitempty"`
	AppdevRegister         bool `json:"appdevRegister,omitempty"`
	AppdevApprove          bool `json:"appdevApprove,omitempty"`
	AppdevDelete           bool `json:"appdevDelete,omitempty"`
	AppdevEnable           bool `json:"appdevEnable,omitempty"`
	AppdevDisable          bool `json:"appdevDisable,omitempty"`
	AppdevResetpwd         bool `json:"appdevResetpwd,omitempty"`
	ApplicationRegister    bool `json:"applicationRegister,omitempty"`
	ApplicationApprove     bool `json:"applicationApprove,omitempty"`
	ApplicationDelete      bool `json:"applicationDelete,omitempty"`
	ApplicationEnable      bool `json:"applicationEnable,omitempty"`
	ApplicationDisable     bool `json:"applicationDisable,omitempty"`
	ApplicationRequestapi  bool `json:"applicationRequestapi,omitempty"`
	ApplicationApproveapi  bool `json:"applicationApproveapi,omitempty"`
	ApplicationRemoveapi   bool `json:"applicationRemoveapi,omitempty"`
	ApplicationEnableapi   bool `json:"applicationEnableapi,omitempty"`
	ApplicationDisableapi  bool `json:"applicationDisableapi,omitempty"`
	ApicatalogEnable       bool `json:"apicatalogEnable,omitempty"`
	ApicatalogDisable      bool `json:"apicatalogDisable,omitempty"`
	ApiproxyPublish        bool `json:"apiproxyPublish,omitempty"`
	ApiproxyDeprecate      bool `json:"apiproxyDeprecate,omitempty"`
	ApiproxyUndeprecate    bool `json:"apiproxyUndeprecate,omitempty"`
	ApiproxyRetire         bool `json:"apiproxyRetire,omitempty"`
	ApiproxyUnpublish      bool `json:"apiproxyUnpublish,omitempty"`
	// Specifies whether or not an alert will be generated when an application credential is created
	ApplicationcredentialsCreate bool `json:"applicationcredentialsCreate,omitempty"`
	// Specifies whether or not an alert will be generated when an application credential is updated
	ApplicationcredentialsUpdate bool `json:"applicationcredentialsUpdate,omitempty"`
	// Specifies whether or not an alert will be generated when an application credential is deleted
	ApplicationcredentialsDelete bool `json:"applicationcredentialsDelete,omitempty"`
	// Specifies whether or not an alert will be generated when an application credential is enabled
	ApplicationcredentialsEnable bool `json:"applicationcredentialsEnable,omitempty"`
	// Specifies whether or not an alert will be generated when an application credential is disabled
	ApplicationcredentialsDisable bool `json:"applicationcredentialsDisable,omitempty"`
}

AlertConfig API alert system configuration

type AlertsPostOpts 

type AlertsPostOpts struct {
	Body optional.Interface
}

AlertsPostOpts Optional parameters for the method 'AlertsPost'

type Api 

type Api struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example       map[string]interface{} `json:"example,omitempty"`
	Discriminator string                 `json:"discriminator,omitempty"`
	// The API path
	Path string `json:"path,omitempty"`
	// The name of the REST API Method. This contains the exposed path.
	Name string `json:"name,omitempty"`
	// The list of operations that can be performed on *path*
	Operations []Operation `json:"operations,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The type ex: array , boolean, integer , null , number, object, string
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

Api The API is a path and operations.

type ApiAccess 

type ApiAccess struct {
	// Unique identifier for approval decisions (includes pending approvals)
	Id string `json:"id,omitempty"`
	// Virtualised REST API unique id
	ApiId string `json:"apiId,omitempty"`
	// The unique identifier for user that requested access
	CreatedBy string `json:"createdBy,omitempty"`
	// Pending or approved state
	State string `json:"state,omitempty"`
	// Epoch/Unix time stamp when the approval decision was created
	CreatedOn int64 `json:"createdOn,omitempty"`
	// Flag disables access to an API for organization or application
	Enabled bool `json:"enabled,omitempty"`
}

ApiAccess API Access indicates whether access to an API is available

type ApiDefinition 

type ApiDefinition struct {
	// A unique identifier.
	Id string `json:"id,omitempty"`
	// The name of the API.
	Name string `json:"name,omitempty"`
	// A summary of the API.
	Summary string `json:"summary,omitempty"`
	// A detailed description of the API.
	Description string `json:"description,omitempty"`
	// The API version.
	Version string `json:"version,omitempty"`
	// The base path is where the API service is hosted.
	BasePath string `json:"basePath,omitempty"`
	// The resource path is applied to **basePath** to provide the prefix for all API methods.
	ResourcePath string `json:"resourcePath,omitempty"`
	// The models/schema the that the API
	Models map[string]map[string]interface{} `json:"models,omitempty"`
	// The content types that the API consumes
	Consumes []string `json:"consumes,omitempty"`
	// The content types that the API produces
	Produces []string `json:"produces,omitempty"`
	// Indicates that the API definition is integral to a frontend API; that the API was imported to define the frontend API.
	Integral bool `json:"integral,omitempty"`
	// Epoch/Unix time stamp when the organization was created.
	CreatedOn int64 `json:"createdOn,omitempty"`
	// The identifier of the user that created the API.
	CreatedBy string `json:"createdBy,omitempty"`
	// The [Organization](Organization.html) identifier.
	OrganizationId string `json:"organizationId,omitempty"`
	// Indicates the type of service being imported. Possible values: rest, wsdl.
	ServiceType string `json:"serviceType,omitempty"`
	// Indicates whether or not an original definition is available
	HasOriginalDefinition bool `json:"hasOriginalDefinition,omitempty"`
	// Specifies the URL used to import the backend API definition.
	ImportUrl string `json:"importUrl,omitempty"`
	// A list of properties associated with this API.
	Properties map[string]string `json:"properties,omitempty"`
}

ApiDefinition An API definition.

type ApiKey 

type ApiKey struct {
	// The ID which is used to identify the API Key. You include it in each request, so it's not a secret.
	Id string `json:"id,omitempty"`
	// The ID which is used to identify an application. You include it in each request, so it's not a secret.
	ApplicationId string `json:"applicationId,omitempty"`
	// Each  API Key ID has a Secret Key associated with it. This key is just a long string of characters that can be used to calculate the digital signature that can be included in requests. Your Secret Key is a secret do not distribute.
	Secret string `json:"secret,omitempty"`
	// Flag disables the API key so can't be used in authentication
	Enabled bool `json:"enabled,omitempty"`
	// The unique identifier for user that generated the API Key
	CreatedBy string `json:"createdBy,omitempty"`
	// Epoch/Unix time stamp when the API key was created
	CreatedOn int64 `json:"createdOn,omitempty"`
	// Epoch/Unix time stamp when the API key was deleted
	DeletedOn int64 `json:"deletedOn,omitempty"`
	// The domains to allow access for browser-based clients
	CorsOrigins []string `json:"corsOrigins,omitempty"`
}

ApiKey API Manager API Key for use in authenticating applications

type ApiPromotion 

type ApiPromotion struct {
	Frontend FrontendExport `json:"frontend,omitempty"`
	Backend  BackendExport  `json:"backend,omitempty"`
	// Export version
	ExportVersion int32 `json:"exportVersion,omitempty"`
}

ApiPromotion API promotion package.

type ApirepoGetOpts 

type ApirepoGetOpts struct {
	Filename optional.String
	Field    optional.Interface
	Op       optional.Interface
	Value    optional.Interface
}

ApirepoGetOpts Optional parameters for the method 'ApirepoGet'

type ApirepoIdMethodsGetOpts 

type ApirepoIdMethodsGetOpts struct {
	Field optional.Interface
	Op    optional.Interface
	Value optional.Interface
}

ApirepoIdMethodsGetOpts Optional parameters for the method 'ApirepoIdMethodsGet'

type ApirepoIdPutOpts 

type ApirepoIdPutOpts struct {
	Body optional.Interface
}

ApirepoIdPutOpts Optional parameters for the method 'ApirepoIdPut'

type ApirepoImportFromGwPostOpts 

type ApirepoImportFromGwPostOpts struct {
	Instance optional.String
	Host     optional.String
	Port     optional.String
	Username optional.String
	Password optional.String
}

ApirepoImportFromGwPostOpts Optional parameters for the method 'ApirepoImportFromGwPost'

type ApirepoImportFromUrlPostOpts 

type ApirepoImportFromUrlPostOpts struct {
	Name     optional.String
	FileName optional.String
	Username optional.String
	Password optional.String
}

ApirepoImportFromUrlPostOpts Optional parameters for the method 'ApirepoImportFromUrlPost'

type Application 

type Application struct {
	// The unique identifier for the application
	Id string `json:"id,omitempty"`
	// The display name for the application
	Name string `json:"name"`
	// Descriptive text for the application
	Description string `json:"description,omitempty"`
	// The organization identifier to which the application belongs
	OrganizationId string `json:"organizationId"`
	// Contact phone number of the application
	Phone string `json:"phone,omitempty"`
	// The contact email address associated with the application
	Email string `json:"email,omitempty"`
	// The unique identifier for user that created the application
	CreatedBy string `json:"createdBy,omitempty"`
	// A list of unique identifier for users that manages the application
	ManagedBy []string `json:"managedBy,omitempty"`
	// Epoch/Unix time stamp when the application was created
	CreatedOn int64 `json:"createdOn,omitempty"`
	// Flag to indicate if this application is enabled or not
	Enabled bool `json:"enabled,omitempty"`
	// URI of the image to be used for this application, this field only indicates that the application has an image assigned to it. In order to retrieve the actual image use the following URL /api/portal/applications/{id}/image/
	Image string `json:"image,omitempty"`
	// Flag to indicate if an application has been approved by the API Manager admin or if delegated then the org admin
	State string `json:"state,omitempty"`
}

Application API Manager application.

type ApplicationRequest 

type ApplicationRequest struct {
	// The unique identifier for the application request
	Id string `json:"id,omitempty"`
	// The display name for the application
	Name string `json:"name,omitempty"`
	// Descriptive text for the application
	Description string `json:"description,omitempty"`
	// The organization identifier to which the application request belongs
	OrganizationId string `json:"organizationId,omitempty"`
	// Contact phone number of the application
	Phone string `json:"phone,omitempty"`
	// The contact email address associated with the application
	Email string `json:"email,omitempty"`
	// URI of the image to be used for this application, this field only indicates that the application has an image assigned to it. In order to retrieve the actual image use the following URL /api/portal/organizations/{uid of org}/image/
	Image string `json:"image,omitempty"`
	// A list of unqiue API identifiers to which the application wants to use.
	Apis []string `json:"apis"`
}

ApplicationRequest API Manager application request.

type ApplicationsApiService 

type ApplicationsApiService service

ApplicationsApiService ApplicationsApi service

func (*ApplicationsApiService) ApplicationsGet 

func (a *ApplicationsApiService) ApplicationsGet(ctx _context.Context, localVarOptionals *ApplicationsGetOpts) ([]Application, *_nethttp.Response, error)

ApplicationsGet Get the list of applications Get the list of applications that are visible to the authenticated user. The list of applications can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of: apiid : Matches the application if the application is using the API, specified by ID userid : Matches the application if the user has explicit access to the application, specified by ID description : The application's description email : The application's contact email address enabled : The enabled state of the application, one of: enabled, disabled createdOn : The date the application was created on, time in ms, e.g.: 1372755998542 name : The name of the application orgid : Matches the application if the application is part of the organization, specified by ID phone : The application's contact phone state : The application's current state, one of: approved, pending The __op__ is an operation and is one of: eq : Equal ne : Not equal gt : Greater than lt : Less than ge : Greater than or equal le : Less than or equal like : Like gete : Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10 The __value__ will be compared against the __field__, according to the supplied __op__.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ApplicationsGetOpts - Optional Parameters:
  • @param "Field" (optional.Interface of []string) - Filter field name.
  • @param "Op" (optional.Interface of []string) - Filter operation.
  • @param "Value" (optional.Interface of []string) - Filter value

@return []Application

func (*ApplicationsApiService) ApplicationsIdApikeysApikeyidPut 

func (a *ApplicationsApiService) ApplicationsIdApikeysApikeyidPut(ctx _context.Context, id string, apikeyid string, localVarOptionals *ApplicationsIdApikeysApikeyidPutOpts) (ApiKey, *_nethttp.Response, error)

ApplicationsIdApikeysApikeyidPut Updates an API Key Updates the secret, enabled and Cors origin field. The fields __id__, __createdBy__, __createdOn__ are read only.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose API Key is to be updated.
  • @param apikeyid The ID of the API Key to be updated.
  • @param optional nil or *ApplicationsIdApikeysApikeyidPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of ApiKey) -

@return ApiKey

func (*ApplicationsApiService) ApplicationsIdApikeysGet 

func (a *ApplicationsApiService) ApplicationsIdApikeysGet(ctx _context.Context, id string) ([]ApiKey, *_nethttp.Response, error)

ApplicationsIdApikeysGet Returns the API Keys associated with an application Returns the API Keys associated with an application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose API Keys are to be returned.

@return []ApiKey

func (*ApplicationsApiService) ApplicationsIdApikeysKeyIdDelete 

func (a *ApplicationsApiService) ApplicationsIdApikeysKeyIdDelete(ctx _context.Context, id string, keyId string) (*_nethttp.Response, error)

ApplicationsIdApikeysKeyIdDelete Delete an API Key Deletes an API Key. Deleting an API key means that it will no longer be accepted for application authentication.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The API Key ID to be deleted.
  • @param keyId

func (*ApplicationsApiService) ApplicationsIdApikeysPost 

func (a *ApplicationsApiService) ApplicationsIdApikeysPost(ctx _context.Context, id string, localVarOptionals *ApplicationsIdApikeysPostOpts) (ApiKey, *_nethttp.Response, error)

ApplicationsIdApikeysPost Creates a new API Key and secret for the application Creates a new API Key and secret for the application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application requiring an API Key.
  • @param optional nil or *ApplicationsIdApikeysPostOpts - Optional Parameters:
  • @param "ApiKey" (optional.Interface of ApiKey) - The APIKey to create

@return ApiKey

func (*ApplicationsApiService) ApplicationsIdApisApiAccessIdApprovePost 

func (a *ApplicationsApiService) ApplicationsIdApisApiAccessIdApprovePost(ctx _context.Context, id string, apiAccessId string) (*_nethttp.Response, error)

ApplicationsIdApisApiAccessIdApprovePost Creates an API access request to an API for an application. Approving user must be API Manager Administrator or an Organization Administrator of the application's organization with the correct privileges to approve API access requests.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The application ID.
  • @param apiAccessId The API access ID.

func (*ApplicationsApiService) ApplicationsIdApisApiAccessIdDelete 

func (a *ApplicationsApiService) ApplicationsIdApisApiAccessIdDelete(ctx _context.Context, id string, apiAccessId string) (ApiAccess, *_nethttp.Response, error)

ApplicationsIdApisApiAccessIdDelete Deletes access to an API for an application Permanently deletes access to an API for an application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The application ID.
  • @param apiAccessId The API access ID.

@return ApiAccess

func (*ApplicationsApiService) ApplicationsIdApisApiAccessIdPut 

func (a *ApplicationsApiService) ApplicationsIdApisApiAccessIdPut(ctx _context.Context, id string, apiAccessId string, localVarOptionals *ApplicationsIdApisApiAccessIdPutOpts) (ApiAccess, *_nethttp.Response, error)

ApplicationsIdApisApiAccessIdPut Updates access to an API for an application Updates access to an API for an application. Only __enabled__ may be modified.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The application ID.
  • @param apiAccessId The API access ID.
  • @param optional nil or *ApplicationsIdApisApiAccessIdPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of ApiAccess) -

@return ApiAccess

func (*ApplicationsApiService) ApplicationsIdApisGet 

func (a *ApplicationsApiService) ApplicationsIdApisGet(ctx _context.Context, id string) ([]ApiAccess, *_nethttp.Response, error)

ApplicationsIdApisGet Get the list of APIs that the application can access Get the list of APIs that the application can access.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The application ID.

@return []ApiAccess

func (*ApplicationsApiService) ApplicationsIdApisPost 

func (a *ApplicationsApiService) ApplicationsIdApisPost(ctx _context.Context, id string, localVarOptionals *ApplicationsIdApisPostOpts) (ApiAccess, *_nethttp.Response, error)

ApplicationsIdApisPost Create a request for an application to access an API. Only API Manager Administrator, or an Organization Administrator of the application's organization with the correct privileges, or the application manager may create API access requests.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The application ID.
  • @param optional nil or *ApplicationsIdApisPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of ApiAccess) -

@return ApiAccess

func (*ApplicationsApiService) ApplicationsIdApprovePost 

func (a *ApplicationsApiService) ApplicationsIdApprovePost(ctx _context.Context, id string) (*_nethttp.Response, error)

ApplicationsIdApprovePost Approves a pending application request Approving user must be API Manager Administrator or an Organization Administrator of the application's organization with the correct privileges to approve new application requests.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The application request ID.

func (*ApplicationsApiService) ApplicationsIdAvailablescopesGet 

func (a *ApplicationsApiService) ApplicationsIdAvailablescopesGet(ctx _context.Context, id string, localVarOptionals *ApplicationsIdAvailablescopesGetOpts) ([][]map[string]interface{}, *_nethttp.Response, error)

ApplicationsIdAvailablescopesGet Returns the scopes available to an application Returns the OAuth scopes available to an application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose OAuth scopes are to be returned.
  • @param optional nil or *ApplicationsIdAvailablescopesGetOpts - Optional Parameters:
  • @param "ApiScope" (optional.Bool) -

@return [][]map[string]interface{}

func (*ApplicationsApiService) ApplicationsIdDelete 

func (a *ApplicationsApiService) ApplicationsIdDelete(ctx _context.Context, id string) (*_nethttp.Response, error)

ApplicationsIdDelete Delete an application Only managers of the application, API Manager Administrators, or Organization Administrators with enabled delegated application management privileges, may delete applications.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application to delete.

func (*ApplicationsApiService) ApplicationsIdExtclientsGet 

func (a *ApplicationsApiService) ApplicationsIdExtclientsGet(ctx _context.Context, id string) ([]ExternalClient, *_nethttp.Response, error)

ApplicationsIdExtclientsGet Returns the external clients associated with an application Returns the external clients associated with an application. External clients are used when authenticating the application through a 3rd party OAuth service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose external clients are to be returned.

@return []ExternalClient

func (*ApplicationsApiService) ApplicationsIdExtclientsObjectIdDelete 

func (a *ApplicationsApiService) ApplicationsIdExtclientsObjectIdDelete(ctx _context.Context, id string, objectId string) (*_nethttp.Response, error)

ApplicationsIdExtclientsObjectIdDelete Delete an external client Deletes an external client. Deleting a mapping means that it will no longer be accepted for application authentication.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose external client is to be deleted.
  • @param objectId The ID of the external client entry to be deleted.

func (*ApplicationsApiService) ApplicationsIdExtclientsObjectIdPut 

func (a *ApplicationsApiService) ApplicationsIdExtclientsObjectIdPut(ctx _context.Context, id string, objectId string, localVarOptionals *ApplicationsIdExtclientsObjectIdPutOpts) (ExternalClient, *_nethttp.Response, error)

ApplicationsIdExtclientsObjectIdPut Updates an external client for the application Updates an external client for the application. External clients are used when authenticating the application through a 3rd party OAuth service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose external client is to be updated.
  • @param objectId The external client entry to be updated.
  • @param optional nil or *ApplicationsIdExtclientsObjectIdPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of ExternalClient) -

@return ExternalClient

func (*ApplicationsApiService) ApplicationsIdExtclientsPost 

func (a *ApplicationsApiService) ApplicationsIdExtclientsPost(ctx _context.Context, id string, localVarOptionals *ApplicationsIdExtclientsPostOpts) (ExternalClient, *_nethttp.Response, error)

ApplicationsIdExtclientsPost Maps a new external client to the application Maps a new external client to the application. External clients are used when authenticating the application through a 3rd party OAuth service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application to map to an external client.
  • @param optional nil or *ApplicationsIdExtclientsPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of ExternalClient) -

@return ExternalClient

func (*ApplicationsApiService) ApplicationsIdGet 

func (a *ApplicationsApiService) ApplicationsIdGet(ctx _context.Context, id string) (Application, *_nethttp.Response, error)

ApplicationsIdGet Get an application Retrieves the details of an application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the application to be returned.

@return Application

func (*ApplicationsApiService) ApplicationsIdImageGet 

func (a *ApplicationsApiService) ApplicationsIdImageGet(ctx _context.Context, id string) (*_nethttp.Response, error)

ApplicationsIdImageGet Get the image for an application Get the JPEG image associated with an application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the application whose image is to be return

func (*ApplicationsApiService) ApplicationsIdImagePost 

func (a *ApplicationsApiService) ApplicationsIdImagePost(ctx _context.Context, id string, file *os.File, localVarOptionals *ApplicationsIdImagePostOpts) (*_nethttp.Response, error)

ApplicationsIdImagePost Adds a JPEG image to an application Adds a JPEG image to an application with a MultiPart POST

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the application whose image is being added
  • @param file The file uploaded in the POST body as an element in a multipart post
  • @param optional nil or *ApplicationsIdImagePostOpts - Optional Parameters:
  • @param "Type_" (optional.String) -

func (*ApplicationsApiService) ApplicationsIdOauthClientIdPut 

func (a *ApplicationsApiService) ApplicationsIdOauthClientIdPut(ctx _context.Context, id string, clientId string, localVarOptionals *ApplicationsIdOauthClientIdPutOpts) (OAuthClient, *_nethttp.Response, error)

ApplicationsIdOauthClientIdPut Updates an OAuth Credential for the application Updates an OAuth Credential for the application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose OAuth credential is to be updated.
  • @param clientId The OAuth Credential ID to be updated.
  • @param optional nil or *ApplicationsIdOauthClientIdPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of OAuthClient) -

@return OAuthClient

func (*ApplicationsApiService) ApplicationsIdOauthClientidNewsecretPut 

func (a *ApplicationsApiService) ApplicationsIdOauthClientidNewsecretPut(ctx _context.Context, id string, clientid string) (OAuthClient, *_nethttp.Response, error)

ApplicationsIdOauthClientidNewsecretPut Updates an OAuth Credential for an application by generating a new secret Updates an OAuth Credential for an application by generating a new client secret.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose OAuth credential is to be updated with a new secret
  • @param clientid The OAuth Credential ID to be updated with a new secret

@return OAuthClient

func (*ApplicationsApiService) ApplicationsIdOauthGet 

func (a *ApplicationsApiService) ApplicationsIdOauthGet(ctx _context.Context, id string) ([]OAuthClient, *_nethttp.Response, error)

ApplicationsIdOauthGet Returns the OAuth Credentials associated with an application Returns the OAuth Credentials associated with an application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose OAuth Credentials are to be returned.

@return []OAuthClient

func (*ApplicationsApiService) ApplicationsIdOauthOauthIdDelete 

func (a *ApplicationsApiService) ApplicationsIdOauthOauthIdDelete(ctx _context.Context, id string, oauthId string) (*_nethttp.Response, error)

ApplicationsIdOauthOauthIdDelete Delete an OAuth client ID and secret Deletes an OAuth client ID and secret. Deleting an OAuth client ID and secret means that it will no longer be accepted for OAuth application authentication.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose OAuth Credential is to be deleted.
  • @param oauthId The OAuth Client ID to be deleted.

func (*ApplicationsApiService) ApplicationsIdOauthPost 

func (a *ApplicationsApiService) ApplicationsIdOauthPost(ctx _context.Context, id string, body OAuthClient) (OAuthClient, *_nethttp.Response, error)

ApplicationsIdOauthPost Creates a new OAuth client ID and secret for the application Creates a new OAuth client ID and secret for the application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application requiring an OAuth client ID and secret.
  • @param body The OAuth credential to create

@return OAuthClient

func (*ApplicationsApiService) ApplicationsIdOauthresourceGet 

func (a *ApplicationsApiService) ApplicationsIdOauthresourceGet(ctx _context.Context, id string) ([]OAuthResource, *_nethttp.Response, error)

ApplicationsIdOauthresourceGet Returns the OAuth protected resources (scopes) associated with an application Returns the OAuth protected resources (scopes) associated with an application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose OAuth protected resources (Scopes) are to be returned.

@return []OAuthResource

func (*ApplicationsApiService) ApplicationsIdOauthresourcePost 

func (a *ApplicationsApiService) ApplicationsIdOauthresourcePost(ctx _context.Context, id string, body OAuthResource) (OAuthResource, *_nethttp.Response, error)

ApplicationsIdOauthresourcePost Adds an OAuth protected resource to an application An application must define which OAuth Protected resources it wants to access. These resources will define the scope of the application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application requiring an OAuth protected resource.
  • @param body The OAuth protected resource to add to the application

@return OAuthResource

func (*ApplicationsApiService) ApplicationsIdOauthresourceResourceIdDelete 

func (a *ApplicationsApiService) ApplicationsIdOauthresourceResourceIdDelete(ctx _context.Context, id string, resourceId string) (*_nethttp.Response, error)

ApplicationsIdOauthresourceResourceIdDelete Remove an OAuth protected resource from an application Removes the association between an application and an OAuth protected resource on the API Server. The application will no longer have the scope associated with the resource. Tokens issued prior to the removal will still be scoped for the resource.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose protected resource is to be removed.
  • @param resourceId The uri of the OAuth protected resource to be disassociated from the application.

func (*ApplicationsApiService) ApplicationsIdOauthresourceResourceIdPut 

func (a *ApplicationsApiService) ApplicationsIdOauthresourceResourceIdPut(ctx _context.Context, id string, resourceId string, body OAuthResource) (OAuthResource, *_nethttp.Response, error)

ApplicationsIdOauthresourceResourceIdPut Updates a protected resource associate with an application, sets enabled to true/false An OAuth Protected resource associated with an application can be enabled or disabled with this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application requiring an updated OAuth protected resource.
  • @param resourceId The ID of the OAuth protected resource to update
  • @param body The updated OAuth protected resource

@return OAuthResource

func (*ApplicationsApiService) ApplicationsIdPermissionsGet 

func (a *ApplicationsApiService) ApplicationsIdPermissionsGet(ctx _context.Context, id string) ([]PermissionDto, *_nethttp.Response, error)

ApplicationsIdPermissionsGet Get the list of permissions. Get the access-control list (ACL) for the application. Callers with view-only privilege can only access their own permission.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The application ID.

@return []PermissionDto

func (*ApplicationsApiService) ApplicationsIdPermissionsPermIdDelete 

func (a *ApplicationsApiService) ApplicationsIdPermissionsPermIdDelete(ctx _context.Context, id string, permId string) (*_nethttp.Response, error)

ApplicationsIdPermissionsPermIdDelete Remove a permission Remove an existing access-control entry from the application's ACL. Management privilege required.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The application ID.
  • @param permId The permission ID.

func (*ApplicationsApiService) ApplicationsIdPermissionsPermIdPut 

func (a *ApplicationsApiService) ApplicationsIdPermissionsPermIdPut(ctx _context.Context, id string, permId string, localVarOptionals *ApplicationsIdPermissionsPermIdPutOpts) (PermissionDto, *_nethttp.Response, error)

ApplicationsIdPermissionsPermIdPut Modify a permission Modify an existing access-control entry from the application's ACL. Management privilege required.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The application ID.
  • @param permId The permission ID.
  • @param optional nil or *ApplicationsIdPermissionsPermIdPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of PermissionDto) -

@return PermissionDto

func (*ApplicationsApiService) ApplicationsIdPermissionsPost 

func (a *ApplicationsApiService) ApplicationsIdPermissionsPost(ctx _context.Context, id string, localVarOptionals *ApplicationsIdPermissionsPostOpts) (PermissionDto, *_nethttp.Response, error)

ApplicationsIdPermissionsPost Create a new permission. Add a new access-control entry to the application's ACL. Management privilege required.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The application ID.
  • @param optional nil or *ApplicationsIdPermissionsPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of PermissionDto) -

@return PermissionDto

func (*ApplicationsApiService) ApplicationsIdPut 

func (a *ApplicationsApiService) ApplicationsIdPut(ctx _context.Context, id string, localVarOptionals *ApplicationsIdPutOpts) (Application, *_nethttp.Response, error)

ApplicationsIdPut Update an application Only managers of the application, API Manager Administrators, or Organization Administrators with enabled delegated application management privileges, may update an application. Note, if a field is omitted from the payload, or its value is set to null, the existing value for this field will be retained.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the application to be updated
  • @param optional nil or *ApplicationsIdPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of Application) -

@return Application

func (*ApplicationsApiService) ApplicationsIdQuotaDelete 

func (a *ApplicationsApiService) ApplicationsIdQuotaDelete(ctx _context.Context, id string) (*_nethttp.Response, error)

ApplicationsIdQuotaDelete Deletes a quota from an application Deletes a quota from an application

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application who's quota constraint is to be deleted.

func (*ApplicationsApiService) ApplicationsIdQuotaGet 

func (a *ApplicationsApiService) ApplicationsIdQuotaGet(ctx _context.Context, id string) ([]QuotaDto, *_nethttp.Response, error)

ApplicationsIdQuotaGet Returns the quota associated with an application. Returns the quota associated with an application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application who's quota constraints are to be returned.

@return []QuotaDto

func (*ApplicationsApiService) ApplicationsIdQuotaPost 

func (a *ApplicationsApiService) ApplicationsIdQuotaPost(ctx _context.Context, id string, localVarOptionals *ApplicationsIdQuotaPostOpts) (QuotaDto, *_nethttp.Response, error)

ApplicationsIdQuotaPost Creates a new quota constraint for the application Creates a new quota constraint for the application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application for the quota contraint.
  • @param optional nil or *ApplicationsIdQuotaPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of QuotaDto) -

@return QuotaDto

func (*ApplicationsApiService) ApplicationsIdQuotaPut 

func (a *ApplicationsApiService) ApplicationsIdQuotaPut(ctx _context.Context, id string, localVarOptionals *ApplicationsIdQuotaPutOpts) (QuotaDto, *_nethttp.Response, error)

ApplicationsIdQuotaPut Updates a quota contraint for an application Updates a quota contraint for the given application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application who's quota is to be updated.
  • @param optional nil or *ApplicationsIdQuotaPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of QuotaDto) -

@return QuotaDto

func (*ApplicationsApiService) ApplicationsIdScopeGet 

func (a *ApplicationsApiService) ApplicationsIdScopeGet(ctx _context.Context, id string) ([][]map[string]interface{}, *_nethttp.Response, error)

ApplicationsIdScopeGet Returns the scopes associated with an application Returns the OAuth scopes associated with an application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose OAuth protected resources (Scopes) are to be returned.

@return [][]map[string]interface{}

func (*ApplicationsApiService) ApplicationsIdScopePost 

func (a *ApplicationsApiService) ApplicationsIdScopePost(ctx _context.Context, id string, body OAuthAppScope) (OAuthAppScope, *_nethttp.Response, error)

ApplicationsIdScopePost Adds an OAuth protected resource to an application An application must define which scopes it wants to access. These define the scope of the application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application requiring an OAuth scope.
  • @param body The OAuth Scope to add to the application

@return OAuthAppScope

func (*ApplicationsApiService) ApplicationsIdScopeScopeIdDelete 

func (a *ApplicationsApiService) ApplicationsIdScopeScopeIdDelete(ctx _context.Context, id string, scopeId string) (*_nethttp.Response, error)

ApplicationsIdScopeScopeIdDelete Remove an OAuth protected resource from an application Removes the association between an application and an OAuth protected resource on the API Server. The application will no longer have the scope associated with the resource. Tokens issued prior to the removal will still be scoped for the resource.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application whose protected resource is to be removed.
  • @param scopeId The id of the Scope to be disassociated from the application.

func (*ApplicationsApiService) ApplicationsIdScopeScopeIdPut 

func (a *ApplicationsApiService) ApplicationsIdScopeScopeIdPut(ctx _context.Context, id string, scopeId string, body OAuthAppScope) (OAuthAppScope, *_nethttp.Response, error)

ApplicationsIdScopeScopeIdPut Updates a scope associated with an application, sets default to true/false An OAuth Scope associated with an application can be set or unset as a default scope with this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of application requiring an updated OAuth protected resource.
  • @param scopeId The ID of the Application Scope to update
  • @param body The updated OAuth protected resource

@return OAuthAppScope

func (*ApplicationsApiService) ApplicationsOauthclientClientIdGet 

func (a *ApplicationsApiService) ApplicationsOauthclientClientIdGet(ctx _context.Context, clientId string) (Application, *_nethttp.Response, error)

ApplicationsOauthclientClientIdGet Get an application associated with an OAuth Client ID Retrieves the application associated with an OAuth Client ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param clientId The OAuth Client ID associated with the Application.

@return Application

func (*ApplicationsApiService) ApplicationsPost 

func (a *ApplicationsApiService) ApplicationsPost(ctx _context.Context, localVarOptionals *ApplicationsPostOpts) (Application, *_nethttp.Response, error)

ApplicationsPost Creates a new application. Creates a new application. New applications may need to be approved using [/approve](#APIApplicationsapproveApp).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ApplicationsPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of ApplicationRequest) -

@return Application

type ApplicationsGetOpts 

type ApplicationsGetOpts struct {
	Field optional.Interface
	Op    optional.Interface
	Value optional.Interface
}

ApplicationsGetOpts Optional parameters for the method 'ApplicationsGet'

type ApplicationsIdApikeysApikeyidPutOpts 

type ApplicationsIdApikeysApikeyidPutOpts struct {
	Body optional.Interface
}

ApplicationsIdApikeysApikeyidPutOpts Optional parameters for the method 'ApplicationsIdApikeysApikeyidPut'

type ApplicationsIdApikeysPostOpts 

type ApplicationsIdApikeysPostOpts struct {
	ApiKey optional.Interface
}

ApplicationsIdApikeysPostOpts Optional parameters for the method 'ApplicationsIdApikeysPost'

type ApplicationsIdApisApiAccessIdPutOpts 

type ApplicationsIdApisApiAccessIdPutOpts struct {
	Body optional.Interface
}

ApplicationsIdApisApiAccessIdPutOpts Optional parameters for the method 'ApplicationsIdApisApiAccessIdPut'

type ApplicationsIdApisPostOpts 

type ApplicationsIdApisPostOpts struct {
	Body optional.Interface
}

ApplicationsIdApisPostOpts Optional parameters for the method 'ApplicationsIdApisPost'

type ApplicationsIdAvailablescopesGetOpts 

type ApplicationsIdAvailablescopesGetOpts struct {
	ApiScope optional.Bool
}

ApplicationsIdAvailablescopesGetOpts Optional parameters for the method 'ApplicationsIdAvailablescopesGet'

type ApplicationsIdExtclientsObjectIdPutOpts 

type ApplicationsIdExtclientsObjectIdPutOpts struct {
	Body optional.Interface
}

ApplicationsIdExtclientsObjectIdPutOpts Optional parameters for the method 'ApplicationsIdExtclientsObjectIdPut'

type ApplicationsIdExtclientsPostOpts 

type ApplicationsIdExtclientsPostOpts struct {
	Body optional.Interface
}

ApplicationsIdExtclientsPostOpts Optional parameters for the method 'ApplicationsIdExtclientsPost'

type ApplicationsIdImagePostOpts 

type ApplicationsIdImagePostOpts struct {
	Type_ optional.String
}

ApplicationsIdImagePostOpts Optional parameters for the method 'ApplicationsIdImagePost'

type ApplicationsIdOauthClientIdPutOpts 

type ApplicationsIdOauthClientIdPutOpts struct {
	Body optional.Interface
}

ApplicationsIdOauthClientIdPutOpts Optional parameters for the method 'ApplicationsIdOauthClientIdPut'

type ApplicationsIdPermissionsPermIdPutOpts 

type ApplicationsIdPermissionsPermIdPutOpts struct {
	Body optional.Interface
}

ApplicationsIdPermissionsPermIdPutOpts Optional parameters for the method 'ApplicationsIdPermissionsPermIdPut'

type ApplicationsIdPermissionsPostOpts 

type ApplicationsIdPermissionsPostOpts struct {
	Body optional.Interface
}

ApplicationsIdPermissionsPostOpts Optional parameters for the method 'ApplicationsIdPermissionsPost'

type ApplicationsIdPutOpts 

type ApplicationsIdPutOpts struct {
	Body optional.Interface
}

ApplicationsIdPutOpts Optional parameters for the method 'ApplicationsIdPut'

type ApplicationsIdQuotaPostOpts 

type ApplicationsIdQuotaPostOpts struct {
	Body optional.Interface
}

ApplicationsIdQuotaPostOpts Optional parameters for the method 'ApplicationsIdQuotaPost'

type ApplicationsIdQuotaPutOpts 

type ApplicationsIdQuotaPutOpts struct {
	Body optional.Interface
}

ApplicationsIdQuotaPutOpts Optional parameters for the method 'ApplicationsIdQuotaPut'

type ApplicationsPostOpts 

type ApplicationsPostOpts struct {
	Body optional.Interface
}

ApplicationsPostOpts Optional parameters for the method 'ApplicationsPost'

type AuthenticatedUserAttributes 

type AuthenticatedUserAttributes struct {
	FirstLogin bool   `json:"firstLogin,omitempty"`
	IsSSOLogin bool   `json:"isSSOLogin,omitempty"`
	UserDn     string `json:"userDn,omitempty"`
}

AuthenticatedUserAttributes struct for AuthenticatedUserAttributes

type AuthenticationProfile 

type AuthenticationProfile struct {
	// Unique name of the Profile
	Name string `json:"name,omitempty"`
	// Indicates that this is the default profile.  There can be only one default.
	IsDefault bool `json:"isDefault,omitempty"`
	// Parameters for the backend authentication profile
	Parameters map[string]interface{} `json:"parameters,omitempty"`
	// Type of backend authentication. Possible values: *none*, *http_basic*, *http_digest*, *apiKey*, *oauth*, and *ssl*.
	Type string `json:"type,omitempty"`
}

AuthenticationProfile Outbound authentication profile.

type Authorization 

type Authorization struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example       map[string]interface{} `json:"example,omitempty"`
	Discriminator string                 `json:"discriminator,omitempty"`
	// Denotes how the API key must be passed. Valid values are 'header' or 'query'.
	PassAs string `json:"passAs,omitempty"`
	// The name of the header or query parameter to be used when passing the API key.
	Keyname string `json:"keyname,omitempty"`
	// The list of OAuth scopes.
	Scopes     []Scope    `json:"scopes,omitempty"`
	GrantTypes GrantTypes `json:"grantTypes,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The authorization type.  One of: basicAuth, apiKey, oauth2, none
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

Authorization struct for Authorization

type AuthorizationCode 

type AuthorizationCode struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example              map[string]interface{} `json:"example,omitempty"`
	Discriminator        string                 `json:"discriminator,omitempty"`
	TokenRequestEndpoint TokenRequestEndpoint   `json:"tokenRequestEndpoint,omitempty"`
	TokenEndpoint        TokenEndpoint          `json:"tokenEndpoint,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The type ex: array , boolean, integer , null , number, object, string
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

AuthorizationCode struct for AuthorizationCode

type BackendBlob 

type BackendBlob struct {
	// Unique identifier
	Id string `json:"id,omitempty"`
	// Type of blob
	Type string `json:"type,omitempty"`
	// Base64 encoded API
	Blob string `json:"blob,omitempty"`
	// API name
	Name string `json:"name,omitempty"`
	// Original URL
	ImportURL string `json:"importURL,omitempty"`
}

BackendBlob Backend blob export definition.

type BackendExport 

type BackendExport struct {
	// List of backend API blobs
	ApiBlobs []BackendBlob `json:"apiBlobs,omitempty"`
}

BackendExport Backend API export definition.

type BackendMethodExport 

type BackendMethodExport struct {
	// Internal use only.
	ApiId string `json:"apiId,omitempty"`
	// Internal use only.
	ApiMethodId string `json:"apiMethodId,omitempty"`
	// Internal use only.
	Op string `json:"op,omitempty"`
}

BackendMethodExport Backend API method export.

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CaCert 

type CaCert struct {
	// Raw certificate data
	CertBlob string `json:"certBlob,omitempty"`
	// Name of the certificate
	Name string `json:"name,omitempty"`
	// Certificate alias
	Alias string `json:"alias,omitempty"`
	// Certificate subject
	Subject string `json:"subject,omitempty"`
	// Certificate issuer
	Issuer string `json:"issuer,omitempty"`
	// Version of the certificate
	Version int32 `json:"version,omitempty"`
	// Start date of the certificate
	NotValidBefore int64 `json:"notValidBefore,omitempty"`
	// Expiry date of the certificate
	NotValidAfter int64 `json:"notValidAfter,omitempty"`
	// The algorithm used to sign the certificate.
	SignatureAlgorithm string `json:"signatureAlgorithm,omitempty"`
	// SHA1 fingerprint.
	Sha1Fingerprint string `json:"sha1Fingerprint,omitempty"`
	// MD5 fingerprint.
	Md5Fingerprint string `json:"md5Fingerprint,omitempty"`
	// Flag indicating whether or not the certificate is expired.
	Expired bool `json:"expired,omitempty"`
	// Flag indicating whether or not the certificate is valid yet.
	NotYetValid bool `json:"notYetValid,omitempty"`
	// Flag indicating whether this certificate is used for inbound SSL connections when invoking the virtualized API.
	Inbound bool `json:"inbound,omitempty"`
	// Flag indicating whether this certificate is used for outbound SSL connections when invoking the virtualized API.
	Outbound bool `json:"outbound,omitempty"`
}

CaCert Trusted CA certificate

type CertinfoPostOpts 

type CertinfoPostOpts struct {
	Username   optional.String
	File       optional.Interface
	Passphrase optional.String
	Inbound    optional.Bool
	Outbound   optional.Bool
}

CertinfoPostOpts Optional parameters for the method 'CertinfoPost'

type Config 

type Config struct {
	// The name of the API Manager.
	PortalName string `json:"portalName,omitempty"`
	// The network hostname or IP Address of the API Manager which will be used in email links.
	PortalHostname string `json:"portalHostname,omitempty"`
	// The name of the API Portal
	ApiPortalName string `json:"apiPortalName,omitempty"`
	// The network hostname or IP Address of the API Portal which will be used in email links.
	ApiPortalHostname string `json:"apiPortalHostname,omitempty"`
	// Indicates if the API Portal is configured.
	IsApiPortalConfigured bool `json:"isApiPortalConfigured,omitempty"`
	// Enables/disables user registration for the API Manager
	RegistrationEnabled bool `json:"registrationEnabled,omitempty"`
	// Enables/disables spport for resetting user passwords for the API Manager
	ResetPasswordEnabled bool `json:"resetPasswordEnabled,omitempty"`
	// The minimum password length.
	MinimumPasswordLength int32 `json:"minimumPasswordLength,omitempty"`
	// Enables/disables auto-approve for user registration whereby API Administrator or Organization Administrator approval is not required.
	AutoApproveUserRegistration bool `json:"autoApproveUserRegistration,omitempty"`
	// Enables/disables the ability to add System scopes to an Application. These scopes represent Gateway OAuth resources that are not covered by APIs.
	SystemOAuthScopesEnabled bool `json:"systemOAuthScopesEnabled,omitempty"`
	// Enables/disables auto-application approval whereby users do not need API Administrator or Organization Administrator approval.
	AutoApproveApplications bool `json:"autoApproveApplications,omitempty"`
	// Enables/disables user administration to the Organization Administrators.
	DelegateUserAdministration bool `json:"delegateUserAdministration,omitempty"`
	// Enables/disables application administration to the Organization Administrators.
	DelegateApplicationAdministration bool `json:"delegateApplicationAdministration,omitempty"`
	// The network host and port that serves as the default virtual host from which API Manager registered API will be accessible through.
	ApiDefaultVirtualHost string `json:"apiDefaultVirtualHost,omitempty"`
	// Enable routing to APIs on the same base path.
	ApiRoutingKeyEnabled bool `json:"apiRoutingKeyEnabled,omitempty"`
	// An additional routing key is required to support multiple APIs registered on the same base path. This indicates where to look for the value.
	ApiRoutingKeyLocation string `json:"apiRoutingKeyLocation,omitempty"`
	// The 'from' address used in emails.
	EmailFrom string `json:"emailFrom,omitempty"`
	// An email address where undeliverable emails will be bounced to.
	EmailBounceAddress string `json:"emailBounceAddress,omitempty"`
	// Enables/disables API promotion via policy.
	PromoteApiViaPolicy bool `json:"promoteApiViaPolicy,omitempty"`
	// Enables/disables Global policies.
	GlobalPoliciesEnabled bool `json:"globalPoliciesEnabled,omitempty"`
	// The Global Request Policy to be executed for all Frontend API calls. Must be a valid policy ID. Can be null to indicate no policy
	GlobalRequestPolicy string `json:"globalRequestPolicy,omitempty"`
	// The Global Response Policy to be executed for all Frontend API calls. Must be a valid policy ID. Can be null to indicate no policy
	GlobalResponsePolicy string `json:"globalResponsePolicy,omitempty"`
	// Enables/disables API Manager fault handlers.
	FaultHandlersEnabled bool `json:"faultHandlersEnabled,omitempty"`
	// The Global Fault Handler Policy to be used by all Frontend APIs in the event of an error. Must be a valid policy ID. Can be null to indicate no policy
	GlobalFaultHandlerPolicy string `json:"globalFaultHandlerPolicy,omitempty"`
	BaseOAuth                bool   `json:"baseOAuth,omitempty"`
	// External user name
	ExternalUserName string `json:"externalUserName,omitempty"`
	// External user description
	ExternalUserDescription string `json:"externalUserDescription,omitempty"`
	// External user phone
	ExternalUserPhone string `json:"externalUserPhone,omitempty"`
	// External user email
	ExternalUserEmail string `json:"externalUserEmail,omitempty"`
	// External user organization name
	ExternalUserOrganization string `json:"externalUserOrganization,omitempty"`
	// External user role
	ExternalUserRole string `json:"externalUserRole,omitempty"`
	// External user enabled
	ExternalUserEnabled string `json:"externalUserEnabled,omitempty"`
	// Idle session timeout in milliseconds
	SessionIdleTimeout int64 `json:"sessionIdleTimeout"`
	// Is trial enabled
	IsTrial bool `json:"isTrial,omitempty"`
	// Default trial duration in days
	DefaultTrialDuration int32 `json:"defaultTrialDuration,omitempty"`
	// Login name validation regex
	LoginNameRegex string `json:"loginNameRegex,omitempty"`
	// The Version information of API Manager.
	ProductVersion string `json:"productVersion,omitempty"`
	// The operating system on which API Manager server is running.
	Os string `json:"os,omitempty"`
	// The architecture of the operating system on which the API Manager server is running. Supported values: [ win-x86-32, linux-x86-64 ]
	Architecture string `json:"architecture,omitempty"`
}

Config API Manager configuration

type ConfigPutOpts 

type ConfigPutOpts struct {
	Body optional.Interface
}

ConfigPutOpts Optional parameters for the method 'ConfigPut'

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type CorsProfile 

type CorsProfile struct {
	// Unique name of the Profile
	Name string `json:"name,omitempty"`
	// Indicates that this is the default profile.  There can be only one default.
	IsDefault bool `json:"isDefault,omitempty"`
	// List of origins for this CORS Profile
	Origins []string `json:"origins,omitempty"`
	// List of headers...
	AllowedHeaders []string `json:"allowedHeaders,omitempty"`
	// List of headers...
	ExposedHeaders []string `json:"exposedHeaders,omitempty"`
	// Specifies whether or credentials are supported for APIs/API Methods employing this CORS Profile.
	SupportCredentials bool `json:"supportCredentials,omitempty"`
	// Specifies the amount of time responses to OPTIONS requests are stored, in seconds, in the preflight result cache
	MaxAgeSeconds int64 `json:"maxAgeSeconds,omitempty"`
}

CorsProfile CORS configuration profile.

type CurrentUserApiService 

type CurrentUserApiService service

CurrentUserApiService CurrentUserApi service

func (*CurrentUserApiService) CurrentuserChangepasswordPost 

func (a *CurrentUserApiService) CurrentuserChangepasswordPost(ctx _context.Context, oldPassword string, newPassword string) (*_nethttp.Response, error)

CurrentuserChangepasswordPost Modify the current user's password Modify the password of the authenticated user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param oldPassword The user's old password
  • @param newPassword The user's new password

func (*CurrentUserApiService) CurrentuserGet 

func (a *CurrentUserApiService) CurrentuserGet(ctx _context.Context) (User, *_nethttp.Response, error)

CurrentuserGet Get the current user Get the account details of the authenticated user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return User

func (*CurrentUserApiService) CurrentuserPut 

func (a *CurrentUserApiService) CurrentuserPut(ctx _context.Context, localVarOptionals *CurrentuserPutOpts) (User, *_nethttp.Response, error)

CurrentuserPut Modify the current user Modify the account details of the authenticated user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CurrentuserPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of User) -

@return User

type CurrentuserPutOpts 

type CurrentuserPutOpts struct {
	Body optional.Interface
}

CurrentuserPutOpts Optional parameters for the method 'CurrentuserPut'

type DiscoveryApi 

type DiscoveryApi struct {
	// The name of the API
	Name string `json:"name,omitempty"`
	// Summary of the API
	Summary string `json:"summary,omitempty"`
	// The unique identifier for the API
	Id string `json:"id,omitempty"`
	// The URL of where further information of the API is available in the portal
	Uri string `json:"uri,omitempty"`
	// The type of API, either rest or wsdl
	Type string `json:"type,omitempty"`
}

DiscoveryApi REST API information.

type DiscoverySdkIdPlatformGetOpts 

type DiscoverySdkIdPlatformGetOpts struct {
	Packagename optional.String
}

DiscoverySdkIdPlatformGetOpts Optional parameters for the method 'DiscoverySdkIdPlatformGet'

type DiscoverySwaggerApiIdIdGetOpts 

type DiscoverySwaggerApiIdIdGetOpts struct {
	Filename       optional.String
	SwaggerVersion optional.String
	Extensions     optional.Bool
}

DiscoverySwaggerApiIdIdGetOpts Optional parameters for the method 'DiscoverySwaggerApiIdIdGet'

type DiscoverySwaggerApiNameGetOpts 

type DiscoverySwaggerApiNameGetOpts struct {
	Filename       optional.String
	ApiVersion     optional.String
	SwaggerVersion optional.String
	Extensions     optional.Bool
}

DiscoverySwaggerApiNameGetOpts Optional parameters for the method 'DiscoverySwaggerApiNameGet'

type DiscoverySwaggerApisGetOpts 

type DiscoverySwaggerApisGetOpts struct {
	ApiVersion     optional.String
	SwaggerVersion optional.String
	Extensions     optional.Bool
	Field          optional.Interface
	Op             optional.Interface
	Value          optional.Interface
}

DiscoverySwaggerApisGetOpts Optional parameters for the method 'DiscoverySwaggerApisGet'

type ErrorResponse 

type ErrorResponse struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example       map[string]interface{} `json:"example,omitempty"`
	Discriminator string                 `json:"discriminator,omitempty"`
	// The response code
	Code int64 `json:"code,omitempty"`
	// The response reason
	Reason string `json:"reason,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The type ex: array , boolean, integer , null , number, object, string
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

ErrorResponse An operation response code.

type ExportOptions 

type ExportOptions struct {
	// If specified, the name of the file that the exported applications will be wrote to
	Filename string `json:"filename,omitempty"`
	// Password value which, when specified, will be use to encrypt the output stream for the export
	Password string `json:"password,omitempty"`
	// List of the application ids that was chosen for export
	AppIds []string `json:"appIds,omitempty"`
	// Flag to indicate if api quota information is to be included in the export
	Quota bool `json:"quota,omitempty"`
	// Flag to indicate if oauth credentials are to be included in the export
	Oauth bool `json:"oauth,omitempty"`
	// Flag to indicate if api keys are to be included in the export
	Apikeys bool `json:"apikeys,omitempty"`
}

ExportOptions Options available on export of applications

type ExternalClient 

type ExternalClient struct {
	// The ID of the external client
	Id string `json:"id,omitempty"`
	// The 3rd party client ID. This client ID is provided by a 3rd party OAuth service and is used to map an application to an external client. This value is unique, i.e. no other application can specify the same client ID.
	ClientId string `json:"clientId,omitempty"`
	// Flag disables the external client so it can't be used in authentication
	Enabled bool `json:"enabled,omitempty"`
	// The unique identifier of the user that created the mapping
	CreatedBy string `json:"createdBy,omitempty"`
	// Epoch/Unix time stamp when the mapping was created
	CreatedOn int64 `json:"createdOn,omitempty"`
	// The domains to allow access for browser-based clients
	CorsOrigins []string `json:"corsOrigins,omitempty"`
}

ExternalClient API Manager external client

type FiledataPostOpts 

type FiledataPostOpts struct {
	File optional.Interface
}

FiledataPostOpts Optional parameters for the method 'FiledataPost'

type FrontendExport 

type FrontendExport struct {
	// List of frontend API
	Apis []VirtualizedApi `json:"apis,omitempty"`
	// List of frontend API methods
	Methods []VirtualizedMethodExport `json:"methods,omitempty"`
	// List of backend API methods
	BackendMethods []BackendMethodExport `json:"backendMethods,omitempty"`
	// Image Export
	Imagedata map[string]string `json:"imagedata,omitempty"`
}

FrontendExport Frontend API export definition.

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GrantTypes 

type GrantTypes struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example           map[string]interface{} `json:"example,omitempty"`
	Discriminator     string                 `json:"discriminator,omitempty"`
	Implicit          Implicit               `json:"implicit,omitempty"`
	AuthorizationCode AuthorizationCode      `json:"authorization_code,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The type ex: array , boolean, integer , null , number, object, string
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

GrantTypes struct for GrantTypes

type Group 

type Group struct {
	Id       string            `json:"id,omitempty"`
	Name     string            `json:"name,omitempty"`
	Tags     map[string]string `json:"tags,omitempty"`
	Services []Service         `json:"services,omitempty"`
	Lock     Lock              `json:"lock,omitempty"`
}

Group struct for Group

type Host 

type Host struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

Host struct for Host

type Implicit 

type Implicit struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example       map[string]interface{} `json:"example,omitempty"`
	Discriminator string                 `json:"discriminator,omitempty"`
	LoginEndpoint LoginEndpoint          `json:"loginEndpoint,omitempty"`
	// An optional alternative name to standard 'access_token' OAuth2 parameter.
	TokenName string `json:"tokenName,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The type ex: array , boolean, integer , null , number, object, string
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

Implicit struct for Implicit

type InboundProfiles 

type InboundProfiles struct {
	// The name of the Security Profile to be used for this Virtualized API.
	SecurityProfile string `json:"securityProfile,omitempty"`
	// The name of the CORS Profile to be used for this Virtualized API.
	CorsProfile string `json:"corsProfile,omitempty"`
	// Enables metrics monitoring for the API
	MonitorAPI bool `json:"monitorAPI,omitempty"`
	// Identifies the client for metrics monitoring
	MonitorSubject string `json:"monitorSubject,omitempty"`
}

InboundProfiles Inbound profiles

type Lock 

type Lock struct {
	Locker    string `json:"locker,omitempty"`
	Timestamp int64  `json:"timestamp,omitempty"`
}

Lock struct for Lock

type LoginApiService 

type LoginApiService service

LoginApiService LoginApi service

func (*LoginApiService) LoginDelete 

func (a *LoginApiService) LoginDelete(ctx _context.Context) (*_nethttp.Response, error)

LoginDelete Logout from API Manager Destroys the caller session with the API Manager.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*LoginApiService) LoginPost 

func (a *LoginApiService) LoginPost(ctx _context.Context, username string, password string, localVarOptionals *LoginPostOpts) (*_nethttp.Response, error)

LoginPost Login to API Manager Logs a user, identified by _username_ and _password_, into the API Manager by creating unique a session cookie. The _success_ parameter defaults to a named URL identified by \"/home\" and will return a redirect to the portal after login. The _failure_ parameter is optional. If _failure_ is not specified, and the login attempt fails, this method returns a JSON error response. If _failure_ is specified, and the login attempt fails, then this method will redirect to a named URL, identified by \"/login-failed\".

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param username The login name of the authenticating user
  • @param password The password of the authenticating user
  • @param optional nil or *LoginPostOpts - Optional Parameters:
  • @param "Success" (optional.String) - The redirect success location (defaults to: /home)
  • @param "Failure" (optional.String) - Optional redirect failure location (e.g. /login-failed

type LoginEndpoint 

type LoginEndpoint struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example       map[string]interface{} `json:"example,omitempty"`
	Discriminator string                 `json:"discriminator,omitempty"`
	// The URL of the authorization endpoint for the implicit grant flow. The value should be in a URL format.
	Url string `json:"url,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The type ex: array , boolean, integer , null , number, object, string
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

LoginEndpoint struct for LoginEndpoint

type LoginPostOpts 

type LoginPostOpts struct {
	Success optional.String
	Failure optional.String
}

LoginPostOpts Optional parameters for the method 'LoginPost'

type Method 

type Method struct {
	// The method identifier
	Id string `json:"id,omitempty"`
	// The API identifier to which this method belongs
	ApiId string `json:"apiId,omitempty"`
	// The API path
	Path string `json:"path,omitempty"`
	// The HTTP verb
	Verb string `json:"verb,omitempty"`
	// The name of the operation
	Name string `json:"name,omitempty"`
	// A short summary description of the operation
	Summary string `json:"summary,omitempty"`
	// A detailed description of the operation
	Description string `json:"description,omitempty"`
	// The return type of the method, e.g. void, array, or a type found in models
	ReturnType string `json:"returnType,omitempty"`
	// A list of accepted parameters
	Parameters []Parameter `json:"parameters,omitempty"`
	// A list of possible response messages and their meanings
	ResponseCodes []ResponseCode `json:"responseCodes,omitempty"`
	// The content types that the operation consumes
	Consumes []string `json:"consumes,omitempty"`
	// The content types that the operation produces
	Produces []string `json:"produces,omitempty"`
	// A list of properties associated with this API Method. The list of properties may vary, depending on the type of the parent API.
	Properties map[string]string `json:"properties,omitempty"`
}

Method A method available on an API resource.

type MetricField 

type MetricField struct {
	// The metric type name
	MetricType string `json:"metricType,omitempty"`
	// The metric aggregate name
	AggregateName string `json:"aggregateName,omitempty"`
}

MetricField Queryable metric type information

type MetricTimeline 

type MetricTimeline struct {
	Id string `json:"id,omitempty"`
	// The metric name.
	Name string `json:"name,omitempty"`
	// The time series.
	Series []Series `json:"series,omitempty"`
}

MetricTimeline The metrics timeline report is a report of a specific metric over a period of time.

type MetricsApiService 

type MetricsApiService service

MetricsApiService MetricsApi service

func (*MetricsApiService) MetricsFieldsGet 

func (a *MetricsApiService) MetricsFieldsGet(ctx _context.Context) ([]MetricField, *_nethttp.Response, error)

MetricsFieldsGet Gets a list of metric field names available for summary and timeline queries. Retrieves a set of metric fields that may be used when querying or interpreting the summary and timeline reports. The __metricType__ is the metric name. The __aggreggateName__ is the metric name for the aggregated __metricType__.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []MetricField

func (*MetricsApiService) MetricsReportsTypeSummaryLevelGet 

func (a *MetricsApiService) MetricsReportsTypeSummaryLevelGet(ctx _context.Context, type_ string, level int32, from string, to string, localVarOptionals *MetricsReportsTypeSummaryLevelGetOpts) (*_nethttp.Response, error)

MetricsReportsTypeSummaryLevelGet Gets a summary report for application usage

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param type_ The report type, either 'app' or 'api'
  • @param level The report level (0 or 1 for drill-through)
  • @param from The starting date/time for the report.
  • @param to The end date/time for the report.
  • @param optional nil or *MetricsReportsTypeSummaryLevelGetOpts - Optional Parameters:
  • @param "Client" (optional.Interface of []string) - Filter a specific client ID (multiple permitted).
  • @param "Service" (optional.Interface of []string) - Filter a specific service name (multiple permitted).
  • @param "Method" (optional.String) - Filter a specific method.
  • @param "Organization" (optional.String) - Filter a specific organziation.
  • @param "Reportsubtype" (optional.String) - Define the report subtype. Allowed values are : 'original', 'trafficAll' or 'trafficSubset'. Defaults to 'original' if absent

func (*MetricsApiService) MetricsReportsTypeTimelineLevelMetricTypeGet 

func (a *MetricsApiService) MetricsReportsTypeTimelineLevelMetricTypeGet(ctx _context.Context, type_ string, level int32, from string, to string, metricType string, localVarOptionals *MetricsReportsTypeTimelineLevelMetricTypeGetOpts) (MetricTimeline, *_nethttp.Response, error)

MetricsReportsTypeTimelineLevelMetricTypeGet Gets a timeline report for application usage Produces a timeline report for a __metricType__ over a specified time range. The __from__ and __two__ parameters should be a URL encoded ISO-8601 combined date and time format (e.g. 2013-03-13T00%3A00%3A00Z). The __metricType__ name is one of the types returned from [fields](#APIMetricsgetMetricFields).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param type_ The report type, either 'app' or 'api'
  • @param level The report level (0 or 1 for drill-through)
  • @param from The starting date/time for the report.
  • @param to The end date/time for the report.
  • @param metricType The metric type to query.
  • @param optional nil or *MetricsReportsTypeTimelineLevelMetricTypeGetOpts - Optional Parameters:
  • @param "Client" (optional.Interface of []string) - Filter a specific client ID (multiple permitted).
  • @param "Service" (optional.Interface of []string) - Filter a specific service name (multiple permitted).
  • @param "Method" (optional.String) - Filter a specific method.
  • @param "Organization" (optional.String) - Filter a specific organziation.
  • @param "Reportsubtype" (optional.String) - Define the report subtype. Allowed values are : 'original', 'trafficAll' or 'trafficSubset'. Defaults to 'original' if absent

@return MetricTimeline

type MetricsReportsTypeSummaryLevelGetOpts 

type MetricsReportsTypeSummaryLevelGetOpts struct {
	Client        optional.Interface
	Service       optional.Interface
	Method        optional.String
	Organization  optional.String
	Reportsubtype optional.String
}

MetricsReportsTypeSummaryLevelGetOpts Optional parameters for the method 'MetricsReportsTypeSummaryLevelGet'

type MetricsReportsTypeTimelineLevelMetricTypeGetOpts 

type MetricsReportsTypeTimelineLevelMetricTypeGetOpts struct {
	Client        optional.Interface
	Service       optional.Interface
	Method        optional.String
	Organization  optional.String
	Reportsubtype optional.String
}

MetricsReportsTypeTimelineLevelMetricTypeGetOpts Optional parameters for the method 'MetricsReportsTypeTimelineLevelMetricTypeGet'

type MigrateApiService 

type MigrateApiService service

MigrateApiService MigrateApi service

func (*MigrateApiService) MigrateApplicationsExportCreatePost 

func (a *MigrateApiService) MigrateApplicationsExportCreatePost(ctx _context.Context, body ExportOptions) (*_nethttp.Response, error)

MigrateApplicationsExportCreatePost Creates a set of export options associated with the current http session Creates a set of export options associated with the current http session. Options include the password used to encrypt the resulting export, export elements: apikeys, oauth & quotas, the filename of the export, and the list of application ids for inclusion in the export. The exported data can be retrieved subsequently with a GET request

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The options for creating an application export file

func (*MigrateApiService) MigrateApplicationsExportDownloadGet 

func (a *MigrateApiService) MigrateApplicationsExportDownloadGet(ctx _context.Context, localVarOptionals *MigrateApplicationsExportDownloadGetOpts) (*_nethttp.Response, error)

MigrateApplicationsExportDownloadGet Exports Application data for migration to other API Gateways Retrieves the export options associated with the current user HTTP session and creates a stream or returns the exported data in response body.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *MigrateApplicationsExportDownloadGetOpts - Optional Parameters:
  • @param "Filename" (optional.String) - Optional. If present this method will return an octet stream with an file attachment of the same name

func (*MigrateApiService) MigrateApplicationsExportJsonPost 

func (a *MigrateApiService) MigrateApplicationsExportJsonPost(ctx _context.Context, body ExportOptions) (*_nethttp.Response, error)

MigrateApplicationsExportJsonPost Creates an export of applications based on the export options posted as a JSON object Creates an export file based on options including the password used to encrypt the resulting export, export elements: apikeys, oauth & quotas, the filename of the export, and the list of application ids for inclusion in the export. The exported data is returned as part of the response body

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Export options

func (*MigrateApiService) MigrateApplicationsExportPost 

func (a *MigrateApiService) MigrateApplicationsExportPost(ctx _context.Context, apikeys string, oauth string, quota string, localVarOptionals *MigrateApplicationsExportPostOpts) (*_nethttp.Response, error)

MigrateApplicationsExportPost Creates an export of applications based on the export options posted in a form data Creates an export file based on options including the password used to encrypt the resulting export, export elements: apikeys, oauth & quotas, the filename of the export, and the list of application ids for inclusion in the export. The exported data is returned as part of the response body

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param apikeys True/False. Include/Exclude api keys
  • @param oauth True/False. Include/Exclude oauth credentials
  • @param quota True/False. Include/Exclude quotas, if available
  • @param optional nil or *MigrateApplicationsExportPostOpts - Optional Parameters:
  • @param "Filename" (optional.String) - The name of the export file
  • @param "Password" (optional.String) - The password used to encrypt the exported file
  • @param "AppIds" (optional.Interface of []string) - The list of identifiers for the applications to be exported

func (*MigrateApiService) MigrateApplicationsImportPost 

func (a *MigrateApiService) MigrateApplicationsImportPost(ctx _context.Context, type_ string, file *os.File, organizationId string, userId string, localVarOptionals *MigrateApplicationsImportPostOpts) (*_nethttp.Response, error)

MigrateApplicationsImportPost Imports applications to the API Gateway Imports a set of applications and assocated API Keys and OAuth credentials, encrypted files require a decryption password

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param type_ The type of application response required. THe only valid option is iframe - this is for ajax based calls that require an iFrame, i.e. Internet Explorer version prior to version 9.
  • @param file The file containing application data to be imported
  • @param organizationId The Organization to associate the imported applications with. If applicable, for Core OAuth this parameter will be ignored
  • @param userId The user to associate the applications with. Default is the API Admin
  • @param optional nil or *MigrateApplicationsImportPostOpts - Optional Parameters:
  • @param "Password" (optional.String) - Password to be used for decryption

type MigrateApplicationsExportDownloadGetOpts 

type MigrateApplicationsExportDownloadGetOpts struct {
	Filename optional.String
}

MigrateApplicationsExportDownloadGetOpts Optional parameters for the method 'MigrateApplicationsExportDownloadGet'

type MigrateApplicationsExportPostOpts 

type MigrateApplicationsExportPostOpts struct {
	Filename optional.String
	Password optional.String
	AppIds   optional.Interface
}

MigrateApplicationsExportPostOpts Optional parameters for the method 'MigrateApplicationsExportPost'

type MigrateApplicationsImportPostOpts 

type MigrateApplicationsImportPostOpts struct {
	Password optional.String
}

MigrateApplicationsImportPostOpts Optional parameters for the method 'MigrateApplicationsImportPost'

type OAuthAppScope 

type OAuthAppScope struct {
	// The unique identifier for the oauth protected resource
	Id string `json:"id"`
	// The unique identifier for the application that has this scope
	ApplicationId string `json:"applicationId"`
	// The scope string
	Scope string `json:"scope,omitempty"`
	// Flag to indicate if this scope is one of the applications default scopes
	IsDefault bool `json:"isDefault,omitempty"`
}

OAuthAppScope OAuth Application Scope

type OAuthAuthorizationsApiService 

type OAuthAuthorizationsApiService service

OAuthAuthorizationsApiService OAuthAuthorizationsApi service

func (*OAuthAuthorizationsApiService) AuthorizationsAuthzidDelete 

func (a *OAuthAuthorizationsApiService) AuthorizationsAuthzidDelete(ctx _context.Context, authzid string) (*_nethttp.Response, error)

AuthorizationsAuthzidDelete Delete the OAuth Authorization for the given authorization id. Admin or Resource Owner task to delete the given authorization id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param authzid

func (*OAuthAuthorizationsApiService) AuthorizationsGet 

func (a *OAuthAuthorizationsApiService) AuthorizationsGet(ctx _context.Context) ([]Authorization, *_nethttp.Response, error)

AuthorizationsGet Retrieve all stored OAuth Authorizations for the logged in user. If user is a member of the admin group then all authorizations are returned. If not, then the logged in user's authorizations are returned.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Authorization

func (*OAuthAuthorizationsApiService) AuthorizationsOwnerSubjectidApplicationAppidDelete 

func (a *OAuthAuthorizationsApiService) AuthorizationsOwnerSubjectidApplicationAppidDelete(ctx _context.Context, subjectid string, appid string) (*_nethttp.Response, error)

AuthorizationsOwnerSubjectidApplicationAppidDelete Method for AuthorizationsOwnerSubjectidApplicationAppidDelete

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subjectid
  • @param appid

type OAuthClient 

type OAuthClient struct {
	// The client ID to be used in OAuth flows
	Id string `json:"id,omitempty"`
	// The PEM encodeded certificate used in JWT flow
	Cert string `json:"cert,omitempty"`
	// The client application secret to be used in OAuth flows
	Secret string `json:"secret,omitempty"`
	// OAuth defines two client types, based on their ability to authenticate securely with the authorization server. Possible values public or confidential
	Type string `json:"type,omitempty"`
	// Flag disables the OAuth credentials so they can't be used in authentication
	Enabled bool `json:"enabled,omitempty"`
	// The URL where the server will redirect the to present authorization codes or access tokens depending on the OAuth flow being executed
	RedirectUrls []string `json:"redirectUrls,omitempty"`
	// The domains to allow access for browser-based clients
	CorsOrigins []string `json:"corsOrigins,omitempty"`
	// The unique identifier for user that generated the OAuth credentials
	CreatedBy string `json:"createdBy,omitempty"`
	// Epoch/Unix time stamp when the OAuth credentials was created
	CreatedOn int64 `json:"createdOn,omitempty"`
	// The application identifier associated with the OAuth credential
	ApplicationId string `json:"applicationId,omitempty"`
}

OAuthClient API Manager OAuth Credentials.

type OAuthProtectedResource 

type OAuthProtectedResource struct {
	// Oauth protected path
	Uriprefix string `json:"uriprefix,omitempty"`
	// List of scopes associated with the OAuth protected path
	Scopes []string `json:"scopes,omitempty"`
	// Oauth Scope
	Scope string `json:"scope,omitempty"`
	// Scope Description
	Description string `json:"description,omitempty"`
}

OAuthProtectedResource Scope and prefix information for OAuth protected resource.

type OAuthResource 

type OAuthResource struct {
	// The unique identifier for the oauth protected resource
	Id string `json:"id"`
	// The unique identifier for the application who has access to this resource
	ApplicationId string `json:"applicationId"`
	// The uri prefix which this oauth protected resource relates to
	Uriprefix string `json:"uriprefix,omitempty"`
	// Set of scope strings that have been resolved from querying the OAuth Resource Service at the uri prefix
	Scopes []string `json:"scopes,omitempty"`
	// Flag to indicate if this oauth protected resource is enabled or not
	Enabled   bool   `json:"enabled,omitempty"`
	IsDefault bool   `json:"isDefault,omitempty"`
	Scope     string `json:"scope,omitempty"`
}

OAuthResource OAuth protected resource.

type Operation 

type Operation struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example       map[string]interface{} `json:"example,omitempty"`
	Discriminator string                 `json:"discriminator,omitempty"`
	// The HTTP method
	HttpMethod string `json:"httpMethod,omitempty"`
	// The nickname of the operation
	Nickname string `json:"nickname,omitempty"`
	// A short summary description of the operation
	Summary string `json:"summary,omitempty"`
	// A detailed description of the operation
	Notes string `json:"notes,omitempty"`
	// The return type of the method, e.g. void, array, or a type found in models
	ResponseClass string `json:"responseClass,omitempty"`
	// A list of possible response messages and their meanings
	ErrorResponses []ErrorResponse `json:"errorResponses,omitempty"`
	// The content types that the operation consumes
	Consumes []string `json:"consumes,omitempty"`
	// The content types that the operation produces
	Produces []string `json:"produces,omitempty"`
	// Authorizations
	Authorizations map[string][]map[string]interface{} `json:"authorizations,omitempty"`
	// The list of tags associated with this API operation. Each tag can have multiple values
	Tags            map[string][]string    `json:"tags,omitempty"`
	SecurityProfile SwaggerSecurityProfile `json:"securityProfile,omitempty"`
	// The documentation URL for the operation
	DocumentationUrl string `json:"documentationUrl,omitempty"`
	// Indicates that the API is CORS enabled
	Cors bool `json:"cors,omitempty"`
	// A list of accepted parameters
	Parameters []Parameter `json:"parameters,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The return type of the method, e.g. void, array, or a type found in models
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

Operation An operation available to an API path.

type Organization 

type Organization struct {
	// The unique identifier for the organization
	Id string `json:"id,omitempty"`
	// The name of the organization
	Name string `json:"name"`
	// The description of the organization
	Description string `json:"description,omitempty"`
	// The contact email address associated with the organization
	Email string `json:"email,omitempty"`
	// URI of the image to be used for this organization. To update the image, please refer to the API.
	Image string `json:"image,omitempty"`
	// Indicates that the organization is restricted.  Users in a restricted organization cannot see other users, and users cannot register for the organization using tokens.  Default is 'false'.
	Restricted bool `json:"restricted,omitempty"`
	// The virtual host associated with the organization
	VirtualHost string `json:"virtualHost,omitempty"`
	// Contact phone number of the organization
	Phone string `json:"phone,omitempty"`
	// Flag to indicate if this organization is enabled or not
	Enabled bool `json:"enabled,omitempty"`
	// Flag to indicate if this organization is enabled or not for API development.
	Development bool   `json:"development,omitempty"`
	Dn          string `json:"dn,omitempty"`
	// Epoch/Unix time stamp when the organization was created
	CreatedOn int64 `json:"createdOn,omitempty"`
	// Epoch/Unix time stamp when the trial starts
	StartTrialDate int64 `json:"startTrialDate,omitempty"`
	// Epoch/Unix time stamp when the trial expires
	EndTrialDate int64 `json:"endTrialDate,omitempty"`
	// Length of the trial in days
	TrialDuration int32 `json:"trialDuration,omitempty"`
	// Indicates if this Org is a trial or not
	IsTrial bool `json:"isTrial,omitempty"`
}

Organization API Manager organization

type OrganizationsApiService 

type OrganizationsApiService service

OrganizationsApiService OrganizationsApi service

func (*OrganizationsApiService) OrganizationsGet 

func (a *OrganizationsApiService) OrganizationsGet(ctx _context.Context, localVarOptionals *OrganizationsGetOpts) ([]Organization, *_nethttp.Response, error)

OrganizationsGet List all organizations Get the list of organizations that are visible to the authenticated user. Only API Administrators may list all organizations, all other users will see their organization. The list of organizations can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of: apiid : Matches the organization if the organization is using the API, specified by ID description : The organization's description email : The organization's contact email address enabled : The enabled state of the organization, one of: enabled, disabled createdOn : The date the organization was created on, time in ms, e.g.: 1372755998542 name : The name of the organization phone : The organization's contact phone The __op__ is an operation and is one of: eq : Equal ne : Not equal gt : Greater than lt : Less than ge : Greater than or equal le : Less than or equal like : Like gete : Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10 The __value__ will be compared against the __field__, according to the supplied __op__.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *OrganizationsGetOpts - Optional Parameters:
  • @param "Field" (optional.Interface of []string) - Filter field name.
  • @param "Op" (optional.Interface of []string) - Filter operation.
  • @param "Value" (optional.Interface of []string) - Filter value

@return []Organization

func (*OrganizationsApiService) OrganizationsIdApisApiAccessIdDelete 

func (a *OrganizationsApiService) OrganizationsIdApisApiAccessIdDelete(ctx _context.Context, id string, apiAccessId string) (ApiAccess, *_nethttp.Response, error)

OrganizationsIdApisApiAccessIdDelete Deletes access to an API for an organization Permanently deletes access to an API for an organization. Deleting API access will also delete API access to any application.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID.
  • @param apiAccessId The API access ID.

@return ApiAccess

func (*OrganizationsApiService) OrganizationsIdApisApiAccessIdPut 

func (a *OrganizationsApiService) OrganizationsIdApisApiAccessIdPut(ctx _context.Context, id string, apiAccessId string, localVarOptionals *OrganizationsIdApisApiAccessIdPutOpts) (ApiAccess, *_nethttp.Response, error)

OrganizationsIdApisApiAccessIdPut Updates access to an API for an organization Updates access to an API for an organization. Only __enabled__ may be modified, and disabling access will also disable access to all applications that may be using it.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID.
  • @param apiAccessId The API access ID.
  • @param optional nil or *OrganizationsIdApisApiAccessIdPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of ApiAccess) -

@return ApiAccess

func (*OrganizationsApiService) OrganizationsIdApisGet 

func (a *OrganizationsApiService) OrganizationsIdApisGet(ctx _context.Context, id string) (ApiAccess, *_nethttp.Response, error)

OrganizationsIdApisGet Get the list of approved APIs for the organization Get the list of aproved APIs for the organization

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID who's approved APIs are required.

@return ApiAccess

func (*OrganizationsApiService) OrganizationsIdApisPost 

func (a *OrganizationsApiService) OrganizationsIdApisPost(ctx _context.Context, id string, localVarOptionals *OrganizationsIdApisPostOpts) (ApiAccess, *_nethttp.Response, error)

OrganizationsIdApisPost Grants access to an API for an organization. Grants access to an API for an organization. Only the API Admin may call this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID requesting access to an API.
  • @param optional nil or *OrganizationsIdApisPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of ApiAccess) -

@return ApiAccess

func (*OrganizationsApiService) OrganizationsIdDelete 

func (a *OrganizationsApiService) OrganizationsIdDelete(ctx _context.Context, id string) (*_nethttp.Response, error)

OrganizationsIdDelete Delete an organization Deletes an organization. Deleting an organization will result in all users and associated applications being deleted

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID to delete.

func (*OrganizationsApiService) OrganizationsIdGet 

func (a *OrganizationsApiService) OrganizationsIdGet(ctx _context.Context, id string) (Organization, *_nethttp.Response, error)

OrganizationsIdGet Get an organization Retrieves the details of an organization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID to be returned.

@return Organization

func (*OrganizationsApiService) OrganizationsIdImageGet 

func (a *OrganizationsApiService) OrganizationsIdImageGet(ctx _context.Context, id string) (*_nethttp.Response, error)

OrganizationsIdImageGet Get the image for an organization Returns the jpeg image associated with an organization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID whos image is to be returned

func (*OrganizationsApiService) OrganizationsIdImagePost 

func (a *OrganizationsApiService) OrganizationsIdImagePost(ctx _context.Context, id string, localVarOptionals *OrganizationsIdImagePostOpts) (*_nethttp.Response, error)

OrganizationsIdImagePost Set the image for an organization Set the jpeg image to be associated with an organization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID whos image is to be set
  • @param optional nil or *OrganizationsIdImagePostOpts - Optional Parameters:
  • @param "Type_" (optional.String) -
  • @param "File" (optional.Interface of *os.File) -

func (*OrganizationsApiService) OrganizationsIdPut 

func (a *OrganizationsApiService) OrganizationsIdPut(ctx _context.Context, id string, localVarOptionals *OrganizationsIdPutOpts) (Organization, *_nethttp.Response, error)

OrganizationsIdPut Update the details of an organization Updates an organization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID to update.
  • @param optional nil or *OrganizationsIdPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of Organization) -

@return Organization

func (*OrganizationsApiService) OrganizationsIdTokensGet 

func (a *OrganizationsApiService) OrganizationsIdTokensGet(ctx _context.Context, id string) ([]RegistrationToken, *_nethttp.Response, error)

OrganizationsIdTokensGet Get registration codes for an organization Retrieves the registration codes for an organization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID whos tokens are to be returned.

@return []RegistrationToken

func (*OrganizationsApiService) OrganizationsIdTokensPost 

func (a *OrganizationsApiService) OrganizationsIdTokensPost(ctx _context.Context, id string, localVarOptionals *OrganizationsIdTokensPostOpts) (RegistrationToken, *_nethttp.Response, error)

OrganizationsIdTokensPost Create a registration code Create a registration code for self service onboarding of users to the organization

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID to be associated with the registration code.
  • @param optional nil or *OrganizationsIdTokensPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of RegistrationToken) -

@return RegistrationToken

func (*OrganizationsApiService) OrganizationsIdTokensTokenDelete 

func (a *OrganizationsApiService) OrganizationsIdTokensTokenDelete(ctx _context.Context, id string, token string) (*_nethttp.Response, error)

OrganizationsIdTokensTokenDelete Delete the registration code Delete the registration code.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID associated with the registration code.
  • @param token The registration code to be deleted.

func (*OrganizationsApiService) OrganizationsIdTokensTokenGet 

func (a *OrganizationsApiService) OrganizationsIdTokensTokenGet(ctx _context.Context, id string, token string) ([]RegistrationToken, *_nethttp.Response, error)

OrganizationsIdTokensTokenGet Get registration code Retrieves the registration code.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID associated with the registration code.
  • @param token The registration code to be returned.

@return []RegistrationToken

func (*OrganizationsApiService) OrganizationsIdTokensTokenPut 

func (a *OrganizationsApiService) OrganizationsIdTokensTokenPut(ctx _context.Context, id string, token string, localVarOptionals *OrganizationsIdTokensTokenPutOpts) (RegistrationToken, *_nethttp.Response, error)

OrganizationsIdTokensTokenPut Update a registration code Update a registration code for self service onboarding of users to the organization

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The organization ID to be associated with the registration code.
  • @param token
  • @param optional nil or *OrganizationsIdTokensTokenPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of RegistrationToken) -

@return RegistrationToken

func (*OrganizationsApiService) OrganizationsPost 

func (a *OrganizationsApiService) OrganizationsPost(ctx _context.Context, localVarOptionals *OrganizationsPostOpts) (Organization, *_nethttp.Response, error)

OrganizationsPost Creates a new organization Creates a new organization. Only API Administrators may create organizations.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *OrganizationsPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of Organization) -

@return Organization

type OrganizationsGetOpts 

type OrganizationsGetOpts struct {
	Field optional.Interface
	Op    optional.Interface
	Value optional.Interface
}

OrganizationsGetOpts Optional parameters for the method 'OrganizationsGet'

type OrganizationsIdApisApiAccessIdPutOpts 

type OrganizationsIdApisApiAccessIdPutOpts struct {
	Body optional.Interface
}

OrganizationsIdApisApiAccessIdPutOpts Optional parameters for the method 'OrganizationsIdApisApiAccessIdPut'

type OrganizationsIdApisPostOpts 

type OrganizationsIdApisPostOpts struct {
	Body optional.Interface
}

OrganizationsIdApisPostOpts Optional parameters for the method 'OrganizationsIdApisPost'

type OrganizationsIdImagePostOpts 

type OrganizationsIdImagePostOpts struct {
	Type_ optional.String
	File  optional.Interface
}

OrganizationsIdImagePostOpts Optional parameters for the method 'OrganizationsIdImagePost'

type OrganizationsIdPutOpts 

type OrganizationsIdPutOpts struct {
	Body optional.Interface
}

OrganizationsIdPutOpts Optional parameters for the method 'OrganizationsIdPut'

type OrganizationsIdTokensPostOpts 

type OrganizationsIdTokensPostOpts struct {
	Body optional.Interface
}

OrganizationsIdTokensPostOpts Optional parameters for the method 'OrganizationsIdTokensPost'

type OrganizationsIdTokensTokenPutOpts 

type OrganizationsIdTokensTokenPutOpts struct {
	Body optional.Interface
}

OrganizationsIdTokensTokenPutOpts Optional parameters for the method 'OrganizationsIdTokensTokenPut'

type OrganizationsPostOpts 

type OrganizationsPostOpts struct {
	Body optional.Interface
}

OrganizationsPostOpts Optional parameters for the method 'OrganizationsPost'

type OutboundProfiles 

type OutboundProfiles struct {
	// Outbound authentication credentials if __routeType__ is 'proxy'.  Can be null to indicate no credentials.
	AuthenticationProfile string `json:"authenticationProfile,omitempty"`
	// The route type.  Values are either: 'proxy' or 'policy'.    Can be null and defaults to *proxy*.
	RouteType string `json:"routeType,omitempty"`
	// Request policy that applies to all outbound requests.  Can be null to indicate no policy.
	RequestPolicy string `json:"requestPolicy,omitempty"`
	// Response policy that applies to all responses from outbound requests.  Can be null to indicate no policy.
	ResponsePolicy string `json:"responsePolicy,omitempty"`
	// Route policy if the routeType is 'policy', in which case it must be a valid policy ID.  Can be null if __routeType__ is 'proxy'.
	RoutePolicy string `json:"routePolicy,omitempty"`
	// Fault handler policy that gets executed in the event of an error.  Can be null to indicate no policy.
	FaultHandlerPolicy string `json:"faultHandlerPolicy,omitempty"`
	// Route to a different API.  Can be null.  Ignored on the 'default' outbound profile.
	ApiId string `json:"apiId,omitempty"`
	// Route to a different API method.  Can be null.  Ignored on the 'default' outbound profile.
	ApiMethodId string `json:"apiMethodId,omitempty"`
	// A list of outbound parameters values - maps from frontend parameters to backend parameters.
	Parameters []ParamValue `json:"parameters,omitempty"`
}

OutboundProfiles Outbound profiles

type ParamValue 

type ParamValue struct {
	// The parameter name.
	Name string `json:"name,omitempty"`
	// The type of parameter type.  Can be one of: *body*, *query*, *path*, *form*, or *header*.
	ParamType string `json:"paramType,omitempty"`
	// The parameter data type.  Can be one of: *string*, *integer*, etc.
	Type string `json:"type,omitempty"`
	// The parameter value.  Can be a regular value, or a selector, e.g.: ${params.path.id}.
	Value string `json:"value,omitempty"`
	// Indicates whether or not the parameter is required for the backend API.
	Required bool `json:"required,omitempty"`
	// Indicates whether or not the parameter is excluded for the backend API.
	Exclude bool `json:"exclude,omitempty"`
	// Indicates whether or not the parameter is an additional parameter (does not replace an existing parameter).
	Additional bool `json:"additional,omitempty"`
}

ParamValue Outbound parameter value.

type Parameter 

type Parameter struct {
	// The parameter name.
	Name string `json:"name,omitempty"`
	// The parameter data type, e.g. *boolean*, *byte*, *date*, *double*, *float*, *integer*, *long*, *string*, or a type name found in [APIDefinition models](APIDefinition.html#models).
	Type        string `json:"type,omitempty"`
	Format      string `json:"format,omitempty"`
	Description string `json:"description,omitempty"`
	// Indicates that the parameter is required
	Required bool `json:"required,omitempty"`
	// Indicates that the parameter can be included multiple times (e.g. query or form)
	AllowMultiple bool         `json:"allowMultiple,omitempty"`
	Items         SchemaObject `json:"items,omitempty"`
	// Provides a default value for the parameter
	DefaultValue string       `json:"defaultValue,omitempty"`
	Schema       SchemaObject `json:"schema,omitempty"`
	// The parameter type, e.g. query, form, path, body, header
	ParamType string `json:"paramType,omitempty"`
}

Parameter An API operation parameter for a Method(Method.html), as part of the [APIDefinition](APIDefinition.html).

type PermissionDto 

type PermissionDto struct {
	// The permission identifier
	Id string `json:"id,omitempty"`
	// The user identifier
	UserId string `json:"userId,omitempty"`
	// The privilege
	Permission string `json:"permission,omitempty"`
	// The unique identifier for user that create the permission
	CreatedBy string `json:"createdBy,omitempty"`
	// Epoch/Unix time stamp when the permission was created
	CreatedOn int64 `json:"createdOn,omitempty"`
}

PermissionDto API Manager application permission.

type PortalTrafficListener 

type PortalTrafficListener struct {
	// The service listener identifier
	Id string `json:"id"`
	// The name of the service listener
	Name string `json:"name"`
	// The listener protocol
	Protocol string `json:"protocol"`
	// The listener port
	Port int32 `json:"port"`
	// The listener prefix
	Prefix string `json:"prefix,omitempty"`
	// The listener address
	Address string `json:"address"`
	// The listener URL
	Url string `json:"url,omitempty"`
}

PortalTrafficListener A HTTP service listener.

type ProxiesGetOpts 

type ProxiesGetOpts struct {
	Field optional.Interface
	Op    optional.Interface
	Value optional.Interface
}

ProxiesGetOpts Optional parameters for the method 'ProxiesGet'

type ProxiesIdDeprecatePostOpts 

type ProxiesIdDeprecatePostOpts struct {
	RetirementDate optional.String
}

ProxiesIdDeprecatePostOpts Optional parameters for the method 'ProxiesIdDeprecatePost'

type ProxiesIdImagePostOpts 

type ProxiesIdImagePostOpts struct {
	Type_ optional.String
	File  optional.Interface
}

ProxiesIdImagePostOpts Optional parameters for the method 'ProxiesIdImagePost'

type QuotaApiConstraintDto 

type QuotaApiConstraintDto struct {
	// The API identifier from API discovery, or '\\*' for all API
	Api string `json:"api,omitempty"`
	// The API method identifier from API discovery, or '\\*' for all methods
	Method string `json:"method,omitempty"`
	// The restriction type, one of: throttle, throttlemb
	Type string `json:"type"`
	// The restriction configuration
	Config map[string]string `json:"config,omitempty"`
}

QuotaApiConstraintDto The APIConstraint is restriction that applies to API(s) and API method(s).

type QuotaDto 

type QuotaDto struct {
	// The quota identifier
	Id string `json:"id"`
	// The quota type, either API or APPLICATION
	Type string `json:"type"`
	// The name of the quota
	Name string `json:"name"`
	// The quota for MyApplication the overrides default Application quota
	Description string `json:"description,omitempty"`
	// An array of restrictions imposed on the quota
	Restrictions []QuotaApiConstraintDto `json:"restrictions,omitempty"`
	// Indicates if the quota is system (protected)
	System bool `json:"system,omitempty"`
}

QuotaDto The Quota is a set of restrictions that apply to applications in the Portal.

type QuotasApiService 

type QuotasApiService service

QuotasApiService QuotasApi service

func (*QuotasApiService) QuotasGet 

func (a *QuotasApiService) QuotasGet(ctx _context.Context) (QuotaDto, *_nethttp.Response, error)

QuotasGet Returns all quotas This method may be called by any member of the Portal, however only the API Administrator may retrieve the system quota.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return QuotaDto

func (*QuotasApiService) QuotasIdDelete 

func (a *QuotasApiService) QuotasIdDelete(ctx _context.Context, id string) (*_nethttp.Response, error)

QuotasIdDelete Deletes a quota Deletes a quota. Only API Administrators may update quotas. Default system and application quotas may not be deleted.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The quota ID to delete.

func (*QuotasApiService) QuotasIdGet 

func (a *QuotasApiService) QuotasIdGet(ctx _context.Context, id string) (QuotaDto, *_nethttp.Response, error)

QuotasIdGet Returns the quota with the given ID Returns a quota. This method may be called by any member of the Portal, however, only API Administrators may retrieve the system quota.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The quota ID to retrieve.

@return QuotaDto

func (*QuotasApiService) QuotasIdPut 

func (a *QuotasApiService) QuotasIdPut(ctx _context.Context, id string, localVarOptionals *QuotasIdPutOpts) (QuotaDto, *_nethttp.Response, error)

QuotasIdPut Updates a quota Updates an existing quota. Only API Administrators may update quotas.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param optional nil or *QuotasIdPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of QuotaDto) -

@return QuotaDto

func (*QuotasApiService) QuotasPost 

func (a *QuotasApiService) QuotasPost(ctx _context.Context, localVarOptionals *QuotasPostOpts) (QuotaDto, *_nethttp.Response, error)

QuotasPost Creates a new quota Creates a new quota. Only API Administrators may create quotas.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *QuotasPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of QuotaDto) -

@return QuotaDto

type QuotasIdPutOpts 

type QuotasIdPutOpts struct {
	Body optional.Interface
}

QuotasIdPutOpts Optional parameters for the method 'QuotasIdPut'

type QuotasPostOpts 

type QuotasPostOpts struct {
	Body optional.Interface
}

QuotasPostOpts Optional parameters for the method 'QuotasPost'

type ReferencedEntity 

type ReferencedEntity struct {
	// Name of the referenced entity (as specified in Policy Studio configuration).
	Name string `json:"name"`
	// Portable version of the ESPK of this referenced entity, formatted as an XML fragment.
	Id string `json:"id"`
}

ReferencedEntity Referenced entity.

type RegistrationToken 

type RegistrationToken struct {
	// The registration code
	Token string `json:"token,omitempty"`
	// Unique identifier for the organization who the registration code applies to
	OrganizationId string `json:"organizationId,omitempty"`
	// Epoch/Unix time stamp when the registration code will expire
	Expiry int64 `json:"expiry,omitempty"`
	// Epoch/Unix time stamp when the registration code was created
	CreatedOn int64 `json:"createdOn,omitempty"`
	// The unique identifier for user that created the registration code
	CreatedBy string `json:"createdBy,omitempty"`
	// The remaining number of users that can use the registration code for self registration to an organization
	UserQuota int32 `json:"userQuota,omitempty"`
	// The total number of users that can use the registration code for self registration to an organization since the code has been created
	MaxUsers int32 `json:"maxUsers,omitempty"`
	// Flag disables registration code so that it can no longer be used for registration
	Enabled bool `json:"enabled,omitempty"`
}

RegistrationToken Organization Registration Token.

type RemoteHost 

type RemoteHost struct {
	// The unique identifier for the remote host
	Id string `json:"id,omitempty"`
	// The host name of the remote host
	Name string `json:"name"`
	// The host port of the remote host
	Port int32 `json:"port"`
	// Epoch/Unix time stamp when the remote host was created
	CreatedOn int64 `json:"createdOn,omitempty"`
	// The unique identifier for user that created the remote host
	CreatedBy string `json:"createdBy,omitempty"`
	// The organization identifier to which the remote host belongs
	OrganizationId string `json:"organizationId,omitempty"`
	// The maximum number of connections to open to a Remote Host. If the maximum number of connections has already been established, the API Gateway instance waits for a connection to drop or become idle before making another request. The default value is -1, meaning there is no limit
	MaxConnections int32 `json:"maxConnections,omitempty"`
	// Enables the API Gateway to use HTTP 1.1 when connecting to the remote host. Default value is false, meaning HTTP 1.0 is used
	AllowHTTP11 bool `json:"allowHTTP11,omitempty"`
	// If this option is set, the API Gateway will include the Content-Length HTTP header in all requests to this Remote Host. Default value is false.
	IncludeContentLengthRequest bool `json:"includeContentLengthRequest,omitempty"`
	// If this option is set, if the API Gateway receives a response from this Remote Host that contains a Content-Length HTTP header, it returns this length to the client. Default value is false.
	IncludeContentLengthResponse bool `json:"includeContentLengthResponse,omitempty"`
	// Adds a field to outbound TLS/SSL calls that shows the name that the client used to connect. Default value is false.
	OfferTLSServerName bool `json:"offerTLSServerName,omitempty"`
	// Ensures that the certificate presented by the server matches the name of the remote host being connected to. This prevents host spoofing and man-in-the-middle attacks. Default value is false.
	VerifyServerHostname bool `json:"verifyServerHostname,omitempty"`
	// If a connection to this remote host is not established within the time set in this field, the connection times out and the connection fails. Default value is 30000 milliseconds (30 seconds).
	ConnectionTimeout int64 `json:"connectionTimeout,omitempty"`
	// The maximum amount of time permitted between reading successive blocks of data. If the Active Timeout is exceeded, the API Gateway closes the connection. This prevents a Remote Host from closing the connection while sending data. Default value is 30000 milliseconds (30 seconds).
	ActiveTimeout int64 `json:"activeTimeout,omitempty"`
	// The maximum amount of time permitted to complete the transaction. Default value is 240000 milliseconds (4 minutes).
	TransactionTimeout int64 `json:"transactionTimeout,omitempty"`
	// The maximum amount of time that API Gateway waits after sending a message over a persistent connection to the Remote Host before it closes the connection. Default value is 15000 milliseconds (15 seconds).
	IdleTimeout int64 `json:"idleTimeout,omitempty"`
	// The maximum amount of data the API Gateway can receive per transaction. Default value is 20971520 bytes (20MiB).
	MaxReceiveBytes int64 `json:"maxReceiveBytes,omitempty"`
	// The maximum amount of data the API Gateway can transmit per transaction. Default value is 20971520 bytes (20MiB).
	MaxSendBytes int64 `json:"maxSendBytes,omitempty"`
	// The maximum amount of memory allocated to each request. Default value is 8192 bytes.
	InputBufferSize int64 `json:"inputBufferSize,omitempty"`
	// The maximum amount of memory allocated to each response. Default value is 8192 bytes.
	OutputBufferSize int64 `json:"outputBufferSize,omitempty"`
	// The period of time to cache addressing information after it has been received from the naming service. Default value is 300000 milliseconds (5 minutes)
	AddressCacheTimeout int64 `json:"addressCacheTimeout,omitempty"`
	// Specifies the size of the SSL session cache for connections to the remote host, which controls the number of idle SSL sessions that can be kept in memory. Default value is 32.
	SslSessionCacheSize int32 `json:"sslSessionCacheSize,omitempty"`
	// Specifies the HTTP content encodings that the API Gateway can accept from peers. Supported encodings: *deflate*, *gzip*. If no encodings are specified the default encoding is applied.
	InputEncodings []string `json:"inputEncodings,omitempty"`
	// Specifies the HTTP content encodings that the API Gateway can apply to outgoing messages. Supported encodings: *deflate*, *gzip*. If no encodings are specified the default encoding is applied.
	OutputEncodings []string `json:"outputEncodings,omitempty"`
	// Specifies whether to add the X-CorrelationID header to outbound messages
	ExportCorrelationId bool `json:"exportCorrelationId,omitempty"`
}

RemoteHost An API Manager-registered remote host.

type RemotehostsIdPutOpts 

type RemotehostsIdPutOpts struct {
	Body optional.Interface
}

RemotehostsIdPutOpts Optional parameters for the method 'RemotehostsIdPut'

type RemotehostsPostOpts 

type RemotehostsPostOpts struct {
	Body optional.Interface
}

RemotehostsPostOpts Optional parameters for the method 'RemotehostsPost'

type ResponseCode 

type ResponseCode struct {
	// The response code
	Code int64 `json:"code,omitempty"`
	// The response message
	Message string       `json:"message,omitempty"`
	Schema  SchemaObject `json:"schema,omitempty"`
}

ResponseCode An operation response code.

type SchemaObject 

type SchemaObject struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      []SchemaObject          `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example       map[string]interface{} `json:"example,omitempty"`
	Discriminator string                 `json:"discriminator,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The type ex: array , boolean, integer , null , number, object, string
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

SchemaObject struct for SchemaObject

type Scope 

type Scope struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example       map[string]interface{} `json:"example,omitempty"`
	Discriminator string                 `json:"discriminator,omitempty"`
	// The OAuth2 scope name.
	Scope string `json:"scope,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The type ex: array , boolean, integer , null , number, object, string
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

Scope struct for Scope

type SecurityDevice 

type SecurityDevice struct {
	// Unique name of the Security Device.
	Name string `json:"name,omitempty"`
	// The Security device type.  Values are one of: *apiKey*, *awsHeader*, *awsQuery*, *basic*, *authPolicy*, *oauth*, *oauthExternal*, *passThrough*, or *twoWaySSL*.
	Type string `json:"type,omitempty"`
	// Specifies the order in which this device will be invoked.
	Order int32 `json:"order,omitempty"`
	// List of device-specific properties.
	Properties map[string]string `json:"properties,omitempty"`
}

SecurityDevice Inbound security device.

type SecurityProfile 

type SecurityProfile struct {
	// Unique name of the Profile
	Name string `json:"name,omitempty"`
	// Indicates that this is the default profile.  There can be only one default.
	IsDefault bool `json:"isDefault,omitempty"`
	// List of SecurityDevice for this security profile
	Devices []SecurityDevice `json:"devices,omitempty"`
}

SecurityProfile Inbound security profile.

type Series 

type Series struct {
	// The metric type name
	Name string `json:"name,omitempty"`
	// The amount of time, in milliseconds, between data points
	PointInterval int64 `json:"pointInterval,omitempty"`
	// The time of the first data point in milliseconds
	PointStart int64 `json:"pointStart,omitempty"`
	// The a metric measurement at a specific time interval
	Data []float32 `json:"data,omitempty"`
}

Series A metric time series.

type ServerConfiguration 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type Service 

type Service struct {
	Id             string            `json:"id,omitempty"`
	Name           string            `json:"name,omitempty"`
	Type           string            `json:"type,omitempty"`
	Scheme         string            `json:"scheme,omitempty"`
	HostID         string            `json:"hostID,omitempty"`
	ManagementPort int32             `json:"managementPort,omitempty"`
	Tags           map[string]string `json:"tags,omitempty"`
	Enabled        bool              `json:"enabled,omitempty"`
}

Service struct for Service

type ServiceDiscoveryInstanceTypePostOpts 

type ServiceDiscoveryInstanceTypePostOpts struct {
	Host     optional.String
	Port     optional.String
	Username optional.String
	Password optional.String
}

ServiceDiscoveryInstanceTypePostOpts Optional parameters for the method 'ServiceDiscoveryInstanceTypePost'

type ServiceProfiles 

type ServiceProfiles struct {
	// The backend service API identifier
	ApiId string `json:"apiId,omitempty"`
	// The backend service base path URL
	BasePath string `json:"basePath,omitempty"`
}

ServiceProfiles Service profile configuration for backend services

type Swagger 

type Swagger struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example       map[string]interface{} `json:"example,omitempty"`
	Discriminator string                 `json:"discriminator,omitempty"`
	// The API version
	ApiVersion string `json:"apiVersion,omitempty"`
	// The Swagger version
	SwaggerVersion string `json:"swaggerVersion,omitempty"`
	// The base path
	BasePath string `json:"basePath,omitempty"`
	// The resource path hosted
	ResourcePath string `json:"resourcePath,omitempty"`
	// The models/schema for the API
	Models map[string]map[string]interface{} `json:"models,omitempty"`
	// The content types that the API consumes
	Consumes []string `json:"consumes,omitempty"`
	// The content types that the API produces
	Produces []string `json:"produces,omitempty"`
	// The Authorization schemes provided for this API
	Authorizations map[string]Authorization `json:"authorizations,omitempty"`
	// The name of the API
	Name string `json:"name,omitempty"`
	// Brief summary of the API.
	Summary         string                 `json:"summary,omitempty"`
	SecurityProfile SwaggerSecurityProfile `json:"securityProfile,omitempty"`
	// Array of basePaths supported for this API/service, based on the configured ports
	BasePaths []string `json:"basePaths,omitempty"`
	// API image URL
	Image string `json:"image,omitempty"`
	// The state of the API.  Possible values: 'pending', 'unpublished', or 'published'.
	State string `json:"state,omitempty"`
	// Indicates that the API is CORS enabled
	Cors bool `json:"cors,omitempty"`
	// Indicates that the API is expired.
	Expired bool `json:"expired,omitempty"`
	// Indicates that the API is deprecated.  If 'true', then the API may have a 'retirementDate'.
	Deprecated bool `json:"deprecated,omitempty"`
	// Indicates that the API is deprecated and will be retired on the supplied date (in milliseconds).
	RetirementDate int64 `json:"retirementDate,omitempty"`
	// The list of tags associated with this API. Each tag can have multiple values
	Tags map[string][]string `json:"tags,omitempty"`
	// The documentation URL for the operation
	DocumentationUrl string `json:"documentationUrl,omitempty"`
	// The schema definitions that this API supports and links to those definitions.
	AvailableApiDefinitions map[string]string `json:"availableApiDefinitions,omitempty"`
	// The SDK downloads that this API supports and links to those downloads.
	AvailableSDK map[string]string `json:"availableSDK,omitempty"`
	// The API resources
	Apis []Api `json:"apis,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The resource type. Possible values: 'rest', 'wsdl'
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

Swagger A Swagger API definition.

type SwaggerSecurityDevice 

type SwaggerSecurityDevice struct {
	// Type identifier for the device. Possible Values: HTTPBasicSecurityDevice, OAuthSecurityDevice, AWSRESTRequestSecurityDevice, AWSQueryStringRequestSecurityDevice, APIKeyOnlySecurityDevice, APIKeyAndSecretSecurityDevice, TwoWaySSLSecurityDevice
	Type string `json:"type,omitempty"`
	// Textual display name for the device
	TypeDisplayName string `json:"typeDisplayName,omitempty"`
	// Name of the device
	Name string `json:"name,omitempty"`
	// Order of preference, zero being highest. Devices will attempt to authenticate the incoming request using this order of preference.
	Order int32 `json:"order,omitempty"`
	// The list of scopes defined for the security device.
	Scopes []string `json:"scopes,omitempty"`
	// Specifies how scopes will be matched. Possible values: [ Any, All ]
	ScopeMatching string `json:"scopeMatching,omitempty"`
}

SwaggerSecurityDevice Security Device details.

type SwaggerSecurityProfile 

type SwaggerSecurityProfile struct {
	// List of Security Devices associated with this profile
	Devices []SwaggerSecurityDevice `json:"devices,omitempty"`
}

SwaggerSecurityProfile Security Profile details.

type SysconfigPutOpts 

type SysconfigPutOpts struct {
	Body optional.Interface
}

SysconfigPutOpts Optional parameters for the method 'SysconfigPut'

type SystemConfig 

type SystemConfig struct {
	// Returns a list of disabled APIs
	DisabledApis []string `json:"disabledApis,omitempty"`
}

SystemConfig API Manager system configuration

type TokenEndpoint 

type TokenEndpoint struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example       map[string]interface{} `json:"example,omitempty"`
	Discriminator string                 `json:"discriminator,omitempty"`
	// The URL of the token endpoint for the authentication code grant flow. The value should be in a URL format.
	Url string `json:"url,omitempty"`
	// An optional alternative name to standard 'access_code' OAuth2 parameter.
	TokenName string `json:"tokenName,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The type ex: array , boolean, integer , null , number, object, string
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

TokenEndpoint struct for TokenEndpoint

type TokenRequestEndpoint 

type TokenRequestEndpoint struct {
	// An identifier
	Id string `json:"id,omitempty"`
	// Schema title
	Title string `json:"title,omitempty"`
	// Description of the Schema
	Description string `json:"description,omitempty"`
	// The format ex: int32, int64, float, double, byte, binary, date, date-time or password
	Format string `json:"format,omitempty"`
	// Specifies if the parameter is required
	Required []string `json:"required,omitempty"`
	// Not used beacause our model does not support inline nested types
	Properties map[string]SchemaObject `json:"properties,omitempty"`
	Items      SchemaObject            `json:"items,omitempty"`
	// if the schema is an array specifies the items type
	Example       map[string]interface{} `json:"example,omitempty"`
	Discriminator string                 `json:"discriminator,omitempty"`
	// The URL of the authorization endpoint for the authentication code grant flow. The value should be in a URL format.
	Url string `json:"url,omitempty"`
	// An optional alternative name to standard \"client_id\" OAuth2 parameter.
	ClientIdName string `json:"clientIdName,omitempty"`
	// An optional alternative name to standard \"client_secret\" OAuth2 parameter.
	ClientSecretName string `json:"clientSecretName,omitempty"`
	// A Reference to a definition on definitions object
	Ref string `json:"$ref,omitempty"`
	// Default value for this schema if it is applicable
	Default map[string]interface{} `json:"default,omitempty"`
	// The type ex: array , boolean, integer , null , number, object, string
	Type string   `json:"type,omitempty"`
	Enum []string `json:"enum,omitempty"`
}

TokenRequestEndpoint struct for TokenRequestEndpoint

type Topology 

type Topology struct {
	Id               string           `json:"id,omitempty"`
	Version          int32            `json:"version,omitempty"`
	Timestamp        int64            `json:"timestamp,omitempty"`
	ProductVersion   string           `json:"productVersion,omitempty"`
	Hosts            []Host           `json:"hosts,omitempty"`
	Groups           []Group          `json:"groups,omitempty"`
	UniqueIdCounters map[string]int32 `json:"uniqueIdCounters,omitempty"`
	EmtEnabled       bool             `json:"emtEnabled,omitempty"`
	Services         []Service        `json:"services,omitempty"`
}

Topology struct for Topology

type User 

type User struct {
	// The unique identifier for the user
	Id string `json:"id,omitempty"`
	// The unique identifier for the organization to which the user belongs
	OrganizationId string `json:"organizationId,omitempty"`
	// The user's name
	Name string `json:"name,omitempty"`
	// A description of the user
	Description string `json:"description,omitempty"`
	// A unique login name for the user
	LoginName string `json:"loginName,omitempty"`
	// An email address for the user
	Email string `json:"email,omitempty"`
	// The user's phone number
	Phone string `json:"phone,omitempty"`
	// The user's mobile number
	Mobile string `json:"mobile,omitempty"`
	// The user's role, one of: user, oadmin, or admin
	Role string `json:"role,omitempty"`
	// The user's photo. To update the image, please refer to the API.
	Image string `json:"image,omitempty"`
	// Indicates whether or not the user account is enabled or not
	Enabled bool `json:"enabled,omitempty"`
	// Epoch/Unix time stamp when the organization was created
	CreatedOn int64 `json:"createdOn,omitempty"`
	// The current state of the account, one of: approved, pending
	State string `json:"state,omitempty"`
	// Indicates the type of user. Possible values: internal, external
	Type      string                      `json:"type,omitempty"`
	AuthAttrs AuthenticatedUserAttributes `json:"authAttrs,omitempty"`
	Dn        string                      `json:"dn,omitempty"`
}

User The API Manager user is a member of organizations.

type UsersApiService 

type UsersApiService service

UsersApiService UsersApi service

func (*UsersApiService) UsersForgotpasswordPost 

func (a *UsersApiService) UsersForgotpasswordPost(ctx _context.Context, email string, localVarOptionals *UsersForgotpasswordPostOpts) (*_nethttp.Response, error)

UsersForgotpasswordPost Allows a user to reset their password. When this method is invoked, an email is sent to the owner of _email_ to verify that they wish for their password to be reset. The owner of _email_ must click on a link to reset the password. The link should direct the user to [/resetpassword](#APIUsersresetForgottenPassword) with appropriate query paremeters. Redirect URLs may be specified for success and failure conditions. If redirect URLs are specified, they must be a known Static File listener configured in the gateway or the request will be rejected.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param email The email address of the user.
  • @param optional nil or *UsersForgotpasswordPostOpts - Optional Parameters:
  • @param "Success" (optional.String) - The redirect success location (e.g. /request-forgotten-pw-success)
  • @param "Failure" (optional.String) - The redirect failure location (e.g. /request-forgotten-pw-failed)

func (*UsersApiService) UsersGet 

func (a *UsersApiService) UsersGet(ctx _context.Context, localVarOptionals *UsersGetOpts) ([]User, *_nethttp.Response, error)

UsersGet Obtains a list of users Returns a list of users that are visible to the authenticated user. The list of users can be filtered using the expression: field=__field__&op=__op__&value=__value__. Optionally, you can add a logical operation for all expressions, using the form: &lop=AND|OR. By default, the logical operation is AND. Multiple expression filters can be used, specifying field, op, and value for each filter. The __field__ is one of: apiid : Matches the user if the user has explicit access to application(s) that are using the API, specified by ID appid : Matches the user if the user has explicit access to the application, specified by ID description : The user's description email : The user's email address enabled : The enabled state of the user, one of: enabled, disabled createdOn : The date the user was created on, time in ms, e.g.: 1372755998542 mobile : The user's mobile phone name : The name of the user loginName : The login name of the user orgid : Matches the user if the user is a member of the organization, specified by ID phone : The user's phone role : The user's role, one of: user or oadmin state : The user's current state, one of: approved, pending surname : The surname of the user The __op__ is an operation and is one of: eq : Equal ne : Not equal gt : Greater than lt : Less than ge : Greater than or equal le : Less than or equal like : Like gete : Greater than or equal to, and less than or equal to; the __value__ should be a lower-minimum and upper-maximum separated by comma, e.g: value=5,10 The __value__ will be compared against the __field__, according to the supplied __op__.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *UsersGetOpts - Optional Parameters:
  • @param "Field" (optional.Interface of []string) - Filter field name.
  • @param "Op" (optional.Interface of []string) - Filter operation.
  • @param "Value" (optional.Interface of []string) - Filter value

@return []User

func (*UsersApiService) UsersIdApprovePost 

func (a *UsersApiService) UsersIdApprovePost(ctx _context.Context, id string) (User, *_nethttp.Response, error)

UsersIdApprovePost Grants approval to a request to create a new user on the system. Approving user must be API Manager Administrator or an Organization Administrator of the user's organization with the correct privileges to approve new user requests.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the user to be approved.

@return User

func (*UsersApiService) UsersIdChangepasswordPost 

func (a *UsersApiService) UsersIdChangepasswordPost(ctx _context.Context, id string, newPassword string) (*_nethttp.Response, error)

UsersIdChangepasswordPost Updates the password for a given user. The authenticated user must be API Manager Administrator or an Organization Administrator of the user's organization with the correct privileges to invoke this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the user being updated.
  • @param newPassword The new password of the user being updated.

func (*UsersApiService) UsersIdDelete 

func (a *UsersApiService) UsersIdDelete(ctx _context.Context, id string) (*_nethttp.Response, error)

UsersIdDelete Deletes a user. Deletes a user with the given user ID. All the applications and keys associated with the deleted user remain in the organization and can be managed by the Organization Administrator or the API Administrator. The API Administrator can delete any user. The Organization Administrators can only delete users belonging to their organizations..

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The user ID to delete

func (*UsersApiService) UsersIdGet 

func (a *UsersApiService) UsersIdGet(ctx _context.Context, id string) (User, *_nethttp.Response, error)

UsersIdGet Retrieves the details for a given user. Retrieves user details, given a user ID. The API Manager Administrator may access all users, otherwise, the user ID must be a member of the authenticated user's own organization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the user to be retreived.

@return User

func (*UsersApiService) UsersIdImageGet 

func (a *UsersApiService) UsersIdImageGet(ctx _context.Context, id string) (*_nethttp.Response, error)

UsersIdImageGet Get the image for a user Returns the jpeg image associated with an user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The user ID whos image is to be returned

func (*UsersApiService) UsersIdImagePost 

func (a *UsersApiService) UsersIdImagePost(ctx _context.Context, id string, type_ string, file *os.File) (*_nethttp.Response, error)

UsersIdImagePost Set the image for a user Set the jpeg image to be associated with a user.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The user ID for which an image is to be updated
  • @param type_ This value should be unset
  • @param file The file input data

func (*UsersApiService) UsersIdPut 

func (a *UsersApiService) UsersIdPut(ctx _context.Context, id string, localVarOptionals *UsersIdPutOpts) (User, *_nethttp.Response, error)

UsersIdPut Updates the details for a given user. Updates user details, given a user ID. The API Manager Administrator may update all users, otherwise, the user ID must be a member of the authenticated user's own organization and the authenticated user must be an Organization Administrator.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the user being updated.
  • @param optional nil or *UsersIdPutOpts - Optional Parameters:
  • @param "Body" (optional.Interface of User) -

@return User

func (*UsersApiService) UsersIdResetpasswordPut 

func (a *UsersApiService) UsersIdResetpasswordPut(ctx _context.Context, id string) (User, *_nethttp.Response, error)

UsersIdResetpasswordPut Admin level function to reset the password for a given user. The authenticated user must be API Manager Administrator or an Organization Administrator of the user's organization with the correct privileges to invoke this method.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the user having password reset administratively.

@return User

func (*UsersApiService) UsersPost 

func (a *UsersApiService) UsersPost(ctx _context.Context, localVarOptionals *UsersPostOpts) (User, *_nethttp.Response, error)

UsersPost Admin function to create a new user on the system Creates a new user on the system. Only Organization Administrators and API Manager Administrators may create users. Custom properties can be included on create.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *UsersPostOpts - Optional Parameters:
  • @param "Body" (optional.Interface of User) -

@return User

func (*UsersApiService) UsersRegisterPost 

func (a *UsersApiService) UsersRegisterPost(ctx _context.Context, name string, email string, password string, localVarOptionals *UsersRegisterPostOpts) (*_nethttp.Response, error)

UsersRegisterPost Register a new user. Allows a user to register for an account on the system. A validation email request is sent to the provided email address to confirm ownership. The email should contain a link to [/validateuser](#APIUsersvalidateUser) with appropriate parameters. User properties (including custom properties) may be supplied as form parameters. The method will return JSON, but optionally, redirect URLs may be specified for success and failure conditions. If redirect URLs are specified, they must be a known Static File listener configured in the gateway or the request will be rejected.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name The name of the user to register.
  • @param email The unique email address of the user to register.
  • @param password The password of the user to register.
  • @param optional nil or *UsersRegisterPostOpts - Optional Parameters:
  • @param "Token" (optional.String) - The registration token to use.
  • @param "Success" (optional.String) - The redirect success location (e.g. '/registration-success')
  • @param "Failure" (optional.String) - The redirect failure location (e.g. '/registration-failed')

func (*UsersApiService) UsersResetpasswordGet 

func (a *UsersApiService) UsersResetpasswordGet(ctx _context.Context, email string, validator string) (*_nethttp.Response, error)

UsersResetpasswordGet Validates the user [/forgotpassword](#APIUsersforgotUserPassword) password request. User validation code and email address are expected as query string parameters. When invoked, an email will be sent to the user with their new password.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param email The email address of the user being validated.
  • @param validator Validation string for the user entry.

func (*UsersApiService) UsersValidateuserGet 

func (a *UsersApiService) UsersValidateuserGet(ctx _context.Context, email string, validator string) (*_nethttp.Response, error)

UsersValidateuserGet Validates the user [/register](#APIUsersregisterUser) request. User validation code and email address are expected as query parameters.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param email The email address of the user being validated.
  • @param validator Validation string for the user entry.

type UsersForgotpasswordPostOpts 

type UsersForgotpasswordPostOpts struct {
	Success optional.String
	Failure optional.String
}

UsersForgotpasswordPostOpts Optional parameters for the method 'UsersForgotpasswordPost'

type UsersGetOpts 

type UsersGetOpts struct {
	Field optional.Interface
	Op    optional.Interface
	Value optional.Interface
}

UsersGetOpts Optional parameters for the method 'UsersGet'

type UsersIdPutOpts 

type UsersIdPutOpts struct {
	Body optional.Interface
}

UsersIdPutOpts Optional parameters for the method 'UsersIdPut'

type UsersPostOpts 

type UsersPostOpts struct {
	Body optional.Interface
}

UsersPostOpts Optional parameters for the method 'UsersPost'

type UsersRegisterPostOpts 

type UsersRegisterPostOpts struct {
	Token   optional.String
	Success optional.String
	Failure optional.String
}

UsersRegisterPostOpts Optional parameters for the method 'UsersRegisterPost'

type VirtualizedApi 

type VirtualizedApi struct {
	// Unique ID of the virtualized API.
	Id string `json:"id"`
	// The organization that created the virtualized API.
	OrganizationId string `json:"organizationId"`
	// The identifier of the API that was virtualized.  This is the only attribute that is required to create a virtualized API.
	ApiId string `json:"apiId"`
	// The name of this virtualized API.
	Name string `json:"name"`
	// The API version.
	Version string `json:"version"`
	// The key for routing between two APIs on the same path.
	ApiRoutingKey string `json:"apiRoutingKey"`
	// The virtual host of this virtualized API.
	Vhost string `json:"vhost"`
	// The path that services this virtualized API.
	Path string `json:"path"`
	// Type of descripton to use.  One of: _manual_, _markdown_, _url_, or _original_ (default).
	DescriptionType string `json:"descriptionType"`
	// Markdown string to use as the description of the API.
	DescriptionManual string `json:"descriptionManual"`
	// Markdown file to use as the description of the API within the API Catalog.
	DescriptionMarkdown string `json:"descriptionMarkdown"`
	// External URL to use as the description of the API.
	DescriptionUrl string `json:"descriptionUrl"`
	// A short summary description of the API.
	Summary string `json:"summary"`
	// Immediately retires the virtualized API.
	Retired bool `json:"retired"`
	// Immediately expires the virtualized API.
	Expired bool `json:"expired"`
	// URI of the image to be used for this virtualized API. To update the image, please refer to the API.
	Image string `json:"image"`
	// Date to retire the virtualized API.  If _retired_ is true, this is the date on which it was retired.
	RetirementDate int64 `json:"retirementDate"`
	// Immediately deprecates the virtualized API.  If deprecated, then _retiredOn_ is optionally used to retire the virtualized API on the specified date.
	Deprecated bool `json:"deprecated"`
	// The state of the virtualized API.  One of: unpublished, pending, or published.
	State string `json:"state"`
	// Epoch/Unix time stamp when the virtualized API was created.
	CreatedOn int64 `json:"createdOn,omitempty"`
	// The unique identifier for user that created the virtualized API.
	CreatedBy string `json:"createdBy,omitempty"`
	// The suite of CORS Profiles for this virtualized API.
	CorsProfiles []CorsProfile `json:"corsProfiles"`
	// The suite of Security Profiles for this virtualized API.
	SecurityProfiles []SecurityProfile `json:"securityProfiles"`
	// The suite of Security Profiles for this virtualized API.
	AuthenticationProfiles []AuthenticationProfile `json:"authenticationProfiles"`
	// The inbound profiles that apply to the virtualized API.  There must always a *\\_default* profile.
	InboundProfiles map[string]InboundProfiles `json:"inboundProfiles"`
	// The outbound profiles that apply to the virtualized API.  There must always a *\\_default* profile.
	OutboundProfiles map[string]OutboundProfiles `json:"outboundProfiles,omitempty"`
	// The inbound profiles that apply to the virtualized API.  There must always a *\\_default* profile.
	ServiceProfiles map[string]ServiceProfiles `json:"serviceProfiles"`
	// The outbound profiles that apply to the virtualized API.  There must always a *\\_default* profile.
	CaCerts []CaCert `json:"caCerts"`
	// The list of tags associated with this API. Each tag can have multiple values
	Tags map[string][]string `json:"tags"`
}

VirtualizedApi Represents a virtualized, frontend API.

type VirtualizedApiMethod 

type VirtualizedApiMethod struct {
	// Unique ID of the method.
	Id string `json:"id,omitempty"`
	// The identifier of the [VirtualizedAPI](VirtualizedAPI.html).
	VirtualizedApiId string `json:"virtualizedApiId,omitempty"`
	// The virtualized method name.  This defaults to the original [APIDefinition](APIDefinition.html) method name.
	Name string `json:"name,omitempty"`
	// The reference identifier for the original [APIDefinition](APIDefinition.html) that was virtualized.
	ApiId string `json:"apiId,omitempty"`
	// The reference identifier for the original API [APIDefinition](APIDefinition.html) method that was virtualized.
	ApiMethodId string `json:"apiMethodId,omitempty"`
	// A summary of the API Method.
	Summary string `json:"summary,omitempty"`
	// The source for the method's description.  One of: *original*, *manual*, *markdown*, or *url*.  Defaults to *original*.
	DescriptionType string `json:"descriptionType,omitempty"`
	// Specifies a manual description, which can be markdown text.
	DescriptionManual string `json:"descriptionManual,omitempty"`
	// specifies a markdown file to use for description.
	DescriptionMarkdown string `json:"descriptionMarkdown,omitempty"`
	// Specifies a URL to use instead of description text.
	DescriptionUrl string `json:"descriptionUrl,omitempty"`
	// The list of tags associated with this API method. Each tag can have multiple values.
	Tags map[string][]string `json:"tags,omitempty"`
}

VirtualizedApiMethod Represents a virtualized API method as part of a frontend API.

type VirtualizedMethodExport 

type VirtualizedMethodExport struct {
	// Unique ID of the method.
	Id string `json:"id,omitempty"`
	// The identifier of the [VirtualizedAPI](VirtualizedAPI.html).
	VirtualizedApiId string `json:"virtualizedApiId,omitempty"`
	// The virtualized method name.  This defaults to the original [APIDefinition](APIDefinition.html) method name.
	Name string `json:"name,omitempty"`
	// The reference identifier for the original [APIDefinition](APIDefinition.html) that was virtualized.
	ApiId string `json:"apiId,omitempty"`
	// The reference identifier for the original API [APIDefinition](APIDefinition.html) method that was virtualized.
	ApiMethodId string `json:"apiMethodId,omitempty"`
	// A summary of the API Method.
	Summary string `json:"summary,omitempty"`
	// The source for the method's description.  One of: *original*, *manual*, *markdown*, or *url*.  Defaults to *original*.
	DescriptionType string `json:"descriptionType,omitempty"`
	// Specifies a manual description, which can be markdown text.
	DescriptionManual string `json:"descriptionManual,omitempty"`
	// specifies a markdown file to use for description.
	DescriptionMarkdown string `json:"descriptionMarkdown,omitempty"`
	// Specifies a URL to use instead of description text.
	DescriptionUrl string `json:"descriptionUrl,omitempty"`
	// The list of tags associated with this API method. Each tag can have multiple values.
	Tags map[string][]string `json:"tags,omitempty"`
	// Internal use only.
	Op string `json:"op,omitempty"`
}

VirtualizedMethodExport Frontend API method export.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.