Register Provider

• Api Provider Management

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

Request

URI

POST

https://{api_host}/dms/api-provider-management/v1/registrations

COPY

Request Body

APIProviderEnrolmentDetails of type(s) application/json

Required

{
    "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.

Responses

201

Hide Details

API provider domain registered successfully

Returns APIProviderEnrolmentDetails of type(s) application/json

{
    "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.

Response Headers

string

Location

Contains the URI of the newly created resource, according to the structure {apiRoot}/api-provider-management/v1/registrations/{registrationId}

400

Hide Details

Returns BadRequest of type(s) application/problem+json

{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}

string

type

Optional

A URI representing the type of the problem.

string

title

Required

A short summary of the error.

number

status

Required

The HTTP Response code associated with this error.

string

detail

Required

A detailed description of the error.

string

instance

Optional

An optional URI of the instance involved in the problem.

401

Hide Details

Returns Unauthorized of type(s) application/problem+json

{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}

string

type

Optional

A URI representing the type of the problem.

string

title

Required

A short summary of the error.

number

status

Required

The HTTP Response code associated with this error.

string

detail

Required

A detailed description of the error.

string

instance

Optional

An optional URI of the instance involved in the problem.

403

Hide Details

Returns Forbidden of type(s) application/problem+json

{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}

string

type

Optional

A URI representing the type of the problem.

string

title

Required

A short summary of the error.

number

status

Required

The HTTP Response code associated with this error.

string

detail

Required

A detailed description of the error.

string

instance

Optional

An optional URI of the instance involved in the problem.

404

Hide Details

Returns NotFound of type(s) application/problem+json

{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}

string

type

Optional

A URI representing the type of the problem.

string

title

Required

A short summary of the error.

number

status

Required

The HTTP Response code associated with this error.

string

detail

Required

A detailed description of the error.

string

instance

Optional

An optional URI of the instance involved in the problem.

406

Hide Details

Returns Unacceptable of type(s) application/problem+json

{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}

string

type

Optional

A URI representing the type of the problem.

string

title

Required

A short summary of the error.

number

status

Required

The HTTP Response code associated with this error.

string

detail

Required

A detailed description of the error.

string

instance

Optional

An optional URI of the instance involved in the problem.

411

Hide Details

Returns LengthRequired of type(s) application/problem+json

{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}

string

type

Optional

A URI representing the type of the problem.

string

title

Required

A short summary of the error.

number

status

Required

The HTTP Response code associated with this error.

string

detail

Required

A detailed description of the error.

string

instance

Optional

An optional URI of the instance involved in the problem.

413

Hide Details

Returns PayloadTooLarge of type(s) application/problem+json

{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}

string

type

Optional

A URI representing the type of the problem.

string

title

Required

A short summary of the error.

number

status

Required

The HTTP Response code associated with this error.

string

detail

Required

A detailed description of the error.

string

instance

Optional

An optional URI of the instance involved in the problem.

415

Hide Details

Returns Unsupported of type(s) application/problem+json

{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}

string

type

Optional

A URI representing the type of the problem.

string

title

Required

A short summary of the error.

number

status

Required

The HTTP Response code associated with this error.

string

detail

Required

A detailed description of the error.

string

instance

Optional

An optional URI of the instance involved in the problem.

429

Hide Details

Returns TooManyRequests of type(s) application/problem+json

{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}

string

type

Optional

A URI representing the type of the problem.

string

title

Required

A short summary of the error.

number

status

Required

The HTTP Response code associated with this error.

string

detail

Required

A detailed description of the error.

string

instance

Optional

An optional URI of the instance involved in the problem.

500

Hide Details

Returns ServerError of type(s) application/problem+json

{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}

string

type

Optional

A URI representing the type of the problem.

string

title

Required

A short summary of the error.

number

status

Required

The HTTP Response code associated with this error.

string

detail

Required

A detailed description of the error.

string

instance

Optional

An optional URI of the instance involved in the problem.

503

Hide Details

Returns ServiceUnavailable of type(s) application/problem+json

{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}

string

type

Optional

A URI representing the type of the problem.

string

title

Required

A short summary of the error.

number

status

Required

The HTTP Response code associated with this error.

string

detail

Required

A detailed description of the error.

string

instance

Optional

An optional URI of the instance involved in the problem.

default

Hide Details

Unexpected error

Operation doesn't return any data structure

On This Page

Description

Request

Request Body

Response

201 Response Body

Errors

Api Provider Management Operations

DELETE

Delete Provider

PATCH

Patch Provider

POST

Register Provider

PUT

Update Provider