OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The Authentication Server Function (AUSF) acts as NF Service Producer. It provides SoRProtection service to the NF Service Consumer. This service permits to provide the NF Service Consumer (for example, UDM) with the SoR-MAC-IAUSFand CounterSoR to protect the the Steering Information List from being tampered with or removed by the VPLMN.
Note |
If the Steering Information List is not available or HPLMN determines that no steering of the UE is required, a SOR transparent container information element with an HPLMN indication that no change of the "Operator Controlled PLMN Selector with Access Technology" list stored in the UE protected by SoR-MAC-IAUSF and CounterSoR is still sent to the UE during registration. The Steering Information List in such a case, the NF Service Consumer shall send an empty list to the AUSF when consuming the Nausf_SoRProtection Service. |
The service operation defined for the Nausf_SoRProtection is as follows:
Protect: The Protect service operation is used in the following procedures:
Procedure for steering of UE in VPLMN during registration (see subclause 6.14.2.1 of 3GPP TS 33.501 [8])
Procedure for steering of UE in VPLMN after registration (see subclause 6.14.2.2 of 3GPP TS 33.501 [8])
Reference: 3GPP TS 33.501 v15.5.0
OpenAPI Version: 3.0.0
Version: 1.0.0
Title: Nausf_SoRProtection Service
Description: AUSF SoR Protection Service
Description: 3GPP TS 29.509 V15.2.0; 5G System; Authentication Server Services
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.509'
- {}
- oAuth2ClientCredentials:
- nausf-sorprotection
URL: '{apiRoot}/nausf-sorprotection/v1'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501
Method: Post
Parameters:
- name: supi
In: path
Description: Identifier of the UE
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SorInfo'
Required/Optional: true
Responses:
'201' SorSecurityInfo
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SorSecurityInfo'
'503' Service Unavailable
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
Type: oauth2
Flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nausf-sorprotection: Access to the Nausf_SoRProtection API
Type: object
Properties:
steeringContainer:
Reference: '#/components/schemas/SteeringContainer'
ackInd:
Reference: '#/components/schemas/AckInd'
Required:
- ackInd
Type: object
Properties:
sorMacIausf:
Reference: '#/components/schemas/SorMac'
counterSor:
Reference: '#/components/schemas/CounterSor'
sorXmacIue:
Reference: '#/components/schemas/SorMac'
Required:
- sorMacIausf
- counterSor
oneOf:
- type: array
Items:
Reference: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo'
minItems: 1
- $ref: '#/components/schemas/SecuredPacket'
Type: object
Properties:
plmnId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
accessTechList:
Type: array
Items:
Reference: '#/components/schemas/AccessTech'
minItems: 1
Required:
- plmnId
Type: string
Pattern: '^[A-Fa-f0-9]{32}$'
Type: string
Pattern: '^[A-Fa-f0-9]{4}$'
Type: boolean
Type: string
format: base64
anyOf:
- type: string