A.3 Nnssaaf_AIW API
29.5263GPP5G SystemNetwork Slice-Specific and SNPN Authentication and Authorization servicesRelease 17Stage 3TS
openapi: 3.0.0
info:
title: Nnssaaf_AIW
version: 1.0.1
description: |
AAA Interworking Authentication and Authorization Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS29.526, NSSAA Service, version 17.7.0.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.526/
servers:
– url: ‘{apiRoot}/nnssaaf-aiw/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials:
– nnssaaf-aiw
paths:
/authentications:
post:
summary: Create authentication context
operationId: CreateAuthenticationContext
tags:
– Authentications (Collections)
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/AuthInfo’
required: true
responses:
‘201’:
description: AuthContext successfully created
content:
application/json:
schema:
$ref: ‘#/components/schemas/AuthContext’
headers:
Location:
description: ‘Contains the URI of the newly created resource according to the structure: {apiRoot}/nnssaaf-aiw/v1/authentications/{authCtxId}’
required: true
schema:
type: string
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘504’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/504’
/authentications/{authCtxId}:
put:
summary: Confirm the authentication result
operationId: ConfirmAuthentication
tags:
– Authentication (Document)
parameters:
– name: authCtxId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/AuthConfirmationData’
responses:
‘200’:
description: Request processed (EAP success or Failure)
content:
application/json:
schema:
$ref: ‘#/components/schemas/AuthConfirmationResponse’
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘504’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/504’
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{nrfApiRoot}/oauth2/token’
scopes:
nnssaaf-aiw: Access to the nnssaaf-aiw API
schemas:
#
# COMPLEX TYPES:
#
AuthInfo:
type: object
properties:
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
eapIdRsp:
$ref: ‘TS29526_Nnssaaf_NSSAA.yaml#/components/schemas/EapMessage’
ttlsInnerMethodContainer:
$ref: ‘TS29526_Nnssaaf_NSSAA.yaml#/components/schemas/EapMessage’
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
required:
– supi
AuthContext:
type: object
properties:
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
authCtxId:
$ref: ‘#/components/schemas/AuthCtxId’
eapMessage:
$ref: ‘TS29526_Nnssaaf_NSSAA.yaml#/components/schemas/EapMessage’
ttlsInnerMethodContainer:
$ref: ‘TS29526_Nnssaaf_NSSAA.yaml#/components/schemas/EapMessage’
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
required:
– supi
– authCtxId
AuthConfirmationData:
type: object
properties:
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
eapMessage:
$ref: ‘TS29526_Nnssaaf_NSSAA.yaml#/components/schemas/EapMessage’
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
required:
– supi
– eapMessage
AuthConfirmationResponse:
type: object
properties:
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
eapMessage:
$ref: ‘TS29526_Nnssaaf_NSSAA.yaml#/components/schemas/EapMessage’
authResult:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/AuthStatus’
pvsInfo:
type: array
items:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo’
minItems: 1
msk:
$ref: ‘TS29509_Nausf_UEAuthentication.yaml#/components/schemas/Msk’
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
required:
– supi
– eapMessage
#
# SIMPLE TYPES:
#
AuthCtxId:
type: string
description: contains the resource ID of authentication context
nullable: false
#
# ENUMS:
#
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2020-06 |
CT4#98E |
C4-203683 |
TS skeleton. |
0.1.0 |
|||
|
2020-06 |
CT4#98E |
C4-202084 C4-202085 C4-202086 C4-203709 C4-203710 |
Implementation of pCRs agreed in CT4#98E |
0.2.0 |
|||
|
2020-06 |
CT#88e |
CP-201193 |
TS presented for information and approval. |
1.0.0 |
|||
|
2020-06 |
CT#88e |
TS approved at CT#88e |
16.0.0 |
||||
|
2020-09 |
CT#89 |
CP-202104 |
0005 |
1 |
F |
Update References |
16.1.0 |
|
2020-09 |
CT#89 |
CP-202104 |
0007 |
1 |
F |
Release PDU Session if NSSAA Re-Authentication and Re-Authorization Fails |
16.1.0 |
|
2020-09 |
CT#89 |
CP-202104 |
0008 |
1 |
F |
NSSAA status management |
16.1.0 |
|
2020-12 |
CT#90 |
CP-203054 |
0009 |
2 |
F |
Amendments for stateless NF support |
16.2.0 |
|
2020-12 |
CT#90 |
CP-203040 |
0010 |
– |
F |
Remove Editor’s Notes on AAA Server Address |
16.2.0 |
|
2020-12 |
CT#90 |
CP-203048 |
0011 |
1 |
F |
Storage of YAML files in 3GPP Forge |
16.2.0 |
|
2020-12 |
CT#90 |
CP-203040 |
0012 |
1 |
F |
AMF behaviour for NSSAA procedure due to temporal NW failure |
16.2.0 |
|
2020-12 |
CT#90 |
CP-203036 |
0013 |
– |
F |
API version and External doc update |
16.2.0 |
|
2021-03 |
CT#91 |
CP-210049 |
0014 |
– |
F |
Incorrect Media Type |
16.3.0 |
|
2021-03 |
CT#91 |
CP-210054 |
0016 |
– |
F |
29.526 Rel-16 API version and External doc update |
16.3.0 |
|
2021-03 |
CT#91 |
CP-210034 |
0015 |
1 |
F |
OpenAPI Reference |
17.0.0 |
|
2021-06 |
CT#92 |
CP-211068 |
0018 |
1 |
F |
Unsuccessful cases for handling of NSSAA status in AMF |
17.1.0 |
|
2021-06 |
CT#92 |
CP-211028 |
0019 |
– |
F |
TS Clean-up |
17.1.0 |
|
2021-06 |
CT#92 |
CP-211068 |
0021 |
1 |
F |
SUPI in Notifications from NSSAAF |
17.1.0 |
|
2021-06 |
CT#92 |
CP-211059 |
0023 |
1 |
F |
Redirect Response |
17.1.0 |
|
2021-06 |
CT#92 |
CP-211050 |
0024 |
– |
F |
29.526 Rel-17 API version and External doc update |
17.1.0 |
|
2021-09 |
CT#93 |
CP-212045 |
0026 |
1 |
F |
Attack from AAA-S |
17.2.0 |
|
2021-09 |
CT#93 |
CP-212070 |
0028 |
1 |
F |
NSSAA procedure from two different AMFs |
17.2.0 |
|
2021-09 |
CT#93 |
CP-212060 |
0031 |
– |
F |
3xx description correction for SCP |
17.2.0 |
|
2021-09 |
CT#93 |
CP-212026 |
0032 |
– |
F |
Base64 Encoding of binary attributes in JSON objects |
17.2.0 |
|
2021-09 |
CT#93 |
CP-212045 |
0033 |
– |
F |
Re-authentication Request when S-NSSAI is not in use |
17.2.0 |
|
2021-09 |
CT#93 |
CP-212059 |
0034 |
– |
F |
29.526 Rel-17 API version and External doc update |
17.2.0 |
|
2021-09 |
CT#94 |
CP-213139 |
0036 |
2 |
F |
Remove AMF behaviour related to back-off timer from NSSAA procedure |
17.3.0 |
|
2021-12 |
CT#94 |
CP-213085 |
0037 |
– |
F |
Miscellaneous corrections |
17.3.0 |
|
2021-12 |
CT#94 |
CP-213139 |
0039 |
1 |
F |
Correction to Re-Authentication / Revocation Notification Procedure |
17.3.0 |
|
2021-12 |
CT#94 |
CP-213092 |
0041 |
1 |
F |
Clarification of NSAC and exposure service |
17.3.0 |
|
2021-12 |
CT#94 |
CP-213120 |
0042 |
– |
F |
307/308 redirection |
17.3.0 |
|
2022-12 |
CT#95 |
CP-220047 |
0043 |
1 |
F |
Changing the Title of the TS 29.526 |
17.4.0 |
|
2022-03 |
CT#95 |
CP-220047 |
0051 |
3 |
B |
AIW Service |
17.4.0 |
|
2022-03 |
CT#95 |
CP-220026 |
0053 |
1 |
F |
3xx Redirect Response |
17.4.0 |
|
2022-03 |
CT#95 |
CP-220075 |
0055 |
1 |
F |
Incorrect Service Name |
17.4.0 |
|
2022-03 |
CT#95 |
CP-220025 |
0057 |
– |
F |
EAP ID Response message |
17.4.0 |
|
2022-03 |
CT#95 |
CP-220066 |
0058 |
– |
F |
29.526 Rel-17 API version and External doc update |
17.4.0 |
|
2022-06 |
CT#96 |
CP-221051 |
0061 |
– |
F |
29.526 Rel-17 API version and External doc update |
17.5.0 |
|
2022-09 |
CT#97 |
CP-222056 |
0063 |
– |
F |
Multiple GPSIs |
17.6.0 |
|
2022-12 |
CT#98 |
CP-223049 |
0066 |
1 |
F |
MSK in Primary Authentication Successful Response |
17.7.0 |
|
2022-12 |
CT#98 |
CP-223066 |
0068 |
– |
F |
29.526 Rel-17 API version and External doc update |
17.7.0 |