A.2 Naanf_AKMA API
29.5353GPP5G SystemAKMA Anchor ServicesRelease 18Stage 3TS
openapi: 3.0.0
info:
title: 3gpp-akma
version: 1.1.0-alpha.1
description: |
API for Naanf_AKMA.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.535 V18.0.0; 5G System; AKMA Anchor Services.
url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.535/’
security:
– {}
– oAuth2ClientCredentials:
– naanf-akma
servers:
– url: ‘{apiRoot}/naanf-akma/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
paths:
/register-anchorkey:
post:
summary: Store AKMA related key material.
operationId: RegisterAKMAKey
tags:
– Register the AKMA related key material
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/AkmaKeyInfo’
responses:
‘200’:
description: The requested information was returned successfully.
content:
application/json:
schema:
$ref: ‘#/components/schemas/AkmaKeyInfo’
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/retrieve-applicationkey:
post:
summary: Request to retrieve AKMA Application Key information.
operationId: GetAKMAAPPKeyMaterial
tags:
– Retrieve the AKMA Application key material (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘TS29522_AKMA.yaml#/components/schemas/AkmaAfKeyRequest’
responses:
‘200’:
description: The requested information was returned successfully.
content:
application/json:
schema:
$ref: ‘TS29522_AKMA.yaml#/components/schemas/AkmaAfKeyData’
‘204’:
description: No Content (The requested AKMA Application material does not exist.)
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
/remove-context:
post:
summary: Request to remove the AKMA related key material.
operationId: RemoveContext
tags:
– Remove the AKMA Application key material (deletion)
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/CtxRemove’
responses:
‘204’:
description: No Content (The AKMA context for the UE has been removed successfully.)
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{nrfApiRoot}/oauth2/token’
scopes:
naanf_akma: Access to the Naanf_AKMA API
schemas:
AkmaKeyInfo:
description: Represents AKMA related key material.
type: object
properties:
suppFeat:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
aKId:
$ref: ‘TS29522_AKMA.yaml#/components/schemas/AKId’
kAkma:
type: string
required:
– supi
– aKId
– kAkma
CtxRemove:
description: >
Parameters to request to delete the AKMA context for the UE, the "supi" attribute shall be
included.
type: object
properties:
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2020-11 |
CT3#112e |
TS skeleton of AKMA Anchor Services. |
0.0.0 |
||||
|
2020-11 |
CT3#112e |
Inclusion of documents agreed in CT3#112e C3-205585, |
0.1.0 |
||||
|
2021-01 |
CT3#113e |
Inclusion of documents agreed in CT3#113e C3-210291, |
0.2.0 |
||||
|
2021-01 |
CT3#113e |
Inclusion of documents agreed in CT3#114e C3-211238. |
0.3.0 |
||||
|
2021-03 |
CT#91e |
CP-210182 |
Sent to plenary for Approval |
1.0.0 |
|||
|
2021-03 |
CT#91e |
CP-210182 |
TS approved by plenary |
17.0.0 |
|||
|
2021-06 |
CT#92e |
CP-211234 |
0001 |
1 |
F |
Adding a missing description field to data type definitions in OpenAPI specification files of the Naanf_AKMA API |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211214 |
0002 |
1 |
F |
Adding a missing description field to data type definitions in OpenAPI specification files of the Naanf_AKMA API |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211214 |
0003 |
F |
Adding Clause 5.1.4.3.1 |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211214 |
0005 |
1 |
F |
Custom operation URI |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211214 |
0006 |
F |
Terminology alignment of AKMA Application Key information |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211234 |
0007 |
1 |
F |
Redirect responses with "application/json" media type |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211234 |
0008 |
1 |
F |
Optional header clarification |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211265 |
0009 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.1.0 |
|
|
2021-09 |
CT#93e |
CP-212220 |
0011 |
1 |
F |
CR 0011 29.535 Rel-17 Correcting CR #0007 implementation |
17.2.0 |
|
2021-12 |
CT#94e |
CP-213218 |
0012 |
2 |
B |
Naanf_AKMA_ContextRemove service operation |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213218 |
0014 |
2 |
F |
Correction on Naanf_AKMA_ApplicationKey_Get service operation on sending UE ID to the AKMA AF |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213246 |
0015 |
F |
Update of OpenAPI version and TS version in externalDocs field |
17.3.0 |
|
|
2022-01 |
Update of specification filename in the zip |
17.3.1 |
|||||
|
2022-03 |
CT#95e |
CP-220180 |
0016 |
B |
Specifying the error case of KAKMA key not present in the AAnF |
17.4.0 |
|
|
2022-03 |
CT#95e |
CP-220180 |
0017 |
1 |
F |
Miscellaneous corrections |
17.4.0 |
|
2022-03 |
CT#95e |
CP-220194 |
0018 |
F |
Update of info and externalDocs fields |
17.4.0 |
|
|
2022-06 |
CT#96 |
CP-221159 |
0019 |
F |
Update of info and externalDocs fields |
17.5.0 |
|
|
2022-09 |
CT#97e |
CP-222096 |
0020 |
2 |
F |
Application errors reference update in the tables defining methods on the resources for Naanf_AKMA API |
17.6.0 |
|
2022-09 |
CT#97e |
CP-222096 |
0021 |
1 |
F |
Support for Naanf_AKMA_ApplicationKey_ AnonUser_Get service operation |
17.6.0 |
|
2022-09 |
CT#97e |
CP-222096 |
0023 |
F |
Missing redirection in AKMA Context removal procedure |
17.6.0 |
|
|
2022-09 |
CT#97e |
CP-222121 |
0024 |
F |
Update of info and externalDocs fields |
17.6.0 |
|
|
2022-12 |
CT#98e |
CP-223168 |
0026 |
1 |
F |
Correction for AKMA Application Key Request |
17.7.0 |
|
2022-12 |
CT#98e |
CP-223168 |
0027 |
1 |
F |
Cardinality for CtxRemove |
17.7.0 |
|
2022-12 |
CT#98e |
CP-223188 |
0028 |
F |
Update of info and externalDocs fields |
17.7.0 |
|
|
2022-12 |
CT#98e |
CP-223191 |
0025 |
F |
Adding the mandatory error code 502 Bad Gateway |
18.0.0 |
|
|
2022-12 |
CT#98e |
CP-223189 |
0029 |
F |
Update of info and externalDocs fields |
18.0.0 |
|