From 578dc428e6e873cf6162a6eccc4e45255465e856 Mon Sep 17 00:00:00 2001 From: DenisGNoonan Date: Wed, 8 May 2024 18:56:01 +0100 Subject: [PATCH] NONRTRIC-983: Servicemanager - Generate HTML docs for API Issue-ID: 983 Change-Id: Iec8ec40a946287825a468e9d7071ea56e73ff34c Signed-off-by: DenisGNoonan --- .gitignore | 1 + .readthedocs.yaml | 5 +- docs/conf.py | 17 +- docs/developer-guide.rst | 28 +- docs/openapi/Discover_Service.html | 5030 ++++++++++++++ docs/openapi/Events.html | 6241 +++++++++++++++++ docs/openapi/Invoker_Management.html | 9879 +++++++++++++++++++++++++++ docs/openapi/Provider_Management.html | 8102 ++++++++++++++++++++++ docs/openapi/Publish_Service.html | 11729 ++++++++++++++++++++++++++++++++ docs/openapi/Security.html | 11024 ++++++++++++++++++++++++++++++ servicemanager/generate.sh | 64 + 11 files changed, 52111 insertions(+), 9 deletions(-) create mode 100644 docs/openapi/Discover_Service.html create mode 100644 docs/openapi/Events.html create mode 100644 docs/openapi/Invoker_Management.html create mode 100644 docs/openapi/Provider_Management.html create mode 100644 docs/openapi/Publish_Service.html create mode 100644 docs/openapi/Security.html diff --git a/.gitignore b/.gitignore index f57aefb..53dde08 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ docs/_build/ .pydevproject go.work* servicemanager.tar.gz +servicemanager/openapi servicemanager/specs servicemanager/servicemanager servicemanager/internal/kongclearup diff --git a/.readthedocs.yaml b/.readthedocs.yaml index eb84485..95da239 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -22,9 +22,12 @@ formats: - htmlzip build: - os: ubuntu-22.04 + os: "ubuntu-22.04" tools: python: "3.11" + jobs: + post_build: + - cp --verbose --update docs/openapi/* $READTHEDOCS_OUTPUT/html python: install: diff --git a/docs/conf.py b/docs/conf.py index cce3ae6..311d5e7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,6 @@ # ============LICENSE_START=============================================== -# Copyright (C) 2022 Nordix Foundation. All rights reserved. +# Copyright (C) 2022-2023 Nordix Foundation. All rights reserved. +# Copyright (C) 2024: OpenInfra Foundation Europe # ======================================================================== # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -27,7 +28,19 @@ linkcheck_ignore = [ 'https://gerrit.o-ran-sc.org.*', ] -extensions = ['sphinx.ext.intersphinx',] +extensions = [ + 'sphinx.ext.intersphinx', +] + +html_extra_path = [ + 'openapi', +] + +source_suffix = { + '.rst': 'restructuredtext', +} + +exclude_patterns = ['_build', 'requirements-docs.txt'] #intershpinx mapping with other projects intersphinx_mapping = {} diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 0bbf325..b83b074 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,13 +1,29 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright (C) 2022-2023 Nordix -.. Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved. - +.. Copyright (C) 2024 OpenInfra Foundation Europe Developer Guide =============== -* This document provides a quick start for developers of the Non-RT RIC Service Management & Exposure. -* Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_. -* To build and run the CAPIF Core implementation, see the README.md file in the "capifcore" folder. -* To build and run the Service Manager implementation, see the README.md file in the "servicemanager" folder. +This document provides a quick start for developers of the Non-RT RIC Service Management & Exposure. Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_. + +To build and run the Service Manager implementation, see the README.md file in the "servicemanager" folder. To build and run the CAPIF Core implementation, see the README.md file in the "capifcore" folder. To view the Open API specs common to Service Manager and CAPIF, please see the following. + +.. raw:: html + + + +To view the Open API specs supported by CAPIF only, please see below. + +.. raw:: html + + diff --git a/docs/openapi/Discover_Service.html b/docs/openapi/Discover_Service.html new file mode 100644 index 0000000..d3ce2b2 --- /dev/null +++ b/docs/openapi/Discover_Service.html @@ -0,0 +1,5030 @@ + + + + + CAPIF_Discover_Service_API + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

CAPIF_Discover_Service_API

+
+
+
+ +
+
+

Default

+
+
+
+

allServiceAPIsGet

+

+
+
+
+

+

Discover published service APIs and retrieve a collection of APIs according to certain filter criteria. +

+

+
+ 
/allServiceAPIs
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/service-apis/v1/allServiceAPIs?api-invoker-id=apiInvokerId_example&api-name=apiName_example&api-version=apiVersion_example&comm-type=&protocol=&aef-id=aefId_example&data-format=&api-cat=apiCat_example&preferred-aef-loc=&supported-features=supportedFeatures_example&api-supported-features=apiSupportedFeatures_example"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
+
+        String apiName = apiName_example; // String | API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
+
+        String apiVersion = apiVersion_example; // String | API major version the URI (e.g. v1).
+        CommunicationType commType = ; // CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE).
+        Protocol protocol = ; // Protocol | Protocol used by the API.
+        String aefId = aefId_example; // String | AEF identifer.
+        DataFormat dataFormat = ; // DataFormat | Data formats used by the API (e.g. serialization protocol JSON used).
+        String apiCat = apiCat_example; // String | The service API category to which the service API belongs to.
+        AefLocation preferredAefLoc = ; // AefLocation | The preferred AEF location.
+        String supportedFeatures = supportedFeatures_example; // String | Features supported by the NF consumer for the CAPIF Discover Service API.
+        String apiSupportedFeatures = apiSupportedFeatures_example; // String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
+
+
+        try {
+            DiscoveredAPIs result = apiInstance.allServiceAPIsGet(apiInvokerId, apiName, apiVersion, commType, protocol, aefId, dataFormat, apiCat, preferredAefLoc, supportedFeatures, apiSupportedFeatures);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#allServiceAPIsGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String apiInvokerId = new String(); // String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
+
+final String apiName = new String(); // String | API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
+
+final String apiVersion = new String(); // String | API major version the URI (e.g. v1).
+final CommunicationType commType = new CommunicationType(); // CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE).
+final Protocol protocol = new Protocol(); // Protocol | Protocol used by the API.
+final String aefId = new String(); // String | AEF identifer.
+final DataFormat dataFormat = new DataFormat(); // DataFormat | Data formats used by the API (e.g. serialization protocol JSON used).
+final String apiCat = new String(); // String | The service API category to which the service API belongs to.
+final AefLocation preferredAefLoc = new AefLocation(); // AefLocation | The preferred AEF location.
+final String supportedFeatures = new String(); // String | Features supported by the NF consumer for the CAPIF Discover Service API.
+final String apiSupportedFeatures = new String(); // String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
+
+
+try {
+    final result = await api_instance.allServiceAPIsGet(apiInvokerId, apiName, apiVersion, commType, protocol, aefId, dataFormat, apiCat, preferredAefLoc, supportedFeatures, apiSupportedFeatures);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->allServiceAPIsGet: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
+
+        String apiName = apiName_example; // String | API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
+
+        String apiVersion = apiVersion_example; // String | API major version the URI (e.g. v1).
+        CommunicationType commType = ; // CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE).
+        Protocol protocol = ; // Protocol | Protocol used by the API.
+        String aefId = aefId_example; // String | AEF identifer.
+        DataFormat dataFormat = ; // DataFormat | Data formats used by the API (e.g. serialization protocol JSON used).
+        String apiCat = apiCat_example; // String | The service API category to which the service API belongs to.
+        AefLocation preferredAefLoc = ; // AefLocation | The preferred AEF location.
+        String supportedFeatures = supportedFeatures_example; // String | Features supported by the NF consumer for the CAPIF Discover Service API.
+        String apiSupportedFeatures = apiSupportedFeatures_example; // String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
+
+
+        try {
+            DiscoveredAPIs result = apiInstance.allServiceAPIsGet(apiInvokerId, apiName, apiVersion, commType, protocol, aefId, dataFormat, apiCat, preferredAefLoc, supportedFeatures, apiSupportedFeatures);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#allServiceAPIsGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *apiInvokerId = apiInvokerId_example; // String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
+ (default to null)
+String *apiName = apiName_example; // API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
+ (optional) (default to null)
+String *apiVersion = apiVersion_example; // API major version the URI (e.g. v1). (optional) (default to null)
+CommunicationType *commType = ; // Communication type used by the API (e.g. REQUEST_RESPONSE). (optional) (default to null)
+Protocol *protocol = ; // Protocol used by the API. (optional) (default to null)
+String *aefId = aefId_example; // AEF identifer. (optional) (default to null)
+DataFormat *dataFormat = ; // Data formats used by the API (e.g. serialization protocol JSON used). (optional) (default to null)
+String *apiCat = apiCat_example; // The service API category to which the service API belongs to. (optional) (default to null)
+AefLocation *preferredAefLoc = ; // The preferred AEF location. (optional) (default to null)
+String *supportedFeatures = supportedFeatures_example; // Features supported by the NF consumer for the CAPIF Discover Service API. (optional) (default to null)
+String *apiSupportedFeatures = apiSupportedFeatures_example; // Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
+ (optional) (default to null)
+
+[apiInstance allServiceAPIsGetWith:apiInvokerId
+    apiName:apiName
+    apiVersion:apiVersion
+    commType:commType
+    protocol:protocol
+    aefId:aefId
+    dataFormat:dataFormat
+    apiCat:apiCat
+    preferredAefLoc:preferredAefLoc
+    supportedFeatures:supportedFeatures
+    apiSupportedFeatures:apiSupportedFeatures
+              completionHandler: ^(DiscoveredAPIs output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifDiscoverServiceApi = require('capif_discover_service_api');
+
+// Create an instance of the API class
+var api = new CapifDiscoverServiceApi.DefaultApi()
+var apiInvokerId = apiInvokerId_example; // {String} String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
+
+var opts = {
+  'apiName': apiName_example, // {String} API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
+
+  'apiVersion': apiVersion_example, // {String} API major version the URI (e.g. v1).
+  'commType': , // {CommunicationType} Communication type used by the API (e.g. REQUEST_RESPONSE).
+  'protocol': , // {Protocol} Protocol used by the API.
+  'aefId': aefId_example, // {String} AEF identifer.
+  'dataFormat': , // {DataFormat} Data formats used by the API (e.g. serialization protocol JSON used).
+  'apiCat': apiCat_example, // {String} The service API category to which the service API belongs to.
+  'preferredAefLoc': , // {AefLocation} The preferred AEF location.
+  'supportedFeatures': supportedFeatures_example, // {String} Features supported by the NF consumer for the CAPIF Discover Service API.
+  'apiSupportedFeatures': apiSupportedFeatures_example // {String} Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
+
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.allServiceAPIsGet(apiInvokerId, opts, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class allServiceAPIsGetExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var apiInvokerId = apiInvokerId_example;  // String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
+ (default to null)
+            var apiName = apiName_example;  // String | API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
+ (optional)  (default to null)
+            var apiVersion = apiVersion_example;  // String | API major version the URI (e.g. v1). (optional)  (default to null)
+            var commType = new CommunicationType(); // CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE). (optional)  (default to null)
+            var protocol = new Protocol(); // Protocol | Protocol used by the API. (optional)  (default to null)
+            var aefId = aefId_example;  // String | AEF identifer. (optional)  (default to null)
+            var dataFormat = new DataFormat(); // DataFormat | Data formats used by the API (e.g. serialization protocol JSON used). (optional)  (default to null)
+            var apiCat = apiCat_example;  // String | The service API category to which the service API belongs to. (optional)  (default to null)
+            var preferredAefLoc = new AefLocation(); // AefLocation | The preferred AEF location. (optional)  (default to null)
+            var supportedFeatures = supportedFeatures_example;  // String | Features supported by the NF consumer for the CAPIF Discover Service API. (optional)  (default to null)
+            var apiSupportedFeatures = apiSupportedFeatures_example;  // String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
+ (optional)  (default to null)
+
+            try {
+                DiscoveredAPIs result = apiInstance.allServiceAPIsGet(apiInvokerId, apiName, apiVersion, commType, protocol, aefId, dataFormat, apiCat, preferredAefLoc, supportedFeatures, apiSupportedFeatures);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.allServiceAPIsGet: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$apiInvokerId = apiInvokerId_example; // String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
+
+$apiName = apiName_example; // String | API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
+
+$apiVersion = apiVersion_example; // String | API major version the URI (e.g. v1).
+$commType = ; // CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE).
+$protocol = ; // Protocol | Protocol used by the API.
+$aefId = aefId_example; // String | AEF identifer.
+$dataFormat = ; // DataFormat | Data formats used by the API (e.g. serialization protocol JSON used).
+$apiCat = apiCat_example; // String | The service API category to which the service API belongs to.
+$preferredAefLoc = ; // AefLocation | The preferred AEF location.
+$supportedFeatures = supportedFeatures_example; // String | Features supported by the NF consumer for the CAPIF Discover Service API.
+$apiSupportedFeatures = apiSupportedFeatures_example; // String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
+
+
+try {
+    $result = $api_instance->allServiceAPIsGet($apiInvokerId, $apiName, $apiVersion, $commType, $protocol, $aefId, $dataFormat, $apiCat, $preferredAefLoc, $supportedFeatures, $apiSupportedFeatures);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->allServiceAPIsGet: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $apiInvokerId = apiInvokerId_example; # String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
+
+my $apiName = apiName_example; # String | API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
+
+my $apiVersion = apiVersion_example; # String | API major version the URI (e.g. v1).
+my $commType = ; # CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE).
+my $protocol = ; # Protocol | Protocol used by the API.
+my $aefId = aefId_example; # String | AEF identifer.
+my $dataFormat = ; # DataFormat | Data formats used by the API (e.g. serialization protocol JSON used).
+my $apiCat = apiCat_example; # String | The service API category to which the service API belongs to.
+my $preferredAefLoc = ; # AefLocation | The preferred AEF location.
+my $supportedFeatures = supportedFeatures_example; # String | Features supported by the NF consumer for the CAPIF Discover Service API.
+my $apiSupportedFeatures = apiSupportedFeatures_example; # String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
+
+
+eval {
+    my $result = $api_instance->allServiceAPIsGet(apiInvokerId => $apiInvokerId, apiName => $apiName, apiVersion => $apiVersion, commType => $commType, protocol => $protocol, aefId => $aefId, dataFormat => $dataFormat, apiCat => $apiCat, preferredAefLoc => $preferredAefLoc, supportedFeatures => $supportedFeatures, apiSupportedFeatures => $apiSupportedFeatures);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->allServiceAPIsGet: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+apiInvokerId = apiInvokerId_example # String | String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
+ (default to null)
+apiName = apiName_example # String | API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
+ (optional) (default to null)
+apiVersion = apiVersion_example # String | API major version the URI (e.g. v1). (optional) (default to null)
+commType =  # CommunicationType | Communication type used by the API (e.g. REQUEST_RESPONSE). (optional) (default to null)
+protocol =  # Protocol | Protocol used by the API. (optional) (default to null)
+aefId = aefId_example # String | AEF identifer. (optional) (default to null)
+dataFormat =  # DataFormat | Data formats used by the API (e.g. serialization protocol JSON used). (optional) (default to null)
+apiCat = apiCat_example # String | The service API category to which the service API belongs to. (optional) (default to null)
+preferredAefLoc =  # AefLocation | The preferred AEF location. (optional) (default to null)
+supportedFeatures = supportedFeatures_example # String | Features supported by the NF consumer for the CAPIF Discover Service API. (optional) (default to null)
+apiSupportedFeatures = apiSupportedFeatures_example # String | Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
+ (optional) (default to null)
+
+try:
+    api_response = api_instance.all_service_apis_get(apiInvokerId, apiName=apiName, apiVersion=apiVersion, commType=commType, protocol=protocol, aefId=aefId, dataFormat=dataFormat, apiCat=apiCat, preferredAefLoc=preferredAefLoc, supportedFeatures=supportedFeatures, apiSupportedFeatures=apiSupportedFeatures)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->allServiceAPIsGet: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let apiInvokerId = apiInvokerId_example; // String
+    let apiName = apiName_example; // String
+    let apiVersion = apiVersion_example; // String
+    let commType = ; // CommunicationType
+    let protocol = ; // Protocol
+    let aefId = aefId_example; // String
+    let dataFormat = ; // DataFormat
+    let apiCat = apiCat_example; // String
+    let preferredAefLoc = ; // AefLocation
+    let supportedFeatures = supportedFeatures_example; // String
+    let apiSupportedFeatures = apiSupportedFeatures_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.allServiceAPIsGet(apiInvokerId, apiName, apiVersion, commType, protocol, aefId, dataFormat, apiCat, preferredAefLoc, supportedFeatures, apiSupportedFeatures, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + +
Query parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
api-invoker-id* + + +
+
+
+ + String + + +
+String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface. + +
+
+
+ Required +
+
+
+
api-name + + +
+
+
+ + String + + +
+API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122. + +
+
+
+
+
api-version + + +
+
+
+ + String + + +
+API major version the URI (e.g. v1). +
+
+
+
+
comm-type + + +
+
+
+ + CommunicationType + + +
+Communication type used by the API (e.g. REQUEST_RESPONSE). +
+
+
+
+
protocol + + +
+
+
+ + Protocol + + +
+Protocol used by the API. +
+
+
+
+
aef-id + + +
+
+
+ + String + + +
+AEF identifer. +
+
+
+
+
data-format + + +
+
+
+ + DataFormat + + +
+Data formats used by the API (e.g. serialization protocol JSON used). +
+
+
+
+
api-cat + + +
+
+
+ + String + + +
+The service API category to which the service API belongs to. +
+
+
+
+
preferred-aef-loc + + +
+
+
+ + AefLocation + + +
+The preferred AEF location. +
+
+
+
+
supported-features + + +
+
+
+ + String + + +
+Features supported by the NF consumer for the CAPIF Discover Service API. +
+
+
+
+
api-supported-features + + +
+
+
+ + String + + +
+Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present. + +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/openapi/Events.html b/docs/openapi/Events.html new file mode 100644 index 0000000..e024966 --- /dev/null +++ b/docs/openapi/Events.html @@ -0,0 +1,6241 @@ + + + + + CAPIF_Events_API + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

CAPIF_Events_API

+
+
+
+ +
+
+

Default

+
+
+
+

subscriberIdSubscriptionsPost

+

+
+
+
+

+

Creates a new individual CAPIF Event Subscription.

+

+
+ 
/{subscriberId}/subscriptions
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/capif-events/v1/{subscriberId}/subscriptions" \
+ -d '{
+  "notificationDestination" : "notificationDestination",
+  "eventFilters" : [ {
+    "aefIds" : [ "aefIds", "aefIds" ],
+    "apiInvokerIds" : [ "apiInvokerIds", "apiInvokerIds" ],
+    "apiIds" : [ "apiIds", "apiIds" ]
+  }, {
+    "aefIds" : [ "aefIds", "aefIds" ],
+    "apiInvokerIds" : [ "apiInvokerIds", "apiInvokerIds" ],
+    "apiIds" : [ "apiIds", "apiIds" ]
+  } ],
+  "supportedFeatures" : "supportedFeatures",
+  "eventReq" : {
+    "grpRepTime" : 0,
+    "partitionCriteria" : [ null, null ],
+    "monDur" : "2000-01-23T04:56:07.000+00:00",
+    "immRep" : true,
+    "maxReportNbr" : 0,
+    "repPeriod" : 1,
+    "sampRatio" : 60
+  },
+  "websockNotifConfig" : {
+    "requestWebsocketUri" : true,
+    "websocketUri" : "websocketUri"
+  },
+  "events" : [ null, null ],
+  "requestTestNotification" : true
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+        EventSubscription eventSubscription = ; // EventSubscription | 
+
+        try {
+            EventSubscription result = apiInstance.subscriberIdSubscriptionsPost(subscriberId, eventSubscription);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#subscriberIdSubscriptionsPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String subscriberId = new String(); // String | Identifier of the Subscriber
+final EventSubscription eventSubscription = new EventSubscription(); // EventSubscription | 
+
+try {
+    final result = await api_instance.subscriberIdSubscriptionsPost(subscriberId, eventSubscription);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->subscriberIdSubscriptionsPost: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+        EventSubscription eventSubscription = ; // EventSubscription | 
+
+        try {
+            EventSubscription result = apiInstance.subscriberIdSubscriptionsPost(subscriberId, eventSubscription);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#subscriberIdSubscriptionsPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *subscriberId = subscriberId_example; // Identifier of the Subscriber (default to null)
+EventSubscription *eventSubscription = ; // 
+
+[apiInstance subscriberIdSubscriptionsPostWith:subscriberId
+    eventSubscription:eventSubscription
+              completionHandler: ^(EventSubscription output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifEventsApi = require('capif_events_api');
+
+// Create an instance of the API class
+var api = new CapifEventsApi.DefaultApi()
+var subscriberId = subscriberId_example; // {String} Identifier of the Subscriber
+var eventSubscription = ; // {EventSubscription} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.subscriberIdSubscriptionsPost(subscriberId, eventSubscription, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class subscriberIdSubscriptionsPostExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var subscriberId = subscriberId_example;  // String | Identifier of the Subscriber (default to null)
+            var eventSubscription = new EventSubscription(); // EventSubscription | 
+
+            try {
+                EventSubscription result = apiInstance.subscriberIdSubscriptionsPost(subscriberId, eventSubscription);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.subscriberIdSubscriptionsPost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+$eventSubscription = ; // EventSubscription | 
+
+try {
+    $result = $api_instance->subscriberIdSubscriptionsPost($subscriberId, $eventSubscription);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->subscriberIdSubscriptionsPost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $subscriberId = subscriberId_example; # String | Identifier of the Subscriber
+my $eventSubscription = WWW::OPenAPIClient::Object::EventSubscription->new(); # EventSubscription | 
+
+eval {
+    my $result = $api_instance->subscriberIdSubscriptionsPost(subscriberId => $subscriberId, eventSubscription => $eventSubscription);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->subscriberIdSubscriptionsPost: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+subscriberId = subscriberId_example # String | Identifier of the Subscriber (default to null)
+eventSubscription =  # EventSubscription | 
+
+try:
+    api_response = api_instance.subscriber_id_subscriptions_post(subscriberId, eventSubscription)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->subscriberIdSubscriptionsPost: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let subscriberId = subscriberId_example; // String
+    let eventSubscription = ; // EventSubscription
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.subscriberIdSubscriptionsPost(subscriberId, eventSubscription, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
subscriberId* + + +
+
+
+ + String + + +
+Identifier of the Subscriber +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
eventSubscription * +

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

subscriberIdSubscriptionsSubscriptionIdDelete

+

+
+
+
+

+

Deletes an individual CAPIF Event Subscription.

+

+
+ 
/{subscriberId}/subscriptions/{subscriptionId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X DELETE \
+ -H "Accept: application/problem+json" \
+ "https://example.com/capif-events/v1/{subscriberId}/subscriptions/{subscriptionId}"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+        String subscriptionId = subscriptionId_example; // String | Identifier of an individual Events Subscription
+
+        try {
+            apiInstance.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#subscriberIdSubscriptionsSubscriptionIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String subscriberId = new String(); // String | Identifier of the Subscriber
+final String subscriptionId = new String(); // String | Identifier of an individual Events Subscription
+
+try {
+    final result = await api_instance.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->subscriberIdSubscriptionsSubscriptionIdDelete: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+        String subscriptionId = subscriptionId_example; // String | Identifier of an individual Events Subscription
+
+        try {
+            apiInstance.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#subscriberIdSubscriptionsSubscriptionIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *subscriberId = subscriberId_example; // Identifier of the Subscriber (default to null)
+String *subscriptionId = subscriptionId_example; // Identifier of an individual Events Subscription (default to null)
+
+[apiInstance subscriberIdSubscriptionsSubscriptionIdDeleteWith:subscriberId
+    subscriptionId:subscriptionId
+              completionHandler: ^(NSError* error) {
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifEventsApi = require('capif_events_api');
+
+// Create an instance of the API class
+var api = new CapifEventsApi.DefaultApi()
+var subscriberId = subscriberId_example; // {String} Identifier of the Subscriber
+var subscriptionId = subscriptionId_example; // {String} Identifier of an individual Events Subscription
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class subscriberIdSubscriptionsSubscriptionIdDeleteExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var subscriberId = subscriberId_example;  // String | Identifier of the Subscriber (default to null)
+            var subscriptionId = subscriptionId_example;  // String | Identifier of an individual Events Subscription (default to null)
+
+            try {
+                apiInstance.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.subscriberIdSubscriptionsSubscriptionIdDelete: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+$subscriptionId = subscriptionId_example; // String | Identifier of an individual Events Subscription
+
+try {
+    $api_instance->subscriberIdSubscriptionsSubscriptionIdDelete($subscriberId, $subscriptionId);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->subscriberIdSubscriptionsSubscriptionIdDelete: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $subscriberId = subscriberId_example; # String | Identifier of the Subscriber
+my $subscriptionId = subscriptionId_example; # String | Identifier of an individual Events Subscription
+
+eval {
+    $api_instance->subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId => $subscriberId, subscriptionId => $subscriptionId);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->subscriberIdSubscriptionsSubscriptionIdDelete: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+subscriberId = subscriberId_example # String | Identifier of the Subscriber (default to null)
+subscriptionId = subscriptionId_example # String | Identifier of an individual Events Subscription (default to null)
+
+try:
+    api_instance.subscriber_id_subscriptions_subscription_id_delete(subscriberId, subscriptionId)
+except ApiException as e:
+    print("Exception when calling DefaultApi->subscriberIdSubscriptionsSubscriptionIdDelete: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let subscriberId = subscriberId_example; // String
+    let subscriptionId = subscriptionId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + + + + + +
NameDescription
subscriberId* + + +
+
+
+ + String + + +
+Identifier of the Subscriber +
+
+
+ Required +
+
+
+
subscriptionId* + + +
+
+
+ + String + + +
+Identifier of an individual Events Subscription +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/openapi/Invoker_Management.html b/docs/openapi/Invoker_Management.html new file mode 100644 index 0000000..bad6278 --- /dev/null +++ b/docs/openapi/Invoker_Management.html @@ -0,0 +1,9879 @@ + + + + + CAPIF_API_Invoker_Management_API + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

CAPIF_API_Invoker_Management_API

+
+
+
+ +
+
+

Default

+
+
+
+

onboardedInvokersOnboardingIdDelete

+

+
+
+
+

+

Deletes an individual API Invoker.

+

+
+ 
/onboardedInvokers/{onboardingId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X DELETE \
+ -H "Accept: application/problem+json" \
+ "https://example.com/api-invoker-management/v1/onboardedInvokers/{onboardingId}"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String onboardingId = onboardingId_example; // String | String identifying an individual on-boarded API invoker resource
+
+        try {
+            apiInstance.onboardedInvokersOnboardingIdDelete(onboardingId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#onboardedInvokersOnboardingIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String onboardingId = new String(); // String | String identifying an individual on-boarded API invoker resource
+
+try {
+    final result = await api_instance.onboardedInvokersOnboardingIdDelete(onboardingId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->onboardedInvokersOnboardingIdDelete: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String onboardingId = onboardingId_example; // String | String identifying an individual on-boarded API invoker resource
+
+        try {
+            apiInstance.onboardedInvokersOnboardingIdDelete(onboardingId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#onboardedInvokersOnboardingIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *onboardingId = onboardingId_example; // String identifying an individual on-boarded API invoker resource (default to null)
+
+[apiInstance onboardedInvokersOnboardingIdDeleteWith:onboardingId
+              completionHandler: ^(NSError* error) {
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifApiInvokerManagementApi = require('capif_api_invoker_management_api');
+
+// Create an instance of the API class
+var api = new CapifApiInvokerManagementApi.DefaultApi()
+var onboardingId = onboardingId_example; // {String} String identifying an individual on-boarded API invoker resource
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.onboardedInvokersOnboardingIdDelete(onboardingId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class onboardedInvokersOnboardingIdDeleteExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var onboardingId = onboardingId_example;  // String | String identifying an individual on-boarded API invoker resource (default to null)
+
+            try {
+                apiInstance.onboardedInvokersOnboardingIdDelete(onboardingId);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.onboardedInvokersOnboardingIdDelete: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$onboardingId = onboardingId_example; // String | String identifying an individual on-boarded API invoker resource
+
+try {
+    $api_instance->onboardedInvokersOnboardingIdDelete($onboardingId);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->onboardedInvokersOnboardingIdDelete: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $onboardingId = onboardingId_example; # String | String identifying an individual on-boarded API invoker resource
+
+eval {
+    $api_instance->onboardedInvokersOnboardingIdDelete(onboardingId => $onboardingId);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->onboardedInvokersOnboardingIdDelete: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+onboardingId = onboardingId_example # String | String identifying an individual on-boarded API invoker resource (default to null)
+
+try:
+    api_instance.onboarded_invokers_onboarding_id_delete(onboardingId)
+except ApiException as e:
+    print("Exception when calling DefaultApi->onboardedInvokersOnboardingIdDelete: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let onboardingId = onboardingId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.onboardedInvokersOnboardingIdDelete(onboardingId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
onboardingId* + + +
+
+
+ + String + + +
+String identifying an individual on-boarded API invoker resource +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

onboardedInvokersOnboardingIdPut

+

+
+
+
+

+

Updates an individual API invoker details.

+

+
+ 
/onboardedInvokers/{onboardingId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X PUT \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/api-invoker-management/v1/onboardedInvokers/{onboardingId}" \
+ -d '{
+  "notificationDestination" : "notificationDestination",
+  "supportedFeatures" : "supportedFeatures",
+  "apiInvokerId" : "apiInvokerId",
+  "apiInvokerInformation" : "apiInvokerInformation",
+  "websockNotifConfig" : {
+    "requestWebsocketUri" : true,
+    "websocketUri" : "websocketUri"
+  },
+  "onboardingInformation" : {
+    "apiInvokerPublicKey" : "apiInvokerPublicKey",
+    "onboardingSecret" : "onboardingSecret",
+    "apiInvokerCertificate" : "apiInvokerCertificate"
+  },
+  "requestTestNotification" : true,
+  "apiList" : [ {
+    "ccfId" : "ccfId",
+    "serviceAPICategory" : "serviceAPICategory",
+    "apiName" : "apiName",
+    "shareableInfo" : {
+      "capifProvDoms" : [ "capifProvDoms", "capifProvDoms" ],
+      "isShareable" : true
+    },
+    "supportedFeatures" : "supportedFeatures",
+    "description" : "description",
+    "apiSuppFeats" : "apiSuppFeats",
+    "aefProfiles" : [ {
+      "securityMethods" : [ null, null ],
+      "versions" : [ {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      }, {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      } ],
+      "domainName" : "domainName",
+      "aefLocation" : {
+        "dcId" : "dcId",
+        "geoArea" : {
+          "point" : {
+            "lon" : 36.988422590534526,
+            "lat" : -75.5850925717018
+          }
+        },
+        "civicAddr" : {
+          "POBOX" : "POBOX",
+          "usageRules" : "usageRules",
+          "country" : "country",
+          "PRD" : "PRD",
+          "PLC" : "PLC",
+          "HNO" : "HNO",
+          "PRM" : "PRM",
+          "HNS" : "HNS",
+          "FLR" : "FLR",
+          "A1" : "A1",
+          "A2" : "A2",
+          "A3" : "A3",
+          "A4" : "A4",
+          "STS" : "STS",
+          "A5" : "A5",
+          "A6" : "A6",
+          "RDSEC" : "RDSEC",
+          "providedBy" : "providedBy",
+          "LOC" : "LOC",
+          "SEAT" : "SEAT",
+          "UNIT" : "UNIT",
+          "POD" : "POD",
+          "RDBR" : "RDBR",
+          "method" : "method",
+          "LMK" : "LMK",
+          "POM" : "POM",
+          "ADDCODE" : "ADDCODE",
+          "RD" : "RD",
+          "PC" : "PC",
+          "PCN" : "PCN",
+          "BLD" : "BLD",
+          "NAM" : "NAM",
+          "ROOM" : "ROOM",
+          "RDSUBBR" : "RDSUBBR"
+        }
+      },
+      "aefId" : "aefId",
+      "interfaceDescriptions" : [ {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      }, {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      } ]
+    }, {
+      "securityMethods" : [ null, null ],
+      "versions" : [ {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      }, {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      } ],
+      "domainName" : "domainName",
+      "aefLocation" : {
+        "dcId" : "dcId",
+        "geoArea" : {
+          "point" : {
+            "lon" : 36.988422590534526,
+            "lat" : -75.5850925717018
+          }
+        },
+        "civicAddr" : {
+          "POBOX" : "POBOX",
+          "usageRules" : "usageRules",
+          "country" : "country",
+          "PRD" : "PRD",
+          "PLC" : "PLC",
+          "HNO" : "HNO",
+          "PRM" : "PRM",
+          "HNS" : "HNS",
+          "FLR" : "FLR",
+          "A1" : "A1",
+          "A2" : "A2",
+          "A3" : "A3",
+          "A4" : "A4",
+          "STS" : "STS",
+          "A5" : "A5",
+          "A6" : "A6",
+          "RDSEC" : "RDSEC",
+          "providedBy" : "providedBy",
+          "LOC" : "LOC",
+          "SEAT" : "SEAT",
+          "UNIT" : "UNIT",
+          "POD" : "POD",
+          "RDBR" : "RDBR",
+          "method" : "method",
+          "LMK" : "LMK",
+          "POM" : "POM",
+          "ADDCODE" : "ADDCODE",
+          "RD" : "RD",
+          "PC" : "PC",
+          "PCN" : "PCN",
+          "BLD" : "BLD",
+          "NAM" : "NAM",
+          "ROOM" : "ROOM",
+          "RDSUBBR" : "RDSUBBR"
+        }
+      },
+      "aefId" : "aefId",
+      "interfaceDescriptions" : [ {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      }, {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      } ]
+    } ],
+    "apiId" : "apiId",
+    "pubApiPath" : {
+      "ccfIds" : [ "ccfIds", "ccfIds" ]
+    }
+  }, {
+    "ccfId" : "ccfId",
+    "serviceAPICategory" : "serviceAPICategory",
+    "apiName" : "apiName",
+    "shareableInfo" : {
+      "capifProvDoms" : [ "capifProvDoms", "capifProvDoms" ],
+      "isShareable" : true
+    },
+    "supportedFeatures" : "supportedFeatures",
+    "description" : "description",
+    "apiSuppFeats" : "apiSuppFeats",
+    "aefProfiles" : [ {
+      "securityMethods" : [ null, null ],
+      "versions" : [ {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      }, {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      } ],
+      "domainName" : "domainName",
+      "aefLocation" : {
+        "dcId" : "dcId",
+        "geoArea" : {
+          "point" : {
+            "lon" : 36.988422590534526,
+            "lat" : -75.5850925717018
+          }
+        },
+        "civicAddr" : {
+          "POBOX" : "POBOX",
+          "usageRules" : "usageRules",
+          "country" : "country",
+          "PRD" : "PRD",
+          "PLC" : "PLC",
+          "HNO" : "HNO",
+          "PRM" : "PRM",
+          "HNS" : "HNS",
+          "FLR" : "FLR",
+          "A1" : "A1",
+          "A2" : "A2",
+          "A3" : "A3",
+          "A4" : "A4",
+          "STS" : "STS",
+          "A5" : "A5",
+          "A6" : "A6",
+          "RDSEC" : "RDSEC",
+          "providedBy" : "providedBy",
+          "LOC" : "LOC",
+          "SEAT" : "SEAT",
+          "UNIT" : "UNIT",
+          "POD" : "POD",
+          "RDBR" : "RDBR",
+          "method" : "method",
+          "LMK" : "LMK",
+          "POM" : "POM",
+          "ADDCODE" : "ADDCODE",
+          "RD" : "RD",
+          "PC" : "PC",
+          "PCN" : "PCN",
+          "BLD" : "BLD",
+          "NAM" : "NAM",
+          "ROOM" : "ROOM",
+          "RDSUBBR" : "RDSUBBR"
+        }
+      },
+      "aefId" : "aefId",
+      "interfaceDescriptions" : [ {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      }, {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      } ]
+    }, {
+      "securityMethods" : [ null, null ],
+      "versions" : [ {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      }, {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      } ],
+      "domainName" : "domainName",
+      "aefLocation" : {
+        "dcId" : "dcId",
+        "geoArea" : {
+          "point" : {
+            "lon" : 36.988422590534526,
+            "lat" : -75.5850925717018
+          }
+        },
+        "civicAddr" : {
+          "POBOX" : "POBOX",
+          "usageRules" : "usageRules",
+          "country" : "country",
+          "PRD" : "PRD",
+          "PLC" : "PLC",
+          "HNO" : "HNO",
+          "PRM" : "PRM",
+          "HNS" : "HNS",
+          "FLR" : "FLR",
+          "A1" : "A1",
+          "A2" : "A2",
+          "A3" : "A3",
+          "A4" : "A4",
+          "STS" : "STS",
+          "A5" : "A5",
+          "A6" : "A6",
+          "RDSEC" : "RDSEC",
+          "providedBy" : "providedBy",
+          "LOC" : "LOC",
+          "SEAT" : "SEAT",
+          "UNIT" : "UNIT",
+          "POD" : "POD",
+          "RDBR" : "RDBR",
+          "method" : "method",
+          "LMK" : "LMK",
+          "POM" : "POM",
+          "ADDCODE" : "ADDCODE",
+          "RD" : "RD",
+          "PC" : "PC",
+          "PCN" : "PCN",
+          "BLD" : "BLD",
+          "NAM" : "NAM",
+          "ROOM" : "ROOM",
+          "RDSUBBR" : "RDSUBBR"
+        }
+      },
+      "aefId" : "aefId",
+      "interfaceDescriptions" : [ {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      }, {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      } ]
+    } ],
+    "apiId" : "apiId",
+    "pubApiPath" : {
+      "ccfIds" : [ "ccfIds", "ccfIds" ]
+    }
+  } ]
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String onboardingId = onboardingId_example; // String | String identifying an individual on-boarded API invoker resource
+        APIInvokerEnrolmentDetails aPIInvokerEnrolmentDetails = ; // APIInvokerEnrolmentDetails | 
+
+        try {
+            APIInvokerEnrolmentDetails result = apiInstance.onboardedInvokersOnboardingIdPut(onboardingId, aPIInvokerEnrolmentDetails);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#onboardedInvokersOnboardingIdPut");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String onboardingId = new String(); // String | String identifying an individual on-boarded API invoker resource
+final APIInvokerEnrolmentDetails aPIInvokerEnrolmentDetails = new APIInvokerEnrolmentDetails(); // APIInvokerEnrolmentDetails | 
+
+try {
+    final result = await api_instance.onboardedInvokersOnboardingIdPut(onboardingId, aPIInvokerEnrolmentDetails);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->onboardedInvokersOnboardingIdPut: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String onboardingId = onboardingId_example; // String | String identifying an individual on-boarded API invoker resource
+        APIInvokerEnrolmentDetails aPIInvokerEnrolmentDetails = ; // APIInvokerEnrolmentDetails | 
+
+        try {
+            APIInvokerEnrolmentDetails result = apiInstance.onboardedInvokersOnboardingIdPut(onboardingId, aPIInvokerEnrolmentDetails);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#onboardedInvokersOnboardingIdPut");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *onboardingId = onboardingId_example; // String identifying an individual on-boarded API invoker resource (default to null)
+APIInvokerEnrolmentDetails *aPIInvokerEnrolmentDetails = ; // 
+
+[apiInstance onboardedInvokersOnboardingIdPutWith:onboardingId
+    aPIInvokerEnrolmentDetails:aPIInvokerEnrolmentDetails
+              completionHandler: ^(APIInvokerEnrolmentDetails output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifApiInvokerManagementApi = require('capif_api_invoker_management_api');
+
+// Create an instance of the API class
+var api = new CapifApiInvokerManagementApi.DefaultApi()
+var onboardingId = onboardingId_example; // {String} String identifying an individual on-boarded API invoker resource
+var aPIInvokerEnrolmentDetails = ; // {APIInvokerEnrolmentDetails} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.onboardedInvokersOnboardingIdPut(onboardingId, aPIInvokerEnrolmentDetails, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class onboardedInvokersOnboardingIdPutExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var onboardingId = onboardingId_example;  // String | String identifying an individual on-boarded API invoker resource (default to null)
+            var aPIInvokerEnrolmentDetails = new APIInvokerEnrolmentDetails(); // APIInvokerEnrolmentDetails | 
+
+            try {
+                APIInvokerEnrolmentDetails result = apiInstance.onboardedInvokersOnboardingIdPut(onboardingId, aPIInvokerEnrolmentDetails);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.onboardedInvokersOnboardingIdPut: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$onboardingId = onboardingId_example; // String | String identifying an individual on-boarded API invoker resource
+$aPIInvokerEnrolmentDetails = ; // APIInvokerEnrolmentDetails | 
+
+try {
+    $result = $api_instance->onboardedInvokersOnboardingIdPut($onboardingId, $aPIInvokerEnrolmentDetails);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->onboardedInvokersOnboardingIdPut: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $onboardingId = onboardingId_example; # String | String identifying an individual on-boarded API invoker resource
+my $aPIInvokerEnrolmentDetails = WWW::OPenAPIClient::Object::APIInvokerEnrolmentDetails->new(); # APIInvokerEnrolmentDetails | 
+
+eval {
+    my $result = $api_instance->onboardedInvokersOnboardingIdPut(onboardingId => $onboardingId, aPIInvokerEnrolmentDetails => $aPIInvokerEnrolmentDetails);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->onboardedInvokersOnboardingIdPut: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+onboardingId = onboardingId_example # String | String identifying an individual on-boarded API invoker resource (default to null)
+aPIInvokerEnrolmentDetails =  # APIInvokerEnrolmentDetails | 
+
+try:
+    api_response = api_instance.onboarded_invokers_onboarding_id_put(onboardingId, aPIInvokerEnrolmentDetails)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->onboardedInvokersOnboardingIdPut: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let onboardingId = onboardingId_example; // String
+    let aPIInvokerEnrolmentDetails = ; // APIInvokerEnrolmentDetails
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.onboardedInvokersOnboardingIdPut(onboardingId, aPIInvokerEnrolmentDetails, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
onboardingId* + + +
+
+
+ + String + + +
+String identifying an individual on-boarded API invoker resource +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
aPIInvokerEnrolmentDetails * +

representation of the API invoker details to be updated in CAPIF core function

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

onboardedInvokersPost

+

+
+
+
+

+

Creates a new individual API Invoker profile.

+

+
+ 
/onboardedInvokers
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/api-invoker-management/v1/onboardedInvokers" \
+ -d '{
+  "notificationDestination" : "notificationDestination",
+  "supportedFeatures" : "supportedFeatures",
+  "apiInvokerId" : "apiInvokerId",
+  "apiInvokerInformation" : "apiInvokerInformation",
+  "websockNotifConfig" : {
+    "requestWebsocketUri" : true,
+    "websocketUri" : "websocketUri"
+  },
+  "onboardingInformation" : {
+    "apiInvokerPublicKey" : "apiInvokerPublicKey",
+    "onboardingSecret" : "onboardingSecret",
+    "apiInvokerCertificate" : "apiInvokerCertificate"
+  },
+  "requestTestNotification" : true,
+  "apiList" : [ {
+    "ccfId" : "ccfId",
+    "serviceAPICategory" : "serviceAPICategory",
+    "apiName" : "apiName",
+    "shareableInfo" : {
+      "capifProvDoms" : [ "capifProvDoms", "capifProvDoms" ],
+      "isShareable" : true
+    },
+    "supportedFeatures" : "supportedFeatures",
+    "description" : "description",
+    "apiSuppFeats" : "apiSuppFeats",
+    "aefProfiles" : [ {
+      "securityMethods" : [ null, null ],
+      "versions" : [ {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      }, {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      } ],
+      "domainName" : "domainName",
+      "aefLocation" : {
+        "dcId" : "dcId",
+        "geoArea" : {
+          "point" : {
+            "lon" : 36.988422590534526,
+            "lat" : -75.5850925717018
+          }
+        },
+        "civicAddr" : {
+          "POBOX" : "POBOX",
+          "usageRules" : "usageRules",
+          "country" : "country",
+          "PRD" : "PRD",
+          "PLC" : "PLC",
+          "HNO" : "HNO",
+          "PRM" : "PRM",
+          "HNS" : "HNS",
+          "FLR" : "FLR",
+          "A1" : "A1",
+          "A2" : "A2",
+          "A3" : "A3",
+          "A4" : "A4",
+          "STS" : "STS",
+          "A5" : "A5",
+          "A6" : "A6",
+          "RDSEC" : "RDSEC",
+          "providedBy" : "providedBy",
+          "LOC" : "LOC",
+          "SEAT" : "SEAT",
+          "UNIT" : "UNIT",
+          "POD" : "POD",
+          "RDBR" : "RDBR",
+          "method" : "method",
+          "LMK" : "LMK",
+          "POM" : "POM",
+          "ADDCODE" : "ADDCODE",
+          "RD" : "RD",
+          "PC" : "PC",
+          "PCN" : "PCN",
+          "BLD" : "BLD",
+          "NAM" : "NAM",
+          "ROOM" : "ROOM",
+          "RDSUBBR" : "RDSUBBR"
+        }
+      },
+      "aefId" : "aefId",
+      "interfaceDescriptions" : [ {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      }, {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      } ]
+    }, {
+      "securityMethods" : [ null, null ],
+      "versions" : [ {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      }, {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      } ],
+      "domainName" : "domainName",
+      "aefLocation" : {
+        "dcId" : "dcId",
+        "geoArea" : {
+          "point" : {
+            "lon" : 36.988422590534526,
+            "lat" : -75.5850925717018
+          }
+        },
+        "civicAddr" : {
+          "POBOX" : "POBOX",
+          "usageRules" : "usageRules",
+          "country" : "country",
+          "PRD" : "PRD",
+          "PLC" : "PLC",
+          "HNO" : "HNO",
+          "PRM" : "PRM",
+          "HNS" : "HNS",
+          "FLR" : "FLR",
+          "A1" : "A1",
+          "A2" : "A2",
+          "A3" : "A3",
+          "A4" : "A4",
+          "STS" : "STS",
+          "A5" : "A5",
+          "A6" : "A6",
+          "RDSEC" : "RDSEC",
+          "providedBy" : "providedBy",
+          "LOC" : "LOC",
+          "SEAT" : "SEAT",
+          "UNIT" : "UNIT",
+          "POD" : "POD",
+          "RDBR" : "RDBR",
+          "method" : "method",
+          "LMK" : "LMK",
+          "POM" : "POM",
+          "ADDCODE" : "ADDCODE",
+          "RD" : "RD",
+          "PC" : "PC",
+          "PCN" : "PCN",
+          "BLD" : "BLD",
+          "NAM" : "NAM",
+          "ROOM" : "ROOM",
+          "RDSUBBR" : "RDSUBBR"
+        }
+      },
+      "aefId" : "aefId",
+      "interfaceDescriptions" : [ {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      }, {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      } ]
+    } ],
+    "apiId" : "apiId",
+    "pubApiPath" : {
+      "ccfIds" : [ "ccfIds", "ccfIds" ]
+    }
+  }, {
+    "ccfId" : "ccfId",
+    "serviceAPICategory" : "serviceAPICategory",
+    "apiName" : "apiName",
+    "shareableInfo" : {
+      "capifProvDoms" : [ "capifProvDoms", "capifProvDoms" ],
+      "isShareable" : true
+    },
+    "supportedFeatures" : "supportedFeatures",
+    "description" : "description",
+    "apiSuppFeats" : "apiSuppFeats",
+    "aefProfiles" : [ {
+      "securityMethods" : [ null, null ],
+      "versions" : [ {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      }, {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      } ],
+      "domainName" : "domainName",
+      "aefLocation" : {
+        "dcId" : "dcId",
+        "geoArea" : {
+          "point" : {
+            "lon" : 36.988422590534526,
+            "lat" : -75.5850925717018
+          }
+        },
+        "civicAddr" : {
+          "POBOX" : "POBOX",
+          "usageRules" : "usageRules",
+          "country" : "country",
+          "PRD" : "PRD",
+          "PLC" : "PLC",
+          "HNO" : "HNO",
+          "PRM" : "PRM",
+          "HNS" : "HNS",
+          "FLR" : "FLR",
+          "A1" : "A1",
+          "A2" : "A2",
+          "A3" : "A3",
+          "A4" : "A4",
+          "STS" : "STS",
+          "A5" : "A5",
+          "A6" : "A6",
+          "RDSEC" : "RDSEC",
+          "providedBy" : "providedBy",
+          "LOC" : "LOC",
+          "SEAT" : "SEAT",
+          "UNIT" : "UNIT",
+          "POD" : "POD",
+          "RDBR" : "RDBR",
+          "method" : "method",
+          "LMK" : "LMK",
+          "POM" : "POM",
+          "ADDCODE" : "ADDCODE",
+          "RD" : "RD",
+          "PC" : "PC",
+          "PCN" : "PCN",
+          "BLD" : "BLD",
+          "NAM" : "NAM",
+          "ROOM" : "ROOM",
+          "RDSUBBR" : "RDSUBBR"
+        }
+      },
+      "aefId" : "aefId",
+      "interfaceDescriptions" : [ {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      }, {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      } ]
+    }, {
+      "securityMethods" : [ null, null ],
+      "versions" : [ {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      }, {
+        "apiVersion" : "apiVersion",
+        "custOperations" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName"
+        } ],
+        "resources" : [ {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        }, {
+          "operations" : [ null, null ],
+          "description" : "description",
+          "custOpName" : "custOpName",
+          "resourceName" : "resourceName",
+          "uri" : "uri"
+        } ],
+        "expiry" : "2000-01-23T04:56:07.000+00:00"
+      } ],
+      "domainName" : "domainName",
+      "aefLocation" : {
+        "dcId" : "dcId",
+        "geoArea" : {
+          "point" : {
+            "lon" : 36.988422590534526,
+            "lat" : -75.5850925717018
+          }
+        },
+        "civicAddr" : {
+          "POBOX" : "POBOX",
+          "usageRules" : "usageRules",
+          "country" : "country",
+          "PRD" : "PRD",
+          "PLC" : "PLC",
+          "HNO" : "HNO",
+          "PRM" : "PRM",
+          "HNS" : "HNS",
+          "FLR" : "FLR",
+          "A1" : "A1",
+          "A2" : "A2",
+          "A3" : "A3",
+          "A4" : "A4",
+          "STS" : "STS",
+          "A5" : "A5",
+          "A6" : "A6",
+          "RDSEC" : "RDSEC",
+          "providedBy" : "providedBy",
+          "LOC" : "LOC",
+          "SEAT" : "SEAT",
+          "UNIT" : "UNIT",
+          "POD" : "POD",
+          "RDBR" : "RDBR",
+          "method" : "method",
+          "LMK" : "LMK",
+          "POM" : "POM",
+          "ADDCODE" : "ADDCODE",
+          "RD" : "RD",
+          "PC" : "PC",
+          "PCN" : "PCN",
+          "BLD" : "BLD",
+          "NAM" : "NAM",
+          "ROOM" : "ROOM",
+          "RDSUBBR" : "RDSUBBR"
+        }
+      },
+      "aefId" : "aefId",
+      "interfaceDescriptions" : [ {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      }, {
+        "ipv6Addr" : "ipv6Addr",
+        "securityMethods" : [ null, null ],
+        "port" : 9606,
+        "ipv4Addr" : "ipv4Addr"
+      } ]
+    } ],
+    "apiId" : "apiId",
+    "pubApiPath" : {
+      "ccfIds" : [ "ccfIds", "ccfIds" ]
+    }
+  } ]
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        APIInvokerEnrolmentDetails aPIInvokerEnrolmentDetails = ; // APIInvokerEnrolmentDetails | 
+
+        try {
+            APIInvokerEnrolmentDetails result = apiInstance.onboardedInvokersPost(aPIInvokerEnrolmentDetails);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#onboardedInvokersPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final APIInvokerEnrolmentDetails aPIInvokerEnrolmentDetails = new APIInvokerEnrolmentDetails(); // APIInvokerEnrolmentDetails | 
+
+try {
+    final result = await api_instance.onboardedInvokersPost(aPIInvokerEnrolmentDetails);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->onboardedInvokersPost: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        APIInvokerEnrolmentDetails aPIInvokerEnrolmentDetails = ; // APIInvokerEnrolmentDetails | 
+
+        try {
+            APIInvokerEnrolmentDetails result = apiInstance.onboardedInvokersPost(aPIInvokerEnrolmentDetails);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#onboardedInvokersPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+APIInvokerEnrolmentDetails *aPIInvokerEnrolmentDetails = ; // 
+
+[apiInstance onboardedInvokersPostWith:aPIInvokerEnrolmentDetails
+              completionHandler: ^(APIInvokerEnrolmentDetails output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifApiInvokerManagementApi = require('capif_api_invoker_management_api');
+
+// Create an instance of the API class
+var api = new CapifApiInvokerManagementApi.DefaultApi()
+var aPIInvokerEnrolmentDetails = ; // {APIInvokerEnrolmentDetails} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.onboardedInvokersPost(aPIInvokerEnrolmentDetails, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class onboardedInvokersPostExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var aPIInvokerEnrolmentDetails = new APIInvokerEnrolmentDetails(); // APIInvokerEnrolmentDetails | 
+
+            try {
+                APIInvokerEnrolmentDetails result = apiInstance.onboardedInvokersPost(aPIInvokerEnrolmentDetails);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.onboardedInvokersPost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$aPIInvokerEnrolmentDetails = ; // APIInvokerEnrolmentDetails | 
+
+try {
+    $result = $api_instance->onboardedInvokersPost($aPIInvokerEnrolmentDetails);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->onboardedInvokersPost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $aPIInvokerEnrolmentDetails = WWW::OPenAPIClient::Object::APIInvokerEnrolmentDetails->new(); # APIInvokerEnrolmentDetails | 
+
+eval {
+    my $result = $api_instance->onboardedInvokersPost(aPIInvokerEnrolmentDetails => $aPIInvokerEnrolmentDetails);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->onboardedInvokersPost: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+aPIInvokerEnrolmentDetails =  # APIInvokerEnrolmentDetails | 
+
+try:
+    api_response = api_instance.onboarded_invokers_post(aPIInvokerEnrolmentDetails)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->onboardedInvokersPost: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let aPIInvokerEnrolmentDetails = ; // APIInvokerEnrolmentDetails
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.onboardedInvokersPost(aPIInvokerEnrolmentDetails, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + +
Body parameters
+ + + + + + + + + +
NameDescription
aPIInvokerEnrolmentDetails * +

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+

IndividualAPIInvokerEnrolmentDetails

+
+
+
+

modifyIndApiInvokeEnrolment

+

+
+
+
+

+

Modify an individual API invoker details.

+

+
+ 
/onboardedInvokers/{onboardingId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X PATCH \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/merge-patch+json" \
+ "https://example.com/api-invoker-management/v1/onboardedInvokers/{onboardingId}" \
+ -d 'Custom MIME type example not yet supported: application/merge-patch+json'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.IndividualAPIInvokerEnrolmentDetailsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class IndividualAPIInvokerEnrolmentDetailsApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        IndividualAPIInvokerEnrolmentDetailsApi apiInstance = new IndividualAPIInvokerEnrolmentDetailsApi();
+        String onboardingId = onboardingId_example; // String | 
+        APIInvokerEnrolmentDetailsPatch aPIInvokerEnrolmentDetailsPatch = ; // APIInvokerEnrolmentDetailsPatch | 
+
+        try {
+            APIInvokerEnrolmentDetails result = apiInstance.modifyIndApiInvokeEnrolment(onboardingId, aPIInvokerEnrolmentDetailsPatch);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling IndividualAPIInvokerEnrolmentDetailsApi#modifyIndApiInvokeEnrolment");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String onboardingId = new String(); // String | 
+final APIInvokerEnrolmentDetailsPatch aPIInvokerEnrolmentDetailsPatch = new APIInvokerEnrolmentDetailsPatch(); // APIInvokerEnrolmentDetailsPatch | 
+
+try {
+    final result = await api_instance.modifyIndApiInvokeEnrolment(onboardingId, aPIInvokerEnrolmentDetailsPatch);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->modifyIndApiInvokeEnrolment: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.IndividualAPIInvokerEnrolmentDetailsApi;
+
+public class IndividualAPIInvokerEnrolmentDetailsApiExample {
+    public static void main(String[] args) {
+        IndividualAPIInvokerEnrolmentDetailsApi apiInstance = new IndividualAPIInvokerEnrolmentDetailsApi();
+        String onboardingId = onboardingId_example; // String | 
+        APIInvokerEnrolmentDetailsPatch aPIInvokerEnrolmentDetailsPatch = ; // APIInvokerEnrolmentDetailsPatch | 
+
+        try {
+            APIInvokerEnrolmentDetails result = apiInstance.modifyIndApiInvokeEnrolment(onboardingId, aPIInvokerEnrolmentDetailsPatch);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling IndividualAPIInvokerEnrolmentDetailsApi#modifyIndApiInvokeEnrolment");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+IndividualAPIInvokerEnrolmentDetailsApi *apiInstance = [[IndividualAPIInvokerEnrolmentDetailsApi alloc] init];
+String *onboardingId = onboardingId_example; //  (default to null)
+APIInvokerEnrolmentDetailsPatch *aPIInvokerEnrolmentDetailsPatch = ; // 
+
+[apiInstance modifyIndApiInvokeEnrolmentWith:onboardingId
+    aPIInvokerEnrolmentDetailsPatch:aPIInvokerEnrolmentDetailsPatch
+              completionHandler: ^(APIInvokerEnrolmentDetails output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifApiInvokerManagementApi = require('capif_api_invoker_management_api');
+
+// Create an instance of the API class
+var api = new CapifApiInvokerManagementApi.IndividualAPIInvokerEnrolmentDetailsApi()
+var onboardingId = onboardingId_example; // {String} 
+var aPIInvokerEnrolmentDetailsPatch = ; // {APIInvokerEnrolmentDetailsPatch} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.modifyIndApiInvokeEnrolment(onboardingId, aPIInvokerEnrolmentDetailsPatch, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class modifyIndApiInvokeEnrolmentExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new IndividualAPIInvokerEnrolmentDetailsApi();
+            var onboardingId = onboardingId_example;  // String |  (default to null)
+            var aPIInvokerEnrolmentDetailsPatch = new APIInvokerEnrolmentDetailsPatch(); // APIInvokerEnrolmentDetailsPatch | 
+
+            try {
+                APIInvokerEnrolmentDetails result = apiInstance.modifyIndApiInvokeEnrolment(onboardingId, aPIInvokerEnrolmentDetailsPatch);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling IndividualAPIInvokerEnrolmentDetailsApi.modifyIndApiInvokeEnrolment: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\IndividualAPIInvokerEnrolmentDetailsApi();
+$onboardingId = onboardingId_example; // String | 
+$aPIInvokerEnrolmentDetailsPatch = ; // APIInvokerEnrolmentDetailsPatch | 
+
+try {
+    $result = $api_instance->modifyIndApiInvokeEnrolment($onboardingId, $aPIInvokerEnrolmentDetailsPatch);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling IndividualAPIInvokerEnrolmentDetailsApi->modifyIndApiInvokeEnrolment: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::IndividualAPIInvokerEnrolmentDetailsApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::IndividualAPIInvokerEnrolmentDetailsApi->new();
+my $onboardingId = onboardingId_example; # String | 
+my $aPIInvokerEnrolmentDetailsPatch = WWW::OPenAPIClient::Object::APIInvokerEnrolmentDetailsPatch->new(); # APIInvokerEnrolmentDetailsPatch | 
+
+eval {
+    my $result = $api_instance->modifyIndApiInvokeEnrolment(onboardingId => $onboardingId, aPIInvokerEnrolmentDetailsPatch => $aPIInvokerEnrolmentDetailsPatch);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling IndividualAPIInvokerEnrolmentDetailsApi->modifyIndApiInvokeEnrolment: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.IndividualAPIInvokerEnrolmentDetailsApi()
+onboardingId = onboardingId_example # String |  (default to null)
+aPIInvokerEnrolmentDetailsPatch =  # APIInvokerEnrolmentDetailsPatch | 
+
+try:
+    api_response = api_instance.modify_ind_api_invoke_enrolment(onboardingId, aPIInvokerEnrolmentDetailsPatch)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling IndividualAPIInvokerEnrolmentDetailsApi->modifyIndApiInvokeEnrolment: %s\n" % e)
+
+ +
+ 
extern crate IndividualAPIInvokerEnrolmentDetailsApi;
+
+pub fn main() {
+    let onboardingId = onboardingId_example; // String
+    let aPIInvokerEnrolmentDetailsPatch = ; // APIInvokerEnrolmentDetailsPatch
+
+    let mut context = IndividualAPIInvokerEnrolmentDetailsApi::Context::default();
+    let result = client.modifyIndApiInvokeEnrolment(onboardingId, aPIInvokerEnrolmentDetailsPatch, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
onboardingId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
aPIInvokerEnrolmentDetailsPatch * +

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/openapi/Provider_Management.html b/docs/openapi/Provider_Management.html new file mode 100644 index 0000000..3ace452 --- /dev/null +++ b/docs/openapi/Provider_Management.html @@ -0,0 +1,8102 @@ + + + + + CAPIF_API_Provider_Management_API + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

CAPIF_API_Provider_Management_API

+
+
+
+ +
+
+

Default

+
+
+
+

registrationsPost

+

+
+
+
+

+

Registers a new API Provider domain with API provider domain functions profiles.

+

+
+ 
/registrations
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/api-provider-management/v1/registrations" \
+ -d '{
+  "apiProvFuncs" : [ {
+    "apiProvFuncId" : "apiProvFuncId",
+    "apiProvFuncInfo" : "apiProvFuncInfo",
+    "regInfo" : {
+      "apiProvCert" : "apiProvCert",
+      "apiProvPubKey" : "apiProvPubKey"
+    }
+  }, {
+    "apiProvFuncId" : "apiProvFuncId",
+    "apiProvFuncInfo" : "apiProvFuncInfo",
+    "regInfo" : {
+      "apiProvCert" : "apiProvCert",
+      "apiProvPubKey" : "apiProvPubKey"
+    }
+  } ],
+  "failReason" : "failReason",
+  "regSec" : "regSec",
+  "apiProvDomId" : "apiProvDomId",
+  "apiProvDomInfo" : "apiProvDomInfo",
+  "suppFeat" : "suppFeat"
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 
+
+        try {
+            APIProviderEnrolmentDetails result = apiInstance.registrationsPost(aPIProviderEnrolmentDetails);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#registrationsPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = new APIProviderEnrolmentDetails(); // APIProviderEnrolmentDetails | 
+
+try {
+    final result = await api_instance.registrationsPost(aPIProviderEnrolmentDetails);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->registrationsPost: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 
+
+        try {
+            APIProviderEnrolmentDetails result = apiInstance.registrationsPost(aPIProviderEnrolmentDetails);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#registrationsPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+APIProviderEnrolmentDetails *aPIProviderEnrolmentDetails = ; // 
+
+[apiInstance registrationsPostWith:aPIProviderEnrolmentDetails
+              completionHandler: ^(APIProviderEnrolmentDetails output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifApiProviderManagementApi = require('capif_api_provider_management_api');
+
+// Create an instance of the API class
+var api = new CapifApiProviderManagementApi.DefaultApi()
+var aPIProviderEnrolmentDetails = ; // {APIProviderEnrolmentDetails} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.registrationsPost(aPIProviderEnrolmentDetails, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class registrationsPostExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var aPIProviderEnrolmentDetails = new APIProviderEnrolmentDetails(); // APIProviderEnrolmentDetails | 
+
+            try {
+                APIProviderEnrolmentDetails result = apiInstance.registrationsPost(aPIProviderEnrolmentDetails);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.registrationsPost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 
+
+try {
+    $result = $api_instance->registrationsPost($aPIProviderEnrolmentDetails);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->registrationsPost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $aPIProviderEnrolmentDetails = WWW::OPenAPIClient::Object::APIProviderEnrolmentDetails->new(); # APIProviderEnrolmentDetails | 
+
+eval {
+    my $result = $api_instance->registrationsPost(aPIProviderEnrolmentDetails => $aPIProviderEnrolmentDetails);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->registrationsPost: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+aPIProviderEnrolmentDetails =  # APIProviderEnrolmentDetails | 
+
+try:
+    api_response = api_instance.registrations_post(aPIProviderEnrolmentDetails)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->registrationsPost: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.registrationsPost(aPIProviderEnrolmentDetails, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + +
Body parameters
+ + + + + + + + + +
NameDescription
aPIProviderEnrolmentDetails * +

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

registrationsRegistrationIdDelete

+

+
+
+
+

+

Deregisters API provider domain by deleting API provider domain and functions.

+

+
+ 
/registrations/{registrationId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X DELETE \
+ -H "Accept: application/problem+json" \
+ "https://example.com/api-provider-management/v1/registrations/{registrationId}"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.
+
+        try {
+            apiInstance.registrationsRegistrationIdDelete(registrationId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#registrationsRegistrationIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String registrationId = new String(); // String | String identifying an registered API provider domain resource.
+
+try {
+    final result = await api_instance.registrationsRegistrationIdDelete(registrationId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->registrationsRegistrationIdDelete: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.
+
+        try {
+            apiInstance.registrationsRegistrationIdDelete(registrationId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#registrationsRegistrationIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *registrationId = registrationId_example; // String identifying an registered API provider domain resource. (default to null)
+
+[apiInstance registrationsRegistrationIdDeleteWith:registrationId
+              completionHandler: ^(NSError* error) {
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifApiProviderManagementApi = require('capif_api_provider_management_api');
+
+// Create an instance of the API class
+var api = new CapifApiProviderManagementApi.DefaultApi()
+var registrationId = registrationId_example; // {String} String identifying an registered API provider domain resource.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.registrationsRegistrationIdDelete(registrationId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class registrationsRegistrationIdDeleteExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var registrationId = registrationId_example;  // String | String identifying an registered API provider domain resource. (default to null)
+
+            try {
+                apiInstance.registrationsRegistrationIdDelete(registrationId);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.registrationsRegistrationIdDelete: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.
+
+try {
+    $api_instance->registrationsRegistrationIdDelete($registrationId);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->registrationsRegistrationIdDelete: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $registrationId = registrationId_example; # String | String identifying an registered API provider domain resource.
+
+eval {
+    $api_instance->registrationsRegistrationIdDelete(registrationId => $registrationId);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->registrationsRegistrationIdDelete: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+registrationId = registrationId_example # String | String identifying an registered API provider domain resource. (default to null)
+
+try:
+    api_instance.registrations_registration_id_delete(registrationId)
+except ApiException as e:
+    print("Exception when calling DefaultApi->registrationsRegistrationIdDelete: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let registrationId = registrationId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.registrationsRegistrationIdDelete(registrationId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
registrationId* + + +
+
+
+ + String + + +
+String identifying an registered API provider domain resource. +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

registrationsRegistrationIdPut

+

+
+
+
+

+

Updates an API provider domain's registration details.

+

+
+ 
/registrations/{registrationId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X PUT \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/api-provider-management/v1/registrations/{registrationId}" \
+ -d '{
+  "apiProvFuncs" : [ {
+    "apiProvFuncId" : "apiProvFuncId",
+    "apiProvFuncInfo" : "apiProvFuncInfo",
+    "regInfo" : {
+      "apiProvCert" : "apiProvCert",
+      "apiProvPubKey" : "apiProvPubKey"
+    }
+  }, {
+    "apiProvFuncId" : "apiProvFuncId",
+    "apiProvFuncInfo" : "apiProvFuncInfo",
+    "regInfo" : {
+      "apiProvCert" : "apiProvCert",
+      "apiProvPubKey" : "apiProvPubKey"
+    }
+  } ],
+  "failReason" : "failReason",
+  "regSec" : "regSec",
+  "apiProvDomId" : "apiProvDomId",
+  "apiProvDomInfo" : "apiProvDomInfo",
+  "suppFeat" : "suppFeat"
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.
+        APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 
+
+        try {
+            APIProviderEnrolmentDetails result = apiInstance.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#registrationsRegistrationIdPut");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String registrationId = new String(); // String | String identifying an registered API provider domain resource.
+final APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = new APIProviderEnrolmentDetails(); // APIProviderEnrolmentDetails | 
+
+try {
+    final result = await api_instance.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->registrationsRegistrationIdPut: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.
+        APIProviderEnrolmentDetails aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 
+
+        try {
+            APIProviderEnrolmentDetails result = apiInstance.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#registrationsRegistrationIdPut");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *registrationId = registrationId_example; // String identifying an registered API provider domain resource. (default to null)
+APIProviderEnrolmentDetails *aPIProviderEnrolmentDetails = ; // 
+
+[apiInstance registrationsRegistrationIdPutWith:registrationId
+    aPIProviderEnrolmentDetails:aPIProviderEnrolmentDetails
+              completionHandler: ^(APIProviderEnrolmentDetails output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifApiProviderManagementApi = require('capif_api_provider_management_api');
+
+// Create an instance of the API class
+var api = new CapifApiProviderManagementApi.DefaultApi()
+var registrationId = registrationId_example; // {String} String identifying an registered API provider domain resource.
+var aPIProviderEnrolmentDetails = ; // {APIProviderEnrolmentDetails} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class registrationsRegistrationIdPutExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var registrationId = registrationId_example;  // String | String identifying an registered API provider domain resource. (default to null)
+            var aPIProviderEnrolmentDetails = new APIProviderEnrolmentDetails(); // APIProviderEnrolmentDetails | 
+
+            try {
+                APIProviderEnrolmentDetails result = apiInstance.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.registrationsRegistrationIdPut: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$registrationId = registrationId_example; // String | String identifying an registered API provider domain resource.
+$aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails | 
+
+try {
+    $result = $api_instance->registrationsRegistrationIdPut($registrationId, $aPIProviderEnrolmentDetails);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->registrationsRegistrationIdPut: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $registrationId = registrationId_example; # String | String identifying an registered API provider domain resource.
+my $aPIProviderEnrolmentDetails = WWW::OPenAPIClient::Object::APIProviderEnrolmentDetails->new(); # APIProviderEnrolmentDetails | 
+
+eval {
+    my $result = $api_instance->registrationsRegistrationIdPut(registrationId => $registrationId, aPIProviderEnrolmentDetails => $aPIProviderEnrolmentDetails);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->registrationsRegistrationIdPut: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+registrationId = registrationId_example # String | String identifying an registered API provider domain resource. (default to null)
+aPIProviderEnrolmentDetails =  # APIProviderEnrolmentDetails | 
+
+try:
+    api_response = api_instance.registrations_registration_id_put(registrationId, aPIProviderEnrolmentDetails)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->registrationsRegistrationIdPut: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let registrationId = registrationId_example; // String
+    let aPIProviderEnrolmentDetails = ; // APIProviderEnrolmentDetails
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.registrationsRegistrationIdPut(registrationId, aPIProviderEnrolmentDetails, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
registrationId* + + +
+
+
+ + String + + +
+String identifying an registered API provider domain resource. +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
aPIProviderEnrolmentDetails * +

Representation of the API provider domain registration details to be updated in CAPIF core function. +

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+

IndividualAPIProviderEnrolmentDetails

+
+
+
+

modifyIndApiProviderEnrolment

+

+
+
+
+

+

Modify an individual API provider details.

+

+
+ 
/registrations/{registrationId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X PATCH \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/merge-patch+json" \
+ "https://example.com/api-provider-management/v1/registrations/{registrationId}" \
+ -d 'Custom MIME type example not yet supported: application/merge-patch+json'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.IndividualAPIProviderEnrolmentDetailsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class IndividualAPIProviderEnrolmentDetailsApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        IndividualAPIProviderEnrolmentDetailsApi apiInstance = new IndividualAPIProviderEnrolmentDetailsApi();
+        String registrationId = registrationId_example; // String | 
+        APIProviderEnrolmentDetailsPatch aPIProviderEnrolmentDetailsPatch = ; // APIProviderEnrolmentDetailsPatch | 
+
+        try {
+            APIProviderEnrolmentDetails result = apiInstance.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling IndividualAPIProviderEnrolmentDetailsApi#modifyIndApiProviderEnrolment");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String registrationId = new String(); // String | 
+final APIProviderEnrolmentDetailsPatch aPIProviderEnrolmentDetailsPatch = new APIProviderEnrolmentDetailsPatch(); // APIProviderEnrolmentDetailsPatch | 
+
+try {
+    final result = await api_instance.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->modifyIndApiProviderEnrolment: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.IndividualAPIProviderEnrolmentDetailsApi;
+
+public class IndividualAPIProviderEnrolmentDetailsApiExample {
+    public static void main(String[] args) {
+        IndividualAPIProviderEnrolmentDetailsApi apiInstance = new IndividualAPIProviderEnrolmentDetailsApi();
+        String registrationId = registrationId_example; // String | 
+        APIProviderEnrolmentDetailsPatch aPIProviderEnrolmentDetailsPatch = ; // APIProviderEnrolmentDetailsPatch | 
+
+        try {
+            APIProviderEnrolmentDetails result = apiInstance.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling IndividualAPIProviderEnrolmentDetailsApi#modifyIndApiProviderEnrolment");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+IndividualAPIProviderEnrolmentDetailsApi *apiInstance = [[IndividualAPIProviderEnrolmentDetailsApi alloc] init];
+String *registrationId = registrationId_example; //  (default to null)
+APIProviderEnrolmentDetailsPatch *aPIProviderEnrolmentDetailsPatch = ; // 
+
+[apiInstance modifyIndApiProviderEnrolmentWith:registrationId
+    aPIProviderEnrolmentDetailsPatch:aPIProviderEnrolmentDetailsPatch
+              completionHandler: ^(APIProviderEnrolmentDetails output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifApiProviderManagementApi = require('capif_api_provider_management_api');
+
+// Create an instance of the API class
+var api = new CapifApiProviderManagementApi.IndividualAPIProviderEnrolmentDetailsApi()
+var registrationId = registrationId_example; // {String} 
+var aPIProviderEnrolmentDetailsPatch = ; // {APIProviderEnrolmentDetailsPatch} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class modifyIndApiProviderEnrolmentExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new IndividualAPIProviderEnrolmentDetailsApi();
+            var registrationId = registrationId_example;  // String |  (default to null)
+            var aPIProviderEnrolmentDetailsPatch = new APIProviderEnrolmentDetailsPatch(); // APIProviderEnrolmentDetailsPatch | 
+
+            try {
+                APIProviderEnrolmentDetails result = apiInstance.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling IndividualAPIProviderEnrolmentDetailsApi.modifyIndApiProviderEnrolment: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\IndividualAPIProviderEnrolmentDetailsApi();
+$registrationId = registrationId_example; // String | 
+$aPIProviderEnrolmentDetailsPatch = ; // APIProviderEnrolmentDetailsPatch | 
+
+try {
+    $result = $api_instance->modifyIndApiProviderEnrolment($registrationId, $aPIProviderEnrolmentDetailsPatch);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling IndividualAPIProviderEnrolmentDetailsApi->modifyIndApiProviderEnrolment: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::IndividualAPIProviderEnrolmentDetailsApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::IndividualAPIProviderEnrolmentDetailsApi->new();
+my $registrationId = registrationId_example; # String | 
+my $aPIProviderEnrolmentDetailsPatch = WWW::OPenAPIClient::Object::APIProviderEnrolmentDetailsPatch->new(); # APIProviderEnrolmentDetailsPatch | 
+
+eval {
+    my $result = $api_instance->modifyIndApiProviderEnrolment(registrationId => $registrationId, aPIProviderEnrolmentDetailsPatch => $aPIProviderEnrolmentDetailsPatch);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling IndividualAPIProviderEnrolmentDetailsApi->modifyIndApiProviderEnrolment: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.IndividualAPIProviderEnrolmentDetailsApi()
+registrationId = registrationId_example # String |  (default to null)
+aPIProviderEnrolmentDetailsPatch =  # APIProviderEnrolmentDetailsPatch | 
+
+try:
+    api_response = api_instance.modify_ind_api_provider_enrolment(registrationId, aPIProviderEnrolmentDetailsPatch)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling IndividualAPIProviderEnrolmentDetailsApi->modifyIndApiProviderEnrolment: %s\n" % e)
+
+ +
+ 
extern crate IndividualAPIProviderEnrolmentDetailsApi;
+
+pub fn main() {
+    let registrationId = registrationId_example; // String
+    let aPIProviderEnrolmentDetailsPatch = ; // APIProviderEnrolmentDetailsPatch
+
+    let mut context = IndividualAPIProviderEnrolmentDetailsApi::Context::default();
+    let result = client.modifyIndApiProviderEnrolment(registrationId, aPIProviderEnrolmentDetailsPatch, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
registrationId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
aPIProviderEnrolmentDetailsPatch * +

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/openapi/Publish_Service.html b/docs/openapi/Publish_Service.html new file mode 100644 index 0000000..bf70259 --- /dev/null +++ b/docs/openapi/Publish_Service.html @@ -0,0 +1,11729 @@ + + + + + CAPIF_Publish_Service_API + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

CAPIF_Publish_Service_API

+
+
+
+ +
+
+

Default

+
+
+
+

apfIdServiceApisGet

+

+
+
+
+

+

Retrieve all published APIs.

+

+
+ 
/{apfId}/service-apis
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/published-apis/v1/{apfId}/service-apis"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String apfId = apfId_example; // String | 
+
+        try {
+            array[ServiceAPIDescription] result = apiInstance.apfIdServiceApisGet(apfId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#apfIdServiceApisGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String apfId = new String(); // String | 
+
+try {
+    final result = await api_instance.apfIdServiceApisGet(apfId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->apfIdServiceApisGet: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String apfId = apfId_example; // String | 
+
+        try {
+            array[ServiceAPIDescription] result = apiInstance.apfIdServiceApisGet(apfId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#apfIdServiceApisGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *apfId = apfId_example; //  (default to null)
+
+[apiInstance apfIdServiceApisGetWith:apfId
+              completionHandler: ^(array[ServiceAPIDescription] output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifPublishServiceApi = require('capif_publish_service_api');
+
+// Create an instance of the API class
+var api = new CapifPublishServiceApi.DefaultApi()
+var apfId = apfId_example; // {String} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.apfIdServiceApisGet(apfId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class apfIdServiceApisGetExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var apfId = apfId_example;  // String |  (default to null)
+
+            try {
+                array[ServiceAPIDescription] result = apiInstance.apfIdServiceApisGet(apfId);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.apfIdServiceApisGet: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$apfId = apfId_example; // String | 
+
+try {
+    $result = $api_instance->apfIdServiceApisGet($apfId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->apfIdServiceApisGet: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $apfId = apfId_example; # String | 
+
+eval {
+    my $result = $api_instance->apfIdServiceApisGet(apfId => $apfId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->apfIdServiceApisGet: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+apfId = apfId_example # String |  (default to null)
+
+try:
+    api_response = api_instance.apf_id_service_apis_get(apfId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->apfIdServiceApisGet: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let apfId = apfId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.apfIdServiceApisGet(apfId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
apfId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

apfIdServiceApisPost

+

+
+
+
+

+

Publish a new API.

+

+
+ 
/{apfId}/service-apis
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/published-apis/v1/{apfId}/service-apis" \
+ -d '{
+  "ccfId" : "ccfId",
+  "serviceAPICategory" : "serviceAPICategory",
+  "apiName" : "apiName",
+  "shareableInfo" : {
+    "capifProvDoms" : [ "capifProvDoms", "capifProvDoms" ],
+    "isShareable" : true
+  },
+  "supportedFeatures" : "supportedFeatures",
+  "description" : "description",
+  "apiSuppFeats" : "apiSuppFeats",
+  "aefProfiles" : [ {
+    "securityMethods" : [ null, null ],
+    "versions" : [ {
+      "apiVersion" : "apiVersion",
+      "custOperations" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      } ],
+      "resources" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      } ],
+      "expiry" : "2000-01-23T04:56:07.000+00:00"
+    }, {
+      "apiVersion" : "apiVersion",
+      "custOperations" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      } ],
+      "resources" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      } ],
+      "expiry" : "2000-01-23T04:56:07.000+00:00"
+    } ],
+    "domainName" : "domainName",
+    "aefLocation" : {
+      "dcId" : "dcId",
+      "geoArea" : {
+        "point" : {
+          "lon" : 36.988422590534526,
+          "lat" : -75.5850925717018
+        }
+      },
+      "civicAddr" : {
+        "POBOX" : "POBOX",
+        "usageRules" : "usageRules",
+        "country" : "country",
+        "PRD" : "PRD",
+        "PLC" : "PLC",
+        "HNO" : "HNO",
+        "PRM" : "PRM",
+        "HNS" : "HNS",
+        "FLR" : "FLR",
+        "A1" : "A1",
+        "A2" : "A2",
+        "A3" : "A3",
+        "A4" : "A4",
+        "STS" : "STS",
+        "A5" : "A5",
+        "A6" : "A6",
+        "RDSEC" : "RDSEC",
+        "providedBy" : "providedBy",
+        "LOC" : "LOC",
+        "SEAT" : "SEAT",
+        "UNIT" : "UNIT",
+        "POD" : "POD",
+        "RDBR" : "RDBR",
+        "method" : "method",
+        "LMK" : "LMK",
+        "POM" : "POM",
+        "ADDCODE" : "ADDCODE",
+        "RD" : "RD",
+        "PC" : "PC",
+        "PCN" : "PCN",
+        "BLD" : "BLD",
+        "NAM" : "NAM",
+        "ROOM" : "ROOM",
+        "RDSUBBR" : "RDSUBBR"
+      }
+    },
+    "aefId" : "aefId",
+    "interfaceDescriptions" : [ {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 9606,
+      "ipv4Addr" : "ipv4Addr"
+    }, {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 9606,
+      "ipv4Addr" : "ipv4Addr"
+    } ]
+  }, {
+    "securityMethods" : [ null, null ],
+    "versions" : [ {
+      "apiVersion" : "apiVersion",
+      "custOperations" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      } ],
+      "resources" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      } ],
+      "expiry" : "2000-01-23T04:56:07.000+00:00"
+    }, {
+      "apiVersion" : "apiVersion",
+      "custOperations" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      } ],
+      "resources" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      } ],
+      "expiry" : "2000-01-23T04:56:07.000+00:00"
+    } ],
+    "domainName" : "domainName",
+    "aefLocation" : {
+      "dcId" : "dcId",
+      "geoArea" : {
+        "point" : {
+          "lon" : 36.988422590534526,
+          "lat" : -75.5850925717018
+        }
+      },
+      "civicAddr" : {
+        "POBOX" : "POBOX",
+        "usageRules" : "usageRules",
+        "country" : "country",
+        "PRD" : "PRD",
+        "PLC" : "PLC",
+        "HNO" : "HNO",
+        "PRM" : "PRM",
+        "HNS" : "HNS",
+        "FLR" : "FLR",
+        "A1" : "A1",
+        "A2" : "A2",
+        "A3" : "A3",
+        "A4" : "A4",
+        "STS" : "STS",
+        "A5" : "A5",
+        "A6" : "A6",
+        "RDSEC" : "RDSEC",
+        "providedBy" : "providedBy",
+        "LOC" : "LOC",
+        "SEAT" : "SEAT",
+        "UNIT" : "UNIT",
+        "POD" : "POD",
+        "RDBR" : "RDBR",
+        "method" : "method",
+        "LMK" : "LMK",
+        "POM" : "POM",
+        "ADDCODE" : "ADDCODE",
+        "RD" : "RD",
+        "PC" : "PC",
+        "PCN" : "PCN",
+        "BLD" : "BLD",
+        "NAM" : "NAM",
+        "ROOM" : "ROOM",
+        "RDSUBBR" : "RDSUBBR"
+      }
+    },
+    "aefId" : "aefId",
+    "interfaceDescriptions" : [ {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 9606,
+      "ipv4Addr" : "ipv4Addr"
+    }, {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 9606,
+      "ipv4Addr" : "ipv4Addr"
+    } ]
+  } ],
+  "apiId" : "apiId",
+  "pubApiPath" : {
+    "ccfIds" : [ "ccfIds", "ccfIds" ]
+  }
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String apfId = apfId_example; // String | 
+        ServiceAPIDescription serviceAPIDescription = ; // ServiceAPIDescription | 
+
+        try {
+            ServiceAPIDescription result = apiInstance.apfIdServiceApisPost(apfId, serviceAPIDescription);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#apfIdServiceApisPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String apfId = new String(); // String | 
+final ServiceAPIDescription serviceAPIDescription = new ServiceAPIDescription(); // ServiceAPIDescription | 
+
+try {
+    final result = await api_instance.apfIdServiceApisPost(apfId, serviceAPIDescription);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->apfIdServiceApisPost: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String apfId = apfId_example; // String | 
+        ServiceAPIDescription serviceAPIDescription = ; // ServiceAPIDescription | 
+
+        try {
+            ServiceAPIDescription result = apiInstance.apfIdServiceApisPost(apfId, serviceAPIDescription);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#apfIdServiceApisPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *apfId = apfId_example; //  (default to null)
+ServiceAPIDescription *serviceAPIDescription = ; // 
+
+[apiInstance apfIdServiceApisPostWith:apfId
+    serviceAPIDescription:serviceAPIDescription
+              completionHandler: ^(ServiceAPIDescription output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifPublishServiceApi = require('capif_publish_service_api');
+
+// Create an instance of the API class
+var api = new CapifPublishServiceApi.DefaultApi()
+var apfId = apfId_example; // {String} 
+var serviceAPIDescription = ; // {ServiceAPIDescription} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.apfIdServiceApisPost(apfId, serviceAPIDescription, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class apfIdServiceApisPostExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var apfId = apfId_example;  // String |  (default to null)
+            var serviceAPIDescription = new ServiceAPIDescription(); // ServiceAPIDescription | 
+
+            try {
+                ServiceAPIDescription result = apiInstance.apfIdServiceApisPost(apfId, serviceAPIDescription);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.apfIdServiceApisPost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$apfId = apfId_example; // String | 
+$serviceAPIDescription = ; // ServiceAPIDescription | 
+
+try {
+    $result = $api_instance->apfIdServiceApisPost($apfId, $serviceAPIDescription);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->apfIdServiceApisPost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $apfId = apfId_example; # String | 
+my $serviceAPIDescription = WWW::OPenAPIClient::Object::ServiceAPIDescription->new(); # ServiceAPIDescription | 
+
+eval {
+    my $result = $api_instance->apfIdServiceApisPost(apfId => $apfId, serviceAPIDescription => $serviceAPIDescription);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->apfIdServiceApisPost: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+apfId = apfId_example # String |  (default to null)
+serviceAPIDescription =  # ServiceAPIDescription | 
+
+try:
+    api_response = api_instance.apf_id_service_apis_post(apfId, serviceAPIDescription)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->apfIdServiceApisPost: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let apfId = apfId_example; // String
+    let serviceAPIDescription = ; // ServiceAPIDescription
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.apfIdServiceApisPost(apfId, serviceAPIDescription, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
apfId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
serviceAPIDescription * +

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

apfIdServiceApisServiceApiIdDelete

+

+
+
+
+

+

Unpublish a published service API.

+

+
+ 
/{apfId}/service-apis/{serviceApiId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X DELETE \
+ -H "Accept: application/problem+json" \
+ "https://example.com/published-apis/v1/{apfId}/service-apis/{serviceApiId}"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String serviceApiId = serviceApiId_example; // String | 
+        String apfId = apfId_example; // String | 
+
+        try {
+            apiInstance.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceApiId = new String(); // String | 
+final String apfId = new String(); // String | 
+
+try {
+    final result = await api_instance.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->apfIdServiceApisServiceApiIdDelete: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String serviceApiId = serviceApiId_example; // String | 
+        String apfId = apfId_example; // String | 
+
+        try {
+            apiInstance.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *serviceApiId = serviceApiId_example; //  (default to null)
+String *apfId = apfId_example; //  (default to null)
+
+[apiInstance apfIdServiceApisServiceApiIdDeleteWith:serviceApiId
+    apfId:apfId
+              completionHandler: ^(NSError* error) {
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifPublishServiceApi = require('capif_publish_service_api');
+
+// Create an instance of the API class
+var api = new CapifPublishServiceApi.DefaultApi()
+var serviceApiId = serviceApiId_example; // {String} 
+var apfId = apfId_example; // {String} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class apfIdServiceApisServiceApiIdDeleteExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var serviceApiId = serviceApiId_example;  // String |  (default to null)
+            var apfId = apfId_example;  // String |  (default to null)
+
+            try {
+                apiInstance.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.apfIdServiceApisServiceApiIdDelete: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$serviceApiId = serviceApiId_example; // String | 
+$apfId = apfId_example; // String | 
+
+try {
+    $api_instance->apfIdServiceApisServiceApiIdDelete($serviceApiId, $apfId);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->apfIdServiceApisServiceApiIdDelete: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $serviceApiId = serviceApiId_example; # String | 
+my $apfId = apfId_example; # String | 
+
+eval {
+    $api_instance->apfIdServiceApisServiceApiIdDelete(serviceApiId => $serviceApiId, apfId => $apfId);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->apfIdServiceApisServiceApiIdDelete: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+serviceApiId = serviceApiId_example # String |  (default to null)
+apfId = apfId_example # String |  (default to null)
+
+try:
+    api_instance.apf_id_service_apis_service_api_id_delete(serviceApiId, apfId)
+except ApiException as e:
+    print("Exception when calling DefaultApi->apfIdServiceApisServiceApiIdDelete: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let serviceApiId = serviceApiId_example; // String
+    let apfId = apfId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.apfIdServiceApisServiceApiIdDelete(serviceApiId, apfId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + + + + + +
NameDescription
serviceApiId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
apfId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

apfIdServiceApisServiceApiIdGet

+

+
+
+
+

+

Retrieve a published service API.

+

+
+ 
/{apfId}/service-apis/{serviceApiId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/published-apis/v1/{apfId}/service-apis/{serviceApiId}"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String serviceApiId = serviceApiId_example; // String | 
+        String apfId = apfId_example; // String | 
+
+        try {
+            ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceApiId = new String(); // String | 
+final String apfId = new String(); // String | 
+
+try {
+    final result = await api_instance.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->apfIdServiceApisServiceApiIdGet: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String serviceApiId = serviceApiId_example; // String | 
+        String apfId = apfId_example; // String | 
+
+        try {
+            ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *serviceApiId = serviceApiId_example; //  (default to null)
+String *apfId = apfId_example; //  (default to null)
+
+[apiInstance apfIdServiceApisServiceApiIdGetWith:serviceApiId
+    apfId:apfId
+              completionHandler: ^(ServiceAPIDescription output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifPublishServiceApi = require('capif_publish_service_api');
+
+// Create an instance of the API class
+var api = new CapifPublishServiceApi.DefaultApi()
+var serviceApiId = serviceApiId_example; // {String} 
+var apfId = apfId_example; // {String} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class apfIdServiceApisServiceApiIdGetExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var serviceApiId = serviceApiId_example;  // String |  (default to null)
+            var apfId = apfId_example;  // String |  (default to null)
+
+            try {
+                ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.apfIdServiceApisServiceApiIdGet: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$serviceApiId = serviceApiId_example; // String | 
+$apfId = apfId_example; // String | 
+
+try {
+    $result = $api_instance->apfIdServiceApisServiceApiIdGet($serviceApiId, $apfId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->apfIdServiceApisServiceApiIdGet: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $serviceApiId = serviceApiId_example; # String | 
+my $apfId = apfId_example; # String | 
+
+eval {
+    my $result = $api_instance->apfIdServiceApisServiceApiIdGet(serviceApiId => $serviceApiId, apfId => $apfId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->apfIdServiceApisServiceApiIdGet: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+serviceApiId = serviceApiId_example # String |  (default to null)
+apfId = apfId_example # String |  (default to null)
+
+try:
+    api_response = api_instance.apf_id_service_apis_service_api_id_get(serviceApiId, apfId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->apfIdServiceApisServiceApiIdGet: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let serviceApiId = serviceApiId_example; // String
+    let apfId = apfId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.apfIdServiceApisServiceApiIdGet(serviceApiId, apfId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + + + + + +
NameDescription
serviceApiId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
apfId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

apfIdServiceApisServiceApiIdPut

+

+
+
+
+

+

Update a published service API.

+

+
+ 
/{apfId}/service-apis/{serviceApiId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X PUT \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/published-apis/v1/{apfId}/service-apis/{serviceApiId}" \
+ -d '{
+  "ccfId" : "ccfId",
+  "serviceAPICategory" : "serviceAPICategory",
+  "apiName" : "apiName",
+  "shareableInfo" : {
+    "capifProvDoms" : [ "capifProvDoms", "capifProvDoms" ],
+    "isShareable" : true
+  },
+  "supportedFeatures" : "supportedFeatures",
+  "description" : "description",
+  "apiSuppFeats" : "apiSuppFeats",
+  "aefProfiles" : [ {
+    "securityMethods" : [ null, null ],
+    "versions" : [ {
+      "apiVersion" : "apiVersion",
+      "custOperations" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      } ],
+      "resources" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      } ],
+      "expiry" : "2000-01-23T04:56:07.000+00:00"
+    }, {
+      "apiVersion" : "apiVersion",
+      "custOperations" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      } ],
+      "resources" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      } ],
+      "expiry" : "2000-01-23T04:56:07.000+00:00"
+    } ],
+    "domainName" : "domainName",
+    "aefLocation" : {
+      "dcId" : "dcId",
+      "geoArea" : {
+        "point" : {
+          "lon" : 36.988422590534526,
+          "lat" : -75.5850925717018
+        }
+      },
+      "civicAddr" : {
+        "POBOX" : "POBOX",
+        "usageRules" : "usageRules",
+        "country" : "country",
+        "PRD" : "PRD",
+        "PLC" : "PLC",
+        "HNO" : "HNO",
+        "PRM" : "PRM",
+        "HNS" : "HNS",
+        "FLR" : "FLR",
+        "A1" : "A1",
+        "A2" : "A2",
+        "A3" : "A3",
+        "A4" : "A4",
+        "STS" : "STS",
+        "A5" : "A5",
+        "A6" : "A6",
+        "RDSEC" : "RDSEC",
+        "providedBy" : "providedBy",
+        "LOC" : "LOC",
+        "SEAT" : "SEAT",
+        "UNIT" : "UNIT",
+        "POD" : "POD",
+        "RDBR" : "RDBR",
+        "method" : "method",
+        "LMK" : "LMK",
+        "POM" : "POM",
+        "ADDCODE" : "ADDCODE",
+        "RD" : "RD",
+        "PC" : "PC",
+        "PCN" : "PCN",
+        "BLD" : "BLD",
+        "NAM" : "NAM",
+        "ROOM" : "ROOM",
+        "RDSUBBR" : "RDSUBBR"
+      }
+    },
+    "aefId" : "aefId",
+    "interfaceDescriptions" : [ {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 9606,
+      "ipv4Addr" : "ipv4Addr"
+    }, {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 9606,
+      "ipv4Addr" : "ipv4Addr"
+    } ]
+  }, {
+    "securityMethods" : [ null, null ],
+    "versions" : [ {
+      "apiVersion" : "apiVersion",
+      "custOperations" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      } ],
+      "resources" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      } ],
+      "expiry" : "2000-01-23T04:56:07.000+00:00"
+    }, {
+      "apiVersion" : "apiVersion",
+      "custOperations" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName"
+      } ],
+      "resources" : [ {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      }, {
+        "operations" : [ null, null ],
+        "description" : "description",
+        "custOpName" : "custOpName",
+        "resourceName" : "resourceName",
+        "uri" : "uri"
+      } ],
+      "expiry" : "2000-01-23T04:56:07.000+00:00"
+    } ],
+    "domainName" : "domainName",
+    "aefLocation" : {
+      "dcId" : "dcId",
+      "geoArea" : {
+        "point" : {
+          "lon" : 36.988422590534526,
+          "lat" : -75.5850925717018
+        }
+      },
+      "civicAddr" : {
+        "POBOX" : "POBOX",
+        "usageRules" : "usageRules",
+        "country" : "country",
+        "PRD" : "PRD",
+        "PLC" : "PLC",
+        "HNO" : "HNO",
+        "PRM" : "PRM",
+        "HNS" : "HNS",
+        "FLR" : "FLR",
+        "A1" : "A1",
+        "A2" : "A2",
+        "A3" : "A3",
+        "A4" : "A4",
+        "STS" : "STS",
+        "A5" : "A5",
+        "A6" : "A6",
+        "RDSEC" : "RDSEC",
+        "providedBy" : "providedBy",
+        "LOC" : "LOC",
+        "SEAT" : "SEAT",
+        "UNIT" : "UNIT",
+        "POD" : "POD",
+        "RDBR" : "RDBR",
+        "method" : "method",
+        "LMK" : "LMK",
+        "POM" : "POM",
+        "ADDCODE" : "ADDCODE",
+        "RD" : "RD",
+        "PC" : "PC",
+        "PCN" : "PCN",
+        "BLD" : "BLD",
+        "NAM" : "NAM",
+        "ROOM" : "ROOM",
+        "RDSUBBR" : "RDSUBBR"
+      }
+    },
+    "aefId" : "aefId",
+    "interfaceDescriptions" : [ {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 9606,
+      "ipv4Addr" : "ipv4Addr"
+    }, {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 9606,
+      "ipv4Addr" : "ipv4Addr"
+    } ]
+  } ],
+  "apiId" : "apiId",
+  "pubApiPath" : {
+    "ccfIds" : [ "ccfIds", "ccfIds" ]
+  }
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String serviceApiId = serviceApiId_example; // String | 
+        String apfId = apfId_example; // String | 
+        ServiceAPIDescription serviceAPIDescription = ; // ServiceAPIDescription | 
+
+        try {
+            ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdPut");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceApiId = new String(); // String | 
+final String apfId = new String(); // String | 
+final ServiceAPIDescription serviceAPIDescription = new ServiceAPIDescription(); // ServiceAPIDescription | 
+
+try {
+    final result = await api_instance.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->apfIdServiceApisServiceApiIdPut: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String serviceApiId = serviceApiId_example; // String | 
+        String apfId = apfId_example; // String | 
+        ServiceAPIDescription serviceAPIDescription = ; // ServiceAPIDescription | 
+
+        try {
+            ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#apfIdServiceApisServiceApiIdPut");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *serviceApiId = serviceApiId_example; //  (default to null)
+String *apfId = apfId_example; //  (default to null)
+ServiceAPIDescription *serviceAPIDescription = ; // 
+
+[apiInstance apfIdServiceApisServiceApiIdPutWith:serviceApiId
+    apfId:apfId
+    serviceAPIDescription:serviceAPIDescription
+              completionHandler: ^(ServiceAPIDescription output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifPublishServiceApi = require('capif_publish_service_api');
+
+// Create an instance of the API class
+var api = new CapifPublishServiceApi.DefaultApi()
+var serviceApiId = serviceApiId_example; // {String} 
+var apfId = apfId_example; // {String} 
+var serviceAPIDescription = ; // {ServiceAPIDescription} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class apfIdServiceApisServiceApiIdPutExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var serviceApiId = serviceApiId_example;  // String |  (default to null)
+            var apfId = apfId_example;  // String |  (default to null)
+            var serviceAPIDescription = new ServiceAPIDescription(); // ServiceAPIDescription | 
+
+            try {
+                ServiceAPIDescription result = apiInstance.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.apfIdServiceApisServiceApiIdPut: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$serviceApiId = serviceApiId_example; // String | 
+$apfId = apfId_example; // String | 
+$serviceAPIDescription = ; // ServiceAPIDescription | 
+
+try {
+    $result = $api_instance->apfIdServiceApisServiceApiIdPut($serviceApiId, $apfId, $serviceAPIDescription);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->apfIdServiceApisServiceApiIdPut: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $serviceApiId = serviceApiId_example; # String | 
+my $apfId = apfId_example; # String | 
+my $serviceAPIDescription = WWW::OPenAPIClient::Object::ServiceAPIDescription->new(); # ServiceAPIDescription | 
+
+eval {
+    my $result = $api_instance->apfIdServiceApisServiceApiIdPut(serviceApiId => $serviceApiId, apfId => $apfId, serviceAPIDescription => $serviceAPIDescription);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->apfIdServiceApisServiceApiIdPut: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+serviceApiId = serviceApiId_example # String |  (default to null)
+apfId = apfId_example # String |  (default to null)
+serviceAPIDescription =  # ServiceAPIDescription | 
+
+try:
+    api_response = api_instance.apf_id_service_apis_service_api_id_put(serviceApiId, apfId, serviceAPIDescription)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->apfIdServiceApisServiceApiIdPut: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let serviceApiId = serviceApiId_example; // String
+    let apfId = apfId_example; // String
+    let serviceAPIDescription = ; // ServiceAPIDescription
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.apfIdServiceApisServiceApiIdPut(serviceApiId, apfId, serviceAPIDescription, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + + + + + +
NameDescription
serviceApiId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
apfId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
serviceAPIDescription * +

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+

IndividualAPFPublishedAPI

+
+
+
+

modifyIndAPFPubAPI

+

+
+
+
+

+

Modify an existing published service API.

+

+
+ 
/{apfId}/service-apis/{serviceApiId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X PATCH \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/merge-patch+json" \
+ "https://example.com/published-apis/v1/{apfId}/service-apis/{serviceApiId}" \
+ -d 'Custom MIME type example not yet supported: application/merge-patch+json'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.IndividualAPFPublishedAPIApi;
+
+import java.io.File;
+import java.util.*;
+
+public class IndividualAPFPublishedAPIApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        IndividualAPFPublishedAPIApi apiInstance = new IndividualAPFPublishedAPIApi();
+        String serviceApiId = serviceApiId_example; // String | 
+        String apfId = apfId_example; // String | 
+        ServiceAPIDescriptionPatch serviceAPIDescriptionPatch = ; // ServiceAPIDescriptionPatch | 
+
+        try {
+            ServiceAPIDescription result = apiInstance.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling IndividualAPFPublishedAPIApi#modifyIndAPFPubAPI");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceApiId = new String(); // String | 
+final String apfId = new String(); // String | 
+final ServiceAPIDescriptionPatch serviceAPIDescriptionPatch = new ServiceAPIDescriptionPatch(); // ServiceAPIDescriptionPatch | 
+
+try {
+    final result = await api_instance.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->modifyIndAPFPubAPI: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.IndividualAPFPublishedAPIApi;
+
+public class IndividualAPFPublishedAPIApiExample {
+    public static void main(String[] args) {
+        IndividualAPFPublishedAPIApi apiInstance = new IndividualAPFPublishedAPIApi();
+        String serviceApiId = serviceApiId_example; // String | 
+        String apfId = apfId_example; // String | 
+        ServiceAPIDescriptionPatch serviceAPIDescriptionPatch = ; // ServiceAPIDescriptionPatch | 
+
+        try {
+            ServiceAPIDescription result = apiInstance.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling IndividualAPFPublishedAPIApi#modifyIndAPFPubAPI");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+IndividualAPFPublishedAPIApi *apiInstance = [[IndividualAPFPublishedAPIApi alloc] init];
+String *serviceApiId = serviceApiId_example; //  (default to null)
+String *apfId = apfId_example; //  (default to null)
+ServiceAPIDescriptionPatch *serviceAPIDescriptionPatch = ; // 
+
+[apiInstance modifyIndAPFPubAPIWith:serviceApiId
+    apfId:apfId
+    serviceAPIDescriptionPatch:serviceAPIDescriptionPatch
+              completionHandler: ^(ServiceAPIDescription output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifPublishServiceApi = require('capif_publish_service_api');
+
+// Create an instance of the API class
+var api = new CapifPublishServiceApi.IndividualAPFPublishedAPIApi()
+var serviceApiId = serviceApiId_example; // {String} 
+var apfId = apfId_example; // {String} 
+var serviceAPIDescriptionPatch = ; // {ServiceAPIDescriptionPatch} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class modifyIndAPFPubAPIExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new IndividualAPFPublishedAPIApi();
+            var serviceApiId = serviceApiId_example;  // String |  (default to null)
+            var apfId = apfId_example;  // String |  (default to null)
+            var serviceAPIDescriptionPatch = new ServiceAPIDescriptionPatch(); // ServiceAPIDescriptionPatch | 
+
+            try {
+                ServiceAPIDescription result = apiInstance.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling IndividualAPFPublishedAPIApi.modifyIndAPFPubAPI: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\IndividualAPFPublishedAPIApi();
+$serviceApiId = serviceApiId_example; // String | 
+$apfId = apfId_example; // String | 
+$serviceAPIDescriptionPatch = ; // ServiceAPIDescriptionPatch | 
+
+try {
+    $result = $api_instance->modifyIndAPFPubAPI($serviceApiId, $apfId, $serviceAPIDescriptionPatch);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling IndividualAPFPublishedAPIApi->modifyIndAPFPubAPI: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::IndividualAPFPublishedAPIApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::IndividualAPFPublishedAPIApi->new();
+my $serviceApiId = serviceApiId_example; # String | 
+my $apfId = apfId_example; # String | 
+my $serviceAPIDescriptionPatch = WWW::OPenAPIClient::Object::ServiceAPIDescriptionPatch->new(); # ServiceAPIDescriptionPatch | 
+
+eval {
+    my $result = $api_instance->modifyIndAPFPubAPI(serviceApiId => $serviceApiId, apfId => $apfId, serviceAPIDescriptionPatch => $serviceAPIDescriptionPatch);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling IndividualAPFPublishedAPIApi->modifyIndAPFPubAPI: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.IndividualAPFPublishedAPIApi()
+serviceApiId = serviceApiId_example # String |  (default to null)
+apfId = apfId_example # String |  (default to null)
+serviceAPIDescriptionPatch =  # ServiceAPIDescriptionPatch | 
+
+try:
+    api_response = api_instance.modify_ind_apf_pub_api(serviceApiId, apfId, serviceAPIDescriptionPatch)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling IndividualAPFPublishedAPIApi->modifyIndAPFPubAPI: %s\n" % e)
+
+ +
+ 
extern crate IndividualAPFPublishedAPIApi;
+
+pub fn main() {
+    let serviceApiId = serviceApiId_example; // String
+    let apfId = apfId_example; // String
+    let serviceAPIDescriptionPatch = ; // ServiceAPIDescriptionPatch
+
+    let mut context = IndividualAPFPublishedAPIApi::Context::default();
+    let result = client.modifyIndAPFPubAPI(serviceApiId, apfId, serviceAPIDescriptionPatch, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + + + + + +
NameDescription
serviceApiId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
apfId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
serviceAPIDescriptionPatch * +

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/docs/openapi/Security.html b/docs/openapi/Security.html new file mode 100644 index 0000000..e0ac00b --- /dev/null +++ b/docs/openapi/Security.html @@ -0,0 +1,11024 @@ + + + + + CAPIF_Security_API + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

CAPIF_Security_API

+
+
+
+ +
+
+

Default

+
+
+
+

securitiesSecurityIdTokenPost

+

+
+
+
+

+

+

+
+ 
/securities/{securityId}/token
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/x-www-form-urlencoded" \
+ "https://example.com/capif-security/v1/securities/{securityId}/token"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String securityId = securityId_example; // String | Identifier of an individual API invoker
+        String clientId = clientId_example; // String | 
+        String grantType = grantType_example; // String | 
+        String clientSecret = clientSecret_example; // String | 
+        String scope = scope_example; // String | 
+
+        try {
+            AccessTokenRsp result = apiInstance.securitiesSecurityIdTokenPost(securityId, clientId, grantType, clientSecret, scope);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#securitiesSecurityIdTokenPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String securityId = new String(); // String | Identifier of an individual API invoker
+final String clientId = new String(); // String | 
+final String grantType = new String(); // String | 
+final String clientSecret = new String(); // String | 
+final String scope = new String(); // String | 
+
+try {
+    final result = await api_instance.securitiesSecurityIdTokenPost(securityId, clientId, grantType, clientSecret, scope);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->securitiesSecurityIdTokenPost: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String securityId = securityId_example; // String | Identifier of an individual API invoker
+        String clientId = clientId_example; // String | 
+        String grantType = grantType_example; // String | 
+        String clientSecret = clientSecret_example; // String | 
+        String scope = scope_example; // String | 
+
+        try {
+            AccessTokenRsp result = apiInstance.securitiesSecurityIdTokenPost(securityId, clientId, grantType, clientSecret, scope);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#securitiesSecurityIdTokenPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *securityId = securityId_example; // Identifier of an individual API invoker (default to null)
+String *clientId = clientId_example; //  (default to null)
+String *grantType = grantType_example; //  (default to null)
+String *clientSecret = clientSecret_example; //  (optional) (default to null)
+String *scope = scope_example; //  (optional) (default to null)
+
+[apiInstance securitiesSecurityIdTokenPostWith:securityId
+    clientId:clientId
+    grantType:grantType
+    clientSecret:clientSecret
+    scope:scope
+              completionHandler: ^(AccessTokenRsp output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifSecurityApi = require('capif_security_api');
+
+// Create an instance of the API class
+var api = new CapifSecurityApi.DefaultApi()
+var securityId = securityId_example; // {String} Identifier of an individual API invoker
+var clientId = clientId_example; // {String} 
+var grantType = grantType_example; // {String} 
+var opts = {
+  'clientSecret': clientSecret_example, // {String} 
+  'scope': scope_example // {String} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.securitiesSecurityIdTokenPost(securityId, clientId, grantType, opts, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class securitiesSecurityIdTokenPostExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var securityId = securityId_example;  // String | Identifier of an individual API invoker (default to null)
+            var clientId = clientId_example;  // String |  (default to null)
+            var grantType = grantType_example;  // String |  (default to null)
+            var clientSecret = clientSecret_example;  // String |  (optional)  (default to null)
+            var scope = scope_example;  // String |  (optional)  (default to null)
+
+            try {
+                AccessTokenRsp result = apiInstance.securitiesSecurityIdTokenPost(securityId, clientId, grantType, clientSecret, scope);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.securitiesSecurityIdTokenPost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$securityId = securityId_example; // String | Identifier of an individual API invoker
+$clientId = clientId_example; // String | 
+$grantType = grantType_example; // String | 
+$clientSecret = clientSecret_example; // String | 
+$scope = scope_example; // String | 
+
+try {
+    $result = $api_instance->securitiesSecurityIdTokenPost($securityId, $clientId, $grantType, $clientSecret, $scope);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->securitiesSecurityIdTokenPost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $securityId = securityId_example; # String | Identifier of an individual API invoker
+my $clientId = clientId_example; # String | 
+my $grantType = grantType_example; # String | 
+my $clientSecret = clientSecret_example; # String | 
+my $scope = scope_example; # String | 
+
+eval {
+    my $result = $api_instance->securitiesSecurityIdTokenPost(securityId => $securityId, clientId => $clientId, grantType => $grantType, clientSecret => $clientSecret, scope => $scope);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->securitiesSecurityIdTokenPost: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+securityId = securityId_example # String | Identifier of an individual API invoker (default to null)
+clientId = clientId_example # String |  (default to null)
+grantType = grantType_example # String |  (default to null)
+clientSecret = clientSecret_example # String |  (optional) (default to null)
+scope = scope_example # String |  (optional) (default to null)
+
+try:
+    api_response = api_instance.securities_security_id_token_post(securityId, clientId, grantType, clientSecret=clientSecret, scope=scope)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->securitiesSecurityIdTokenPost: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let securityId = securityId_example; // String
+    let clientId = clientId_example; // String
+    let grantType = grantType_example; // String
+    let clientSecret = clientSecret_example; // String
+    let scope = scope_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.securitiesSecurityIdTokenPost(securityId, clientId, grantType, clientSecret, scope, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
securityId* + + +
+
+
+ + String + + +
+Identifier of an individual API invoker +
+
+
+ Required +
+
+
+
+ + + +
Form parameters
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
client_id* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
client_secret + + +
+
+
+ + String + + +
+
+
+
grant_type* + + +
+
+
+ + String + + +
+
+ + Enum: client_credentials + +
+
+ Required +
+
+
+
scope + + +
+
+
+ + String + + +
+
+
+
+ + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

trustedInvokersApiInvokerIdDelete

+

+
+
+
+

+

+

+
+ 
/trustedInvokers/{apiInvokerId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X DELETE \
+ -H "Accept: application/problem+json" \
+ "https://example.com/capif-security/v1/trustedInvokers/{apiInvokerId}"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+
+        try {
+            apiInstance.trustedInvokersApiInvokerIdDelete(apiInvokerId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#trustedInvokersApiInvokerIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String apiInvokerId = new String(); // String | Identifier of an individual API invoker
+
+try {
+    final result = await api_instance.trustedInvokersApiInvokerIdDelete(apiInvokerId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->trustedInvokersApiInvokerIdDelete: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+
+        try {
+            apiInstance.trustedInvokersApiInvokerIdDelete(apiInvokerId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#trustedInvokersApiInvokerIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *apiInvokerId = apiInvokerId_example; // Identifier of an individual API invoker (default to null)
+
+[apiInstance trustedInvokersApiInvokerIdDeleteWith:apiInvokerId
+              completionHandler: ^(NSError* error) {
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifSecurityApi = require('capif_security_api');
+
+// Create an instance of the API class
+var api = new CapifSecurityApi.DefaultApi()
+var apiInvokerId = apiInvokerId_example; // {String} Identifier of an individual API invoker
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.trustedInvokersApiInvokerIdDelete(apiInvokerId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class trustedInvokersApiInvokerIdDeleteExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var apiInvokerId = apiInvokerId_example;  // String | Identifier of an individual API invoker (default to null)
+
+            try {
+                apiInstance.trustedInvokersApiInvokerIdDelete(apiInvokerId);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.trustedInvokersApiInvokerIdDelete: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+
+try {
+    $api_instance->trustedInvokersApiInvokerIdDelete($apiInvokerId);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->trustedInvokersApiInvokerIdDelete: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $apiInvokerId = apiInvokerId_example; # String | Identifier of an individual API invoker
+
+eval {
+    $api_instance->trustedInvokersApiInvokerIdDelete(apiInvokerId => $apiInvokerId);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->trustedInvokersApiInvokerIdDelete: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+apiInvokerId = apiInvokerId_example # String | Identifier of an individual API invoker (default to null)
+
+try:
+    api_instance.trusted_invokers_api_invoker_id_delete(apiInvokerId)
+except ApiException as e:
+    print("Exception when calling DefaultApi->trustedInvokersApiInvokerIdDelete: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let apiInvokerId = apiInvokerId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.trustedInvokersApiInvokerIdDelete(apiInvokerId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
apiInvokerId* + + +
+
+
+ + String + + +
+Identifier of an individual API invoker +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

trustedInvokersApiInvokerIdDeletePost

+

+
+
+
+

+

+

+
+ 
/trustedInvokers/{apiInvokerId}/delete
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST \
+ -H "Accept: application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/capif-security/v1/trustedInvokers/{apiInvokerId}/delete" \
+ -d '{
+  "apiInvokerId" : "apiInvokerId",
+  "aefId" : "aefId",
+  "apiIds" : [ "apiIds", "apiIds" ]
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+        SecurityNotification securityNotification = ; // SecurityNotification | 
+
+        try {
+            apiInstance.trustedInvokersApiInvokerIdDeletePost(apiInvokerId, securityNotification);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#trustedInvokersApiInvokerIdDeletePost");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String apiInvokerId = new String(); // String | Identifier of an individual API invoker
+final SecurityNotification securityNotification = new SecurityNotification(); // SecurityNotification | 
+
+try {
+    final result = await api_instance.trustedInvokersApiInvokerIdDeletePost(apiInvokerId, securityNotification);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->trustedInvokersApiInvokerIdDeletePost: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+        SecurityNotification securityNotification = ; // SecurityNotification | 
+
+        try {
+            apiInstance.trustedInvokersApiInvokerIdDeletePost(apiInvokerId, securityNotification);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#trustedInvokersApiInvokerIdDeletePost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *apiInvokerId = apiInvokerId_example; // Identifier of an individual API invoker (default to null)
+SecurityNotification *securityNotification = ; // 
+
+[apiInstance trustedInvokersApiInvokerIdDeletePostWith:apiInvokerId
+    securityNotification:securityNotification
+              completionHandler: ^(NSError* error) {
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifSecurityApi = require('capif_security_api');
+
+// Create an instance of the API class
+var api = new CapifSecurityApi.DefaultApi()
+var apiInvokerId = apiInvokerId_example; // {String} Identifier of an individual API invoker
+var securityNotification = ; // {SecurityNotification} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.trustedInvokersApiInvokerIdDeletePost(apiInvokerId, securityNotification, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class trustedInvokersApiInvokerIdDeletePostExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var apiInvokerId = apiInvokerId_example;  // String | Identifier of an individual API invoker (default to null)
+            var securityNotification = new SecurityNotification(); // SecurityNotification | 
+
+            try {
+                apiInstance.trustedInvokersApiInvokerIdDeletePost(apiInvokerId, securityNotification);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.trustedInvokersApiInvokerIdDeletePost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+$securityNotification = ; // SecurityNotification | 
+
+try {
+    $api_instance->trustedInvokersApiInvokerIdDeletePost($apiInvokerId, $securityNotification);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->trustedInvokersApiInvokerIdDeletePost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $apiInvokerId = apiInvokerId_example; # String | Identifier of an individual API invoker
+my $securityNotification = WWW::OPenAPIClient::Object::SecurityNotification->new(); # SecurityNotification | 
+
+eval {
+    $api_instance->trustedInvokersApiInvokerIdDeletePost(apiInvokerId => $apiInvokerId, securityNotification => $securityNotification);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->trustedInvokersApiInvokerIdDeletePost: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+apiInvokerId = apiInvokerId_example # String | Identifier of an individual API invoker (default to null)
+securityNotification =  # SecurityNotification | 
+
+try:
+    api_instance.trusted_invokers_api_invoker_id_delete_post(apiInvokerId, securityNotification)
+except ApiException as e:
+    print("Exception when calling DefaultApi->trustedInvokersApiInvokerIdDeletePost: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let apiInvokerId = apiInvokerId_example; // String
+    let securityNotification = ; // SecurityNotification
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.trustedInvokersApiInvokerIdDeletePost(apiInvokerId, securityNotification, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
apiInvokerId* + + +
+
+
+ + String + + +
+Identifier of an individual API invoker +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
securityNotification * +

Revoke the authorization of the API invoker for APIs.

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

trustedInvokersApiInvokerIdGet

+

+
+
+
+

+

+

+
+ 
/trustedInvokers/{apiInvokerId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/capif-security/v1/trustedInvokers/{apiInvokerId}?authenticationInfo=true&authorizationInfo=true"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+        Boolean authenticationInfo = true; // Boolean | When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise.
+
+        Boolean authorizationInfo = true; // Boolean | When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise.
+
+
+        try {
+            ServiceSecurity result = apiInstance.trustedInvokersApiInvokerIdGet(apiInvokerId, authenticationInfo, authorizationInfo);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#trustedInvokersApiInvokerIdGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String apiInvokerId = new String(); // String | Identifier of an individual API invoker
+final Boolean authenticationInfo = new Boolean(); // Boolean | When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise.
+
+final Boolean authorizationInfo = new Boolean(); // Boolean | When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise.
+
+
+try {
+    final result = await api_instance.trustedInvokersApiInvokerIdGet(apiInvokerId, authenticationInfo, authorizationInfo);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->trustedInvokersApiInvokerIdGet: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+        Boolean authenticationInfo = true; // Boolean | When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise.
+
+        Boolean authorizationInfo = true; // Boolean | When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise.
+
+
+        try {
+            ServiceSecurity result = apiInstance.trustedInvokersApiInvokerIdGet(apiInvokerId, authenticationInfo, authorizationInfo);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#trustedInvokersApiInvokerIdGet");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *apiInvokerId = apiInvokerId_example; // Identifier of an individual API invoker (default to null)
+Boolean *authenticationInfo = true; // When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise.
+ (optional) (default to null)
+Boolean *authorizationInfo = true; // When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise.
+ (optional) (default to null)
+
+[apiInstance trustedInvokersApiInvokerIdGetWith:apiInvokerId
+    authenticationInfo:authenticationInfo
+    authorizationInfo:authorizationInfo
+              completionHandler: ^(ServiceSecurity output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifSecurityApi = require('capif_security_api');
+
+// Create an instance of the API class
+var api = new CapifSecurityApi.DefaultApi()
+var apiInvokerId = apiInvokerId_example; // {String} Identifier of an individual API invoker
+var opts = {
+  'authenticationInfo': true, // {Boolean} When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise.
+
+  'authorizationInfo': true // {Boolean} When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise.
+
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.trustedInvokersApiInvokerIdGet(apiInvokerId, opts, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class trustedInvokersApiInvokerIdGetExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var apiInvokerId = apiInvokerId_example;  // String | Identifier of an individual API invoker (default to null)
+            var authenticationInfo = true;  // Boolean | When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise.
+ (optional)  (default to null)
+            var authorizationInfo = true;  // Boolean | When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise.
+ (optional)  (default to null)
+
+            try {
+                ServiceSecurity result = apiInstance.trustedInvokersApiInvokerIdGet(apiInvokerId, authenticationInfo, authorizationInfo);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.trustedInvokersApiInvokerIdGet: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+$authenticationInfo = true; // Boolean | When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise.
+
+$authorizationInfo = true; // Boolean | When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise.
+
+
+try {
+    $result = $api_instance->trustedInvokersApiInvokerIdGet($apiInvokerId, $authenticationInfo, $authorizationInfo);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->trustedInvokersApiInvokerIdGet: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $apiInvokerId = apiInvokerId_example; # String | Identifier of an individual API invoker
+my $authenticationInfo = true; # Boolean | When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise.
+
+my $authorizationInfo = true; # Boolean | When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise.
+
+
+eval {
+    my $result = $api_instance->trustedInvokersApiInvokerIdGet(apiInvokerId => $apiInvokerId, authenticationInfo => $authenticationInfo, authorizationInfo => $authorizationInfo);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->trustedInvokersApiInvokerIdGet: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+apiInvokerId = apiInvokerId_example # String | Identifier of an individual API invoker (default to null)
+authenticationInfo = true # Boolean | When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise.
+ (optional) (default to null)
+authorizationInfo = true # Boolean | When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise.
+ (optional) (default to null)
+
+try:
+    api_response = api_instance.trusted_invokers_api_invoker_id_get(apiInvokerId, authenticationInfo=authenticationInfo, authorizationInfo=authorizationInfo)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->trustedInvokersApiInvokerIdGet: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let apiInvokerId = apiInvokerId_example; // String
+    let authenticationInfo = true; // Boolean
+    let authorizationInfo = true; // Boolean
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.trustedInvokersApiInvokerIdGet(apiInvokerId, authenticationInfo, authorizationInfo, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
apiInvokerId* + + +
+
+
+ + String + + +
+Identifier of an individual API invoker +
+
+
+ Required +
+
+
+
+ + + + +
Query parameters
+ + + + + + + + + + + + + +
NameDescription
authenticationInfo + + +
+
+
+ + Boolean + + +
+When set to 'true', it indicates the CAPIF core function to send the authentication information of the API invoker. Set to false or omitted otherwise. + +
+
+
+
+
authorizationInfo + + +
+
+
+ + Boolean + + +
+When set to 'true', it indicates the CAPIF core function to send the authorization information of the API invoker. Set to false or omitted otherwise. + +
+
+
+
+
+ +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

trustedInvokersApiInvokerIdPut

+

+
+
+
+

+

+

+
+ 
/trustedInvokers/{apiInvokerId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X PUT \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/capif-security/v1/trustedInvokers/{apiInvokerId}" \
+ -d '{
+  "notificationDestination" : "notificationDestination",
+  "supportedFeatures" : "supportedFeatures",
+  "securityInfo" : [ {
+    "authenticationInfo" : "authenticationInfo",
+    "authorizationInfo" : "authorizationInfo",
+    "interfaceDetails" : {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 5248,
+      "ipv4Addr" : "ipv4Addr"
+    },
+    "prefSecurityMethods" : [ null, null ],
+    "aefId" : "aefId",
+    "apiId" : "apiId"
+  }, {
+    "authenticationInfo" : "authenticationInfo",
+    "authorizationInfo" : "authorizationInfo",
+    "interfaceDetails" : {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 5248,
+      "ipv4Addr" : "ipv4Addr"
+    },
+    "prefSecurityMethods" : [ null, null ],
+    "aefId" : "aefId",
+    "apiId" : "apiId"
+  } ],
+  "websockNotifConfig" : {
+    "requestWebsocketUri" : true,
+    "websocketUri" : "websocketUri"
+  },
+  "requestTestNotification" : true
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+        ServiceSecurity serviceSecurity = ; // ServiceSecurity | 
+
+        try {
+            ServiceSecurity result = apiInstance.trustedInvokersApiInvokerIdPut(apiInvokerId, serviceSecurity);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#trustedInvokersApiInvokerIdPut");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String apiInvokerId = new String(); // String | Identifier of an individual API invoker
+final ServiceSecurity serviceSecurity = new ServiceSecurity(); // ServiceSecurity | 
+
+try {
+    final result = await api_instance.trustedInvokersApiInvokerIdPut(apiInvokerId, serviceSecurity);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->trustedInvokersApiInvokerIdPut: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+        ServiceSecurity serviceSecurity = ; // ServiceSecurity | 
+
+        try {
+            ServiceSecurity result = apiInstance.trustedInvokersApiInvokerIdPut(apiInvokerId, serviceSecurity);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#trustedInvokersApiInvokerIdPut");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *apiInvokerId = apiInvokerId_example; // Identifier of an individual API invoker (default to null)
+ServiceSecurity *serviceSecurity = ; // 
+
+[apiInstance trustedInvokersApiInvokerIdPutWith:apiInvokerId
+    serviceSecurity:serviceSecurity
+              completionHandler: ^(ServiceSecurity output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifSecurityApi = require('capif_security_api');
+
+// Create an instance of the API class
+var api = new CapifSecurityApi.DefaultApi()
+var apiInvokerId = apiInvokerId_example; // {String} Identifier of an individual API invoker
+var serviceSecurity = ; // {ServiceSecurity} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.trustedInvokersApiInvokerIdPut(apiInvokerId, serviceSecurity, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class trustedInvokersApiInvokerIdPutExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var apiInvokerId = apiInvokerId_example;  // String | Identifier of an individual API invoker (default to null)
+            var serviceSecurity = new ServiceSecurity(); // ServiceSecurity | 
+
+            try {
+                ServiceSecurity result = apiInstance.trustedInvokersApiInvokerIdPut(apiInvokerId, serviceSecurity);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.trustedInvokersApiInvokerIdPut: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+$serviceSecurity = ; // ServiceSecurity | 
+
+try {
+    $result = $api_instance->trustedInvokersApiInvokerIdPut($apiInvokerId, $serviceSecurity);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->trustedInvokersApiInvokerIdPut: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $apiInvokerId = apiInvokerId_example; # String | Identifier of an individual API invoker
+my $serviceSecurity = WWW::OPenAPIClient::Object::ServiceSecurity->new(); # ServiceSecurity | 
+
+eval {
+    my $result = $api_instance->trustedInvokersApiInvokerIdPut(apiInvokerId => $apiInvokerId, serviceSecurity => $serviceSecurity);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->trustedInvokersApiInvokerIdPut: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+apiInvokerId = apiInvokerId_example # String | Identifier of an individual API invoker (default to null)
+serviceSecurity =  # ServiceSecurity | 
+
+try:
+    api_response = api_instance.trusted_invokers_api_invoker_id_put(apiInvokerId, serviceSecurity)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->trustedInvokersApiInvokerIdPut: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let apiInvokerId = apiInvokerId_example; // String
+    let serviceSecurity = ; // ServiceSecurity
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.trustedInvokersApiInvokerIdPut(apiInvokerId, serviceSecurity, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
apiInvokerId* + + +
+
+
+ + String + + +
+Identifier of an individual API invoker +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
serviceSecurity * +

create a security context for an API invoker

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+
+

trustedInvokersApiInvokerIdUpdatePost

+

+
+
+
+

+

+

+
+ 
/trustedInvokers/{apiInvokerId}/update
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/capif-security/v1/trustedInvokers/{apiInvokerId}/update" \
+ -d '{
+  "notificationDestination" : "notificationDestination",
+  "supportedFeatures" : "supportedFeatures",
+  "securityInfo" : [ {
+    "authenticationInfo" : "authenticationInfo",
+    "authorizationInfo" : "authorizationInfo",
+    "interfaceDetails" : {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 5248,
+      "ipv4Addr" : "ipv4Addr"
+    },
+    "prefSecurityMethods" : [ null, null ],
+    "aefId" : "aefId",
+    "apiId" : "apiId"
+  }, {
+    "authenticationInfo" : "authenticationInfo",
+    "authorizationInfo" : "authorizationInfo",
+    "interfaceDetails" : {
+      "ipv6Addr" : "ipv6Addr",
+      "securityMethods" : [ null, null ],
+      "port" : 5248,
+      "ipv4Addr" : "ipv4Addr"
+    },
+    "prefSecurityMethods" : [ null, null ],
+    "aefId" : "aefId",
+    "apiId" : "apiId"
+  } ],
+  "websockNotifConfig" : {
+    "requestWebsocketUri" : true,
+    "websocketUri" : "websocketUri"
+  },
+  "requestTestNotification" : true
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+        ServiceSecurity serviceSecurity = ; // ServiceSecurity | 
+
+        try {
+            ServiceSecurity result = apiInstance.trustedInvokersApiInvokerIdUpdatePost(apiInvokerId, serviceSecurity);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#trustedInvokersApiInvokerIdUpdatePost");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String apiInvokerId = new String(); // String | Identifier of an individual API invoker
+final ServiceSecurity serviceSecurity = new ServiceSecurity(); // ServiceSecurity | 
+
+try {
+    final result = await api_instance.trustedInvokersApiInvokerIdUpdatePost(apiInvokerId, serviceSecurity);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->trustedInvokersApiInvokerIdUpdatePost: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+        ServiceSecurity serviceSecurity = ; // ServiceSecurity | 
+
+        try {
+            ServiceSecurity result = apiInstance.trustedInvokersApiInvokerIdUpdatePost(apiInvokerId, serviceSecurity);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#trustedInvokersApiInvokerIdUpdatePost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *apiInvokerId = apiInvokerId_example; // Identifier of an individual API invoker (default to null)
+ServiceSecurity *serviceSecurity = ; // 
+
+[apiInstance trustedInvokersApiInvokerIdUpdatePostWith:apiInvokerId
+    serviceSecurity:serviceSecurity
+              completionHandler: ^(ServiceSecurity output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var CapifSecurityApi = require('capif_security_api');
+
+// Create an instance of the API class
+var api = new CapifSecurityApi.DefaultApi()
+var apiInvokerId = apiInvokerId_example; // {String} Identifier of an individual API invoker
+var serviceSecurity = ; // {ServiceSecurity} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.trustedInvokersApiInvokerIdUpdatePost(apiInvokerId, serviceSecurity, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class trustedInvokersApiInvokerIdUpdatePostExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var apiInvokerId = apiInvokerId_example;  // String | Identifier of an individual API invoker (default to null)
+            var serviceSecurity = new ServiceSecurity(); // ServiceSecurity | 
+
+            try {
+                ServiceSecurity result = apiInstance.trustedInvokersApiInvokerIdUpdatePost(apiInvokerId, serviceSecurity);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.trustedInvokersApiInvokerIdUpdatePost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$apiInvokerId = apiInvokerId_example; // String | Identifier of an individual API invoker
+$serviceSecurity = ; // ServiceSecurity | 
+
+try {
+    $result = $api_instance->trustedInvokersApiInvokerIdUpdatePost($apiInvokerId, $serviceSecurity);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->trustedInvokersApiInvokerIdUpdatePost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $apiInvokerId = apiInvokerId_example; # String | Identifier of an individual API invoker
+my $serviceSecurity = WWW::OPenAPIClient::Object::ServiceSecurity->new(); # ServiceSecurity | 
+
+eval {
+    my $result = $api_instance->trustedInvokersApiInvokerIdUpdatePost(apiInvokerId => $apiInvokerId, serviceSecurity => $serviceSecurity);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->trustedInvokersApiInvokerIdUpdatePost: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+apiInvokerId = apiInvokerId_example # String | Identifier of an individual API invoker (default to null)
+serviceSecurity =  # ServiceSecurity | 
+
+try:
+    api_response = api_instance.trusted_invokers_api_invoker_id_update_post(apiInvokerId, serviceSecurity)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->trustedInvokersApiInvokerIdUpdatePost: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let apiInvokerId = apiInvokerId_example; // String
+    let serviceSecurity = ; // ServiceSecurity
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.trustedInvokersApiInvokerIdUpdatePost(apiInvokerId, serviceSecurity, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
apiInvokerId* + + +
+
+
+ + String + + +
+Identifier of an individual API invoker +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
serviceSecurity * +

Update the security context (e.g. re-negotiate the security methods).

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+
+
+
+
+
+ +
+
+
+ + + + + + + + + + + + + + diff --git a/servicemanager/generate.sh b/servicemanager/generate.sh index 3292703..cd9b0eb 100755 --- a/servicemanager/generate.sh +++ b/servicemanager/generate.sh @@ -169,6 +169,67 @@ generate_apis_from_spec () { oapi-codegen --config "gogeneratorspecs/discoverserviceapi/generator_settings_client.yaml" specs/TS29222_CAPIF_Discover_Service_API.yaml } +generate_html2_from_spec() { + cd $cwd + + echo "Generating Provider_Management HTML" + docker run --rm \ + -u $(id -u ${USER}):$(id -g ${USER}) \ + -v ${PWD}:/local openapitools/openapi-generator-cli generate \ + -i /local/specs/TS29222_CAPIF_API_Provider_Management_API.yaml \ + -g html2 \ + -o /local/openapi/html2/Provider_Management + mv -v openapi/html2/Provider_Management/index.html openapi/html2/Provider_Management/Provider_Management.html + + echo "Generating Publish_Service HTML" + docker run --rm \ + -u $(id -u ${USER}):$(id -g ${USER}) \ + -v ${PWD}:/local openapitools/openapi-generator-cli generate \ + -i /local/specs/TS29222_CAPIF_Publish_Service_API.yaml \ + -g html2 \ + -o /local/openapi/html2/Publish_Service + mv -v openapi/html2/Publish_Service/index.html openapi/html2/Publish_Service/Publish_Service.html + + echo "Generating Invoker_Management HTML" + docker run --rm \ + -u $(id -u ${USER}):$(id -g ${USER}) \ + -v ${PWD}:/local openapitools/openapi-generator-cli generate \ + -i /local/specs/TS29222_CAPIF_API_Invoker_Management_API.yaml \ + -g html2 \ + -o /local/openapi/html2/Invoker_Management + mv -v openapi/html2/Invoker_Management/index.html openapi/html2/Invoker_Management/Invoker_Management.html + + echo "Generating Discover_Service HTML" + docker run --rm \ + -u $(id -u ${USER}):$(id -g ${USER}) \ + -v ${PWD}:/local openapitools/openapi-generator-cli generate \ + -i /local/specs/TS29222_CAPIF_Discover_Service_API.yaml \ + -g html2 \ + -o /local/openapi/html2/Discover_Service + mv -v openapi/html2/Discover_Service/index.html openapi/html2/Discover_Service/Discover_Service.html + + echo "Generating Events HTML" + docker run --rm \ + -u $(id -u ${USER}):$(id -g ${USER}) \ + -v ${PWD}:/local openapitools/openapi-generator-cli generate \ + -i /local/specs/TS29222_CAPIF_Events_API.yaml \ + -g html2 \ + -o /local/openapi/html2/Events + mv -v openapi/html2/Events/index.html openapi/html2/Events/Events.html + + echo "Generating Security HTML" + docker run --rm \ + -u $(id -u ${USER}):$(id -g ${USER}) \ + -v ${PWD}:/local openapitools/openapi-generator-cli generate \ + -i /local/specs/TS29222_CAPIF_Security_API.yaml \ + -g html2 \ + -o /local/openapi/html2/Security + mv -v openapi/html2/Security/index.html openapi/html2/Security/Security.html + + mkdir -vp ../docs/openapi + find openapi/html2 -type f -name "*.html" -exec cp -v {} ../docs/openapi \; +} + run_tests () { # Make sure that SERVICE_MANAGER_ENV is configured with the required .env file, e.g. # export SERVICE_MANAGER_ENV=development @@ -202,6 +263,9 @@ spec_extraction fix_with_sed gentools generate_apis_from_spec +generate_html2_from_spec + +cd $cwd # Check if the run-tests switch is enabled if [ "$RUN_TESTS" = true ]; then -- 2.16.6