Download OpenAPI specification:
AUSF UE Authentication Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
supiOrSuci required | string (SupiOrSuci) ^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|suci-... String identifying a SUPI or a SUCI. |
servingNetworkName required | string (ServingNetworkName) ^(5G:mnc[0-9]{3}[.]mcc[0-9]{3}[.]3gppnetwork[... |
object (ResynchronizationInfo) | |
pei | string (Pei) ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a... String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345. |
object or null (TraceData) contains Trace control and configuration parameters. | |
udmGroupId | string (NfGroupId) Identifier of a group of NFs. |
routingIndicator | string^[0-9]{1,4}$ |
cellCagInfo | Array of strings (CagId) non-empty [ items^[A-Fa-f0-9]{8}$ ] |
n5gcInd | boolean Default: false |
supportedFeatures | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
nswoInd | boolean Default: false |
disasterRoamingInd | boolean Default: false |
onboardingInd | boolean Default: false |
aun3Ind | boolean Default: false |
{- "supiOrSuci": "string",
- "servingNetworkName": "string",
- "resynchronizationInfo": {
- "rand": "string",
- "auts": "string"
}, - "pei": "string",
- "traceData": {
- "traceRef": "string",
- "traceDepth": "MINIMUM",
- "neTypeList": "string",
- "eventList": "string",
- "collectionEntityIpv4Addr": "198.51.100.1",
- "collectionEntityIpv6Addr": "2001:db8:85a3::8a2e:370:7334",
- "traceReportingConsumerUri": "string",
- "interfaceList": "string",
- "jobType": "IMMEDIATE_MDT_ONLY"
}, - "udmGroupId": "string",
- "routingIndicator": "string",
- "cellCagInfo": [
- "string"
], - "n5gcInd": false,
- "supportedFeatures": "string",
- "nswoInd": false,
- "disasterRoamingInd": false,
- "onboardingInd": false,
- "aun3Ind": false
}
{- "authType": "5G_AKA",
- "5gAuthData": {
- "rand": "string",
- "hxresStar": "string",
- "autn": "string"
}, - "_links": {
- "property1": [
- {
- "href": "string"
}
], - "property2": [
- {
- "href": "string"
}
]
}, - "servingNetworkName": "string"
}
supi required | string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows
|
supportedFeatures | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
{- "supi": "string",
- "supportedFeatures": "string"
}
{- "cause": "string",
- "targetScp": "string",
- "targetSepp": "string"
}
authCtxId required | string |
resStar required | string or null (ResStar) [A-Fa-f0-9]{32} Contains the RES*. |
supportedFeatures | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
{- "resStar": "string",
- "supportedFeatures": "string"
}
{- "authResult": "AUTHENTICATION_SUCCESS",
- "supi": "string",
- "kseaf": "string",
- "pvsInfo": [
- {
- "ipv4Addresses": [
- "198.51.100.1"
], - "ipv6Addresses": [
- "2001:db8:85a3::8a2e:370:7334"
], - "fqdnList": [
- "string"
]
}
]
}
authCtxId required | string |
eapPayload required | string or null <byte> (EapPayload) contains an EAP packet |
kSeaf | string (Kseaf) [A-Fa-f0-9]{64} Contains the Kseaf. |
object A map(list of key-value pairs) where the key is set to "eap-session" | |
authResult | string (AuthResult) Enum: "AUTHENTICATION_SUCCESS" "AUTHENTICATION_FAILURE" "AUTHENTICATION_ONGOING" Indicates the result of the authentication. |
supi | string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows
|
supportedFeatures | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
Array of objects or objects or objects (ServerAddressingInfo) non-empty | |
msk | string (Msk) [A-Fa-f0-9]{128} Contains the Master Session Key. |
{- "eapPayload": "string",
- "kSeaf": "string",
- "_links": {
- "property1": [
- {
- "href": "string"
}
], - "property2": [
- {
- "href": "string"
}
]
}, - "authResult": "AUTHENTICATION_SUCCESS",
- "supi": "string",
- "supportedFeatures": "string",
- "pvsInfo": [
- {
- "ipv4Addresses": [
- "198.51.100.1"
], - "ipv6Addresses": [
- "2001:db8:85a3::8a2e:370:7334"
], - "fqdnList": [
- "string"
]
}
], - "msk": "string"
}
{- "eapPayload": "string",
- "kSeaf": "string",
- "_links": {
- "property1": [
- {
- "href": "string"
}
], - "property2": [
- {
- "href": "string"
}
]
}, - "authResult": "AUTHENTICATION_SUCCESS",
- "supi": "string",
- "supportedFeatures": "string",
- "pvsInfo": [
- {
- "ipv4Addresses": [
- "198.51.100.1"
], - "ipv6Addresses": [
- "2001:db8:85a3::8a2e:370:7334"
], - "fqdnList": [
- "string"
]
}
], - "msk": "string"
}
suci required | string (Suci) ^(suci-(0-[0-9]{3}-[0-9]{2,3}|[1-7]-.+)-[0-9]... Contains the SUCI. |
authenticatedInd required | boolean Default: false |
supportedFeatures | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
{- "suci": "string",
- "authenticatedInd": false,
- "supportedFeatures": "string"
}
{- "authResult": "AUTHENTICATION_SUCCESS",
- "supi": "string",
- "authInd": false
}
supiOrSuci | string (SupiOrSuci) ^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|suci-... String identifying a SUPI or a SUCI. |
5gPrukId | string (5GPrukId) ^rid[0-9]{1,4}\.pid[0-9a-fA-F]+\@prose-cp\.5g... A string carrying the CP-PRUK ID of the 5G ProSe Remote UE or the 5G ProSe End UE. The CP-PRUK ID is a string in NAI format as specified in clause 28.7.11 of 3GPP TS 23.003. |
relayServiceCode required | integer (RelayServiceCode) [ 0 .. 16777215 ] Relay Service Code to identify a connectivity service provided by the UE-to-Network relay or the UE-to-UE relay. |
nonce1 required | string or null <byte> (Nonce1) contains an Nonce1 |
servingNetworkName required | string (ServingNetworkName) ^(5G:mnc[0-9]{3}[.]mcc[0-9]{3}[.]3gppnetwork[... |
supportedFeatures | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
{- "supiOrSuci": "string",
- "5gPrukId": "string",
- "relayServiceCode": 16777215,
- "nonce1": "string",
- "servingNetworkName": "string",
- "supportedFeatures": "string"
}
{- "knrProSe": "string",
- "nonce2": "string",
- "supportedFeatures": "string"
}
authCtxId required | string |
eapPayload required | string or null <byte> (EapPayload) contains an EAP packet |
knrProSe | string (KnrProSe) [A-Fa-f0-9]{64} Contains the KNR_ProSe. |
object A map(list of key-value pairs) where the key is set to "prose-auth" | |
authResult | string (AuthResult) Enum: "AUTHENTICATION_SUCCESS" "AUTHENTICATION_FAILURE" "AUTHENTICATION_ONGOING" Indicates the result of the authentication. |
supportedFeatures | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
nonce2 | string or null <byte> (Nonce2) contains an Nonce2 |
5gPrukId | string (5GPrukId) ^rid[0-9]{1,4}\.pid[0-9a-fA-F]+\@prose-cp\.5g... A string carrying the CP-PRUK ID of the 5G ProSe Remote UE or the 5G ProSe End UE. The CP-PRUK ID is a string in NAI format as specified in clause 28.7.11 of 3GPP TS 23.003. |
{- "eapPayload": "string",
- "knrProSe": "string",
- "_links": {
- "property1": [
- {
- "href": "string"
}
], - "property2": [
- {
- "href": "string"
}
]
}, - "authResult": "AUTHENTICATION_SUCCESS",
- "supportedFeatures": "string",
- "nonce2": "string",
- "5gPrukId": "string"
}
{- "eapPayload": "string",
- "knrProSe": "string",
- "_links": {
- "property1": [
- {
- "href": "string"
}
], - "property2": [
- {
- "href": "string"
}
]
}, - "authResult": "AUTHENTICATION_SUCCESS",
- "supportedFeatures": "string",
- "nonce2": "string",
- "5gPrukId": "string"
}