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

Name	Description
onboardingId*	String String identifying an individual on-boarded API invoker resource Required

Responses

Status: 204 - The individual API Invoker matching onboardingId was offboarded.

Status: 307 - Temporary Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 308 - Permanent Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 400 - Bad request

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error

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" : [ {
      "protocol" : "HTTP_1_1",
      "securityMethods" : [ null, null ],
      "versions" : [ {
        "apiVersion" : "apiVersion",
        "custOperations" : [ {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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"
      } ],
      "dataFormat" : "JSON",
      "domainName" : "domainName",
      "aefLocation" : {
        "dcId" : "dcId",
        "geoArea" : {
          "shape" : "POINT",
          "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" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      }, {
        "ipv6Addr" : "ipv6Addr",
        "securityMethods" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      } ]
    }, {
      "protocol" : "HTTP_1_1",
      "securityMethods" : [ null, null ],
      "versions" : [ {
        "apiVersion" : "apiVersion",
        "custOperations" : [ {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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"
      } ],
      "dataFormat" : "JSON",
      "domainName" : "domainName",
      "aefLocation" : {
        "dcId" : "dcId",
        "geoArea" : {
          "shape" : "POINT",
          "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" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      }, {
        "ipv6Addr" : "ipv6Addr",
        "securityMethods" : [ "PSK", "PSK" ],
        "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" : [ {
      "protocol" : "HTTP_1_1",
      "securityMethods" : [ null, null ],
      "versions" : [ {
        "apiVersion" : "apiVersion",
        "custOperations" : [ {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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"
      } ],
      "dataFormat" : "JSON",
      "domainName" : "domainName",
      "aefLocation" : {
        "dcId" : "dcId",
        "geoArea" : {
          "shape" : "POINT",
          "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" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      }, {
        "ipv6Addr" : "ipv6Addr",
        "securityMethods" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      } ]
    }, {
      "protocol" : "HTTP_1_1",
      "securityMethods" : [ null, null ],
      "versions" : [ {
        "apiVersion" : "apiVersion",
        "custOperations" : [ {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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"
      } ],
      "dataFormat" : "JSON",
      "domainName" : "domainName",
      "aefLocation" : {
        "dcId" : "dcId",
        "geoArea" : {
          "shape" : "POINT",
          "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" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      }, {
        "ipv6Addr" : "ipv6Addr",
        "securityMethods" : [ "PSK", "PSK" ],
        "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

Name	Description
onboardingId*	String String identifying an individual on-boarded API invoker resource Required

Body parameters

Name	Description
aPIInvokerEnrolmentDetails *	representation of the API invoker details to be updated in CAPIF core function { Information about the API Invoker that requested to onboard Required: notificationDestination,onboardingInformation apiInvokerId: string API invoker ID assigned by the CAPIF core function to the API invoker while on-boarding the API invoker. Shall not be present in the HTTP POST request from the API invoker to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses. Read Only apiInvokerInformation: string Generic information related to the API invoker such as details of the device or the application. apiList: undefined notificationDestination: undefined onboardingInformation: undefined requestTestNotification: boolean Set to true by Subscriber to request the CAPIF core function to send a test notification as defined in in clause 7.6. Set to false or omitted otherwise. supportedFeatures: undefined websockNotifConfig: undefined

Name

Description

aPIInvokerEnrolmentDetails *

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

{

Information about the API Invoker that requested to onboard

Required: notificationDestination,onboardingInformation

apiInvokerId:

string

API invoker ID assigned by the CAPIF core function to the API invoker while on-boarding the API invoker. Shall not be present in the HTTP POST request from the API invoker to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses.

Read Only

apiInvokerInformation:

string

Generic information related to the API invoker such as details of the device or the application.

apiList:

undefined

notificationDestination:

undefined

onboardingInformation:

undefined

requestTestNotification:

boolean

Set to true by Subscriber to request the CAPIF core function to send a test notification as defined in in clause 7.6. Set to false or omitted otherwise.

supportedFeatures:

undefined

websockNotifConfig:

undefined

Responses

Status: 200 - API invoker details updated successfully.

Schema

Status: 202 - The CAPIF core has accepted the API invoker update details request and is processing it.

Status: 204 - API invoker's information updated successfully, with no content to be sent in the response body.

Status: 307 - Temporary Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 308 - Permanent Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 400 - Bad request

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 411 - Length Required

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 413 - Payload Too Large

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 415 - Unsupported Media Type

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error

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" : [ {
      "protocol" : "HTTP_1_1",
      "securityMethods" : [ null, null ],
      "versions" : [ {
        "apiVersion" : "apiVersion",
        "custOperations" : [ {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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"
      } ],
      "dataFormat" : "JSON",
      "domainName" : "domainName",
      "aefLocation" : {
        "dcId" : "dcId",
        "geoArea" : {
          "shape" : "POINT",
          "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" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      }, {
        "ipv6Addr" : "ipv6Addr",
        "securityMethods" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      } ]
    }, {
      "protocol" : "HTTP_1_1",
      "securityMethods" : [ null, null ],
      "versions" : [ {
        "apiVersion" : "apiVersion",
        "custOperations" : [ {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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"
      } ],
      "dataFormat" : "JSON",
      "domainName" : "domainName",
      "aefLocation" : {
        "dcId" : "dcId",
        "geoArea" : {
          "shape" : "POINT",
          "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" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      }, {
        "ipv6Addr" : "ipv6Addr",
        "securityMethods" : [ "PSK", "PSK" ],
        "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" : [ {
      "protocol" : "HTTP_1_1",
      "securityMethods" : [ null, null ],
      "versions" : [ {
        "apiVersion" : "apiVersion",
        "custOperations" : [ {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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"
      } ],
      "dataFormat" : "JSON",
      "domainName" : "domainName",
      "aefLocation" : {
        "dcId" : "dcId",
        "geoArea" : {
          "shape" : "POINT",
          "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" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      }, {
        "ipv6Addr" : "ipv6Addr",
        "securityMethods" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      } ]
    }, {
      "protocol" : "HTTP_1_1",
      "securityMethods" : [ null, null ],
      "versions" : [ {
        "apiVersion" : "apiVersion",
        "custOperations" : [ {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "description" : "description",
          "custOpName" : "custOpName"
        }, {
          "operations" : [ "GET", "GET" ],
          "commType" : "REQUEST_RESPONSE",
          "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"
      } ],
      "dataFormat" : "JSON",
      "domainName" : "domainName",
      "aefLocation" : {
        "dcId" : "dcId",
        "geoArea" : {
          "shape" : "POINT",
          "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" : [ "PSK", "PSK" ],
        "port" : 9606,
        "ipv4Addr" : "ipv4Addr"
      }, {
        "ipv6Addr" : "ipv6Addr",
        "securityMethods" : [ "PSK", "PSK" ],
        "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

Name	Description
aPIInvokerEnrolmentDetails *	{ Information about the API Invoker that requested to onboard Required: notificationDestination,onboardingInformation apiInvokerId: string API invoker ID assigned by the CAPIF core function to the API invoker while on-boarding the API invoker. Shall not be present in the HTTP POST request from the API invoker to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses. Read Only apiInvokerInformation: string Generic information related to the API invoker such as details of the device or the application. apiList: undefined notificationDestination: undefined onboardingInformation: undefined requestTestNotification: boolean Set to true by Subscriber to request the CAPIF core function to send a test notification as defined in in clause 7.6. Set to false or omitted otherwise. supportedFeatures: undefined websockNotifConfig: undefined

Name

Description

aPIInvokerEnrolmentDetails *

{

Information about the API Invoker that requested to onboard

Required: notificationDestination,onboardingInformation

apiInvokerId:

string

Read Only

apiInvokerInformation:

string

Generic information related to the API invoker such as details of the device or the application.

apiList:

undefined

notificationDestination:

undefined

onboardingInformation:

undefined

requestTestNotification:

boolean

Set to true by Subscriber to request the CAPIF core function to send a test notification as defined in in clause 7.6. Set to false or omitted otherwise.

supportedFeatures:

undefined

websockNotifConfig:

undefined

Responses

Status: 201 - API invoker on-boarded successfully.

Schema
Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 202 - The CAPIF core has accepted the Onboarding request and is processing it.

Status: 400 - Bad request

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 411 - Length Required

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 413 - Payload Too Large

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 415 - Unsupported Media Type

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: default - Generic Error

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

Name	Description
onboardingId*	String Required

Body parameters

Name	Description
aPIInvokerEnrolmentDetailsPatch *	{ Represents an API Invoker's enrolment details to be updated. apiInvokerInformation: string Generic information related to the API invoker such as details of the device or the application. apiList: undefined notificationDestination: undefined onboardingInformation: undefined

Responses

Status: 200 - The definition of the service API is modified successfully and a representation of the updated service API is returned in the request body.

Schema

Status: 204 - No Content. The definition of the service API is modified successfully.

Status: 307 - Temporary Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 308 - Permanent Redirect

Headers

Name	Type	Format	Description
Location	String		An alternative URI of the resource.

Status: 400 - Bad request

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 401 - Unauthorized

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 403 - Forbidden

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 404 - Not Found

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 411 - Length Required

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 413 - Payload Too Large

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 415 - Unsupported Media Type

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 429 - Too Many Requests

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 500 - Internal Server Error

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

Status: 503 - Service Unavailable

Schema

{

Represents additional information and details on an error response.

cause:

string

A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available.

detail:

string

A human-readable explanation specific to this occurrence of the problem.

instance:

string

string providing an URI formatted according to IETF RFC 3986.

invalidParams:

[ (1..∞)

Description of invalid parameters, for a request rejected due to invalid parameters.

undefined

]

status:

integer

The HTTP status code for this occurrence of the problem.

supportedFeatures:

string

Pattern: ^[A-Fa-f0-9]*$

title:

string

A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem.

type:

string

string providing an URI formatted according to IETF RFC 3986.

CAPIF_API_Invoker_Management_API

API and SDK Documentation

Default

onboardedInvokersOnboardingIdDelete

Usage and SDK Samples

Scopes

Parameters

Responses

Status: 204 - The individual API Invoker matching onboardingId was offboarded.

Status: 307 - Temporary Redirect

Status: 308 - Permanent Redirect

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 429 - Too Many Requests

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

Status: default - Generic Error

onboardedInvokersOnboardingIdPut

Usage and SDK Samples

Scopes

Parameters

Responses

Status: 200 - API invoker details updated successfully.

Status: 202 - The CAPIF core has accepted the API invoker update details request and is processing it.

Status: 204 - API invoker's information updated successfully, with no content to be sent in the response body.

Status: 307 - Temporary Redirect

Status: 308 - Permanent Redirect

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 411 - Length Required

Status: 413 - Payload Too Large

Status: 415 - Unsupported Media Type

Status: 429 - Too Many Requests

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

Status: default - Generic Error

onboardedInvokersPost

Usage and SDK Samples

Scopes

Parameters

Responses

Status: 201 - API invoker on-boarded successfully.

Status: 202 - The CAPIF core has accepted the Onboarding request and is processing it.

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 411 - Length Required

Status: 413 - Payload Too Large

Status: 415 - Unsupported Media Type

Status: 429 - Too Many Requests

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

Status: default - Generic Error

IndividualAPIInvokerEnrolmentDetails

modifyIndApiInvokeEnrolment

Usage and SDK Samples

Scopes

Parameters

Responses

Status: 200 - The definition of the service API is modified successfully and a representation of the updated service API is returned in the request body.

Status: 204 - No Content. The definition of the service API is modified successfully.

Status: 307 - Temporary Redirect

Status: 308 - Permanent Redirect

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 411 - Length Required

Status: 413 - Payload Too Large

Status: 415 - Unsupported Media Type

Status: 429 - Too Many Requests

Status: 500 - Internal Server Error

Status: 503 - Service Unavailable

Status: default - Generic Error