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 Nudm_UEAuthentication service is used by the AUSF to request the UDM to select an authentication method, calculate a fresh authentication vector (AV) if required for the selected method, and provide it to the AUSF by means of the Get service operation. The Nudm_UEAuthentication service is also used by the AUSF to inform the UDM about the occurrence of a successful or unsuccessful authentication by means of the ResultConfirmation service operation
OpenAPI Version: 3.0.0
Version: '1.0.0'
Title: 'NudmUEAU'
Description: 'UDM UE Authentication Service'
Description: 3GPP TS 29.503 Unified Data Management Services, version 15.2.1
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'
- oAuth2ClientCredentials:
- nudm-ueau
- {}
URL: '{apiRoot}/nudm-ueau/v1'
Variables:
API Root:
Default: https://example.com
Description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501.
Method: Post
Summary: Generate authentication data for the UE
Operation ID: GenerateAuthData
Tags:
- Generate Auth Data
Parameters:
- name: supiOrSuci
In: path
Description: SUPI or SUCI of the user
Required/Optional: true
Schema:
Reference: '#/components/schemas/SupiOrSuci'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AuthenticationInfoRequest'
Required/Optional: true
Responses:
'200' Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AuthenticationInfoResult'
'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'
'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'
'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'
'501': Reference 'TS29571_CommonData.yaml#/components/responses/501'
'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'
default:
Description: Unexpected error
Method: Post
Summary: Create a new confirmation event
Operation ID: ConfirmAuth
Tags:
- Confirm Auth
Parameters:
- name: supi
In: path
Description: SUPI of the user
Required/Optional: true
Schema:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
Request Body:
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AuthEvent'
Required/Optional: true
Responses:
'201' Expected response to a valid request
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/AuthEvent'
Headers:
Location:
Description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-ueau/v1/{supi}/auth-events/{authEventId}'
Required/Optional: true
Schema:
Type: string
'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'
'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'
'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'
default:
Description: Unexpected error
Type: oauth2
Flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nudm-ueau: Access to the nudm-ueau API
# COMPLEX TYPES:
Type: object
Required:
- servingNetworkName
- ausfInstanceId
Properties:
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
servingNetworkName:
Reference: '#/components/schemas/ServingNetworkName'
resynchronizationInfo:
Reference: '#/components/schemas/ResynchronizationInfo'
ausfInstanceId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
Type: object
Required:
- authType
Properties:
authType:
Reference: '#/components/schemas/AuthType'
supportedFeatures:
Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
authenticationVector:
Reference: '#/components/schemas/AuthenticationVector'
supi:
Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
oneOf:
- $ref: '#/components/schemas/AvEapAkaPrime'
- $ref: '#/components/schemas/Av5GHeAka'
discriminator:
propertyName: avType
mapping:
5G_HE_AKA: '#/components/schemas/Av5GHeAka'
EAP_AKA_PRIME: '#/components/schemas/AvEapAkaPrime'
Type: object
Required:
- avType
- rand
- xres
- autn
- ckPrime
- ikPrime
Properties:
avType:
Reference: '#/components/schemas/AvType'
rand:
Reference: '#/components/schemas/Rand'
xres:
Reference: '#/components/schemas/Xres'
autn:
Reference: '#/components/schemas/Autn'
ckPrime:
Reference: '#/components/schemas/CkPrime'
ikPrime:
Reference: '#/components/schemas/IkPrime'
Type: object
Required:
- avType
- rand
- xresStar
- autn
- kausf
Properties:
avType:
Reference: '#/components/schemas/AvType'
rand:
Reference: '#/components/schemas/Rand'
xresStar:
Reference: '#/components/schemas/XresStar'
autn:
Reference: '#/components/schemas/Autn'
kausf:
Reference: '#/components/schemas/Kausf'
Type: object
Required:
- rand
- auts
Properties:
rand:
Reference: '#/components/schemas/Rand'
auts:
Reference: '#/components/schemas/Auts'
Type: object
Required:
- nfInstanceId
- success
- timeStamp
- authType
- servingNetworkName
Properties:
nfInstanceId:
Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
success:
Reference: '#/components/schemas/Success'
timeStamp:
Reference: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
authType:
Reference: '#/components/schemas/AuthType'
servingNetworkName:
Reference: '#/components/schemas/ServingNetworkName'
# SIMPLE TYPES:
Type: string
Pattern: '^[A-Fa-f0-9]{32}$'
Type: string
Pattern: '^[A-Fa-f0-9]{28}$'
Type: string
Pattern: '^[A-Fa-f0-9]{32}$'
Type: string
Pattern: '^[A-Fa-f0-9]{32}$'
Type: string
Pattern: '^[A-Fa-f0-9]{64}$'
Type: string
Pattern: '^[A-Fa-f0-9]{32}$'
Type: string
Pattern: '^[A-Fa-f0-9]{8,32}$'
Type: string
Pattern: '^[A-Fa-f0-9]{32}$'
Type: string
Pattern: '^(imsi-[0-9]{5,15}|nai-.+| suci-(0-[0-9]{3}-[0-9]{2,3}|[1-7]-.+)-[0-9]{1,4}-(0-0-.+|[a-fA-F1-9]-([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])-[a-fA-F0-9]+)|.+)$'
Type: string
Pattern: '^5G:mnc[0-9]{3}[.]mcc[0-9]{3}[.]3gppnetwork[.]org$'
Type: boolean
# ENUMS:
anyOf:
- type: string
enum:
- 5G_AKA
- EAP_AKA_PRIME
- EAP_TLS
- type: string
anyOf:
- type: string
enum:
- 5G_HE_AKA
- EAP_AKA_PRIME
- type: string