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.
OpenAPI Version: 3.0.0
Version: 1.0.0
Title: Nausf_SoRProtection Service
Description: AUSF SoR Protection Service
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
- {}
- oAuth2ClientCredentials:
- nausf-sorprotection
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':
Description: SorSecurityInfo
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/SorSecurityInfo'
'503':
Description: Service Unavailable
Content:
application/problem+json:
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
securitySchemes:
oAuth2ClientCredentials:
Type: oauth2
Flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nausf-sorprotection: Access to the Nausf_SoRProtection API
schemas:
SorInfo:
Type: object
Properties:
steeringContainer:
Reference: '#/components/schemas/SteeringContainer'
ackInd:
Reference: '#/components/schemas/AckInd'
Required:
- ackInd
SorSecurityInfo:
Type: object
Properties:
sorMacIausf:
Reference: '#/components/schemas/SorMac'
counterSor:
Reference: '#/components/schemas/CounterSor'
sorXmacIue:
Reference: '#/components/schemas/SorMac'
Required:
- sorMacIausf
- counterSor
SteeringContainer:
oneOf:
- type: array
Items:
Reference: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo'
minItems: 1
- $ref: '#/components/schemas/SecuredPacket'
SteeringInfo:
Type: object
Properties:
plmnId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
accessTechList:
Type: array
Items:
Reference: '#/components/schemas/AccessTech'
minItems: 1
Required:
- plmnId
SorMac:
Type: string
Pattern: '^[A-Fa-f0-9]{32}$'
CounterSor:
Type: string
Pattern: '^[A-Fa-f0-9]{4}$'
AckInd:
Type: boolean
SecuredPacket:
Type: string
format: base64
AccessTech:
anyOf:
- type: string
enum:
- NR
- EUTRAN_IN_WBS1_MODE_AND_NBS1_MODE
- EUTRAN_IN_NBS1_MODE_ONLY
- EUTRAN_IN_WBS1_MODE_ONLY
- UTRAN
- GSM_AND_ECGSM_IoT
- GSM_WITHOUT_ECGSM_IoT
- ECGSM_IoT_ONLY
- CDMA_1xRTT
- CDMA_HRPD
- GSM_COMPACT
- type: string
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'