apimgr

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

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

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

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

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

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

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

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

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

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

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

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

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

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 ¶