APIProviderEnrolmentDetails

APIProviderEnrolmentDetails
APIProviderEnrolmentDetails

Represents an API provider domain's enrolment details.

JSON Example 
{
    "apiProvDomId": "string",
    "regSec": "string",
    "apiProvFuncs": [
        {
            "apiProvFuncId": "string",
            "regInfo": {
                "apiProvPubKey": "string",
                "apiProvCert": "string"
            },
            "apiProvFuncInfo": "string"
        }
    ],
    "apiProvDomInfo": "string",
    "failReason": "string"
}
string
apiProvDomId
Optional

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

string
regSec
Required

Security information necessary for the CAPIF core function to validate the registration of the API provider domain. Shall be present in HTTP POST request from API management function to CAPIF core function for API provider domain registration.

array of APIProviderFunctionDetails
apiProvFuncs
Optional

A list of individual API provider domain functions details. When included by the API management function in the HTTP request message, it lists the API provider domain functions that the API management function intends to register/update in registration or update registration procedure. When included by the CAPIF core function in the HTTP response message, it lists the API domain functions details that are registered or updated successfully.

string
apiProvDomInfo
Optional

Generic information related to the API provider domain such as details of the API provider applications.

string
failReason
Optional

Registration or update specific failure information of failed API provider domain function registrations.Shall be present in the HTTP response body if atleast one of the API provider domain function registration or update registration fails.

Parameter To
Returned By