Ultra Cloud Core 5G Session Management Function, Release 2020.02 - API Reference - AEF Security [Cisco Ultra Cloud Core - Session Management Function]

OpenAPI

OpenAPI Version: 3.0.0

info

Title: AEF_Security_API

Description: This API allows an API invoker to check if the security information required by the API exposing function is available, by initiating authentication. This API also allows CAPIF core function to revoke access to service APIs.

Version: "1.0.0"

externalDocs

Description: 3GPP TS 29.222 V15.2.0 Common API Framework for 3GPP Northbound APIs

URL: http://www.3gpp.org/ftp/Specs/archive/29_series/29.222/

servers

URL: '{apiRoot}/aef-security/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 7.5 of 3GPP TS 29.222.

paths

/check-authentication

Method: Post

Summary: Check authentication.

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CheckAuthenticationReq'

Responses:

'200' The request was successful.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/CheckAuthenticationRsp'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

/revoke-authorization

Method: Post

Summary: Revoke authorization.

Request Body:

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/RevokeAuthorizationReq'

Responses:

'200' The request was successful.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/RevokeAuthorizationRsp'