AUSF API (1.3.0)

Download OpenAPI specification:

AUSF UE Authentication Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

/ue-authentications

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "supiOrSuci": "string",
  • "servingNetworkName": "string",
  • "resynchronizationInfo": {
    },
  • "pei": "string",
  • "traceData": {
    },
  • "udmGroupId": "string",
  • "routingIndicator": "string",
  • "cellCagInfo": [
    ],
  • "n5gcInd": false,
  • "supportedFeatures": "string",
  • "nswoInd": false,
  • "disasterRoamingInd": false,
  • "onboardingInd": false,
  • "aun3Ind": false
}

Response samples

Content type
application/3gppHal+json
{
  • "authType": "5G_AKA",
  • "5gAuthData": {
    },
  • "_links": {
    },
  • "servingNetworkName": "string"
}

/ue-authentications/deregister

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
Request Body schema: application/json
required
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

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
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.

Responses

Request samples

Content type
application/json
{
  • "supi": "string",
  • "supportedFeatures": "string"
}

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}

/ue-authentications/{authCtxId}/5g-aka-confirmation

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
authCtxId
required
string
Request Body schema: application/json
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.

Responses

Request samples

Content type
application/json
{
  • "resStar": "string",
  • "supportedFeatures": "string"
}

Response samples

Content type
application/json
{
  • "authResult": "AUTHENTICATION_SUCCESS",
  • "supi": "string",
  • "kseaf": "string",
  • "pvsInfo": [
    ]
}

EapAuthMethod

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
authCtxId
required
string
Request Body schema: application/json
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

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
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.

Responses

Request samples

Content type
application/json
{
  • "eapPayload": "string",
  • "kSeaf": "string",
  • "_links": {
    },
  • "authResult": "AUTHENTICATION_SUCCESS",
  • "supi": "string",
  • "supportedFeatures": "string",
  • "pvsInfo": [
    ],
  • "msk": "string"
}

Response samples

Content type
{
  • "eapPayload": "string",
  • "kSeaf": "string",
  • "_links": {
    },
  • "authResult": "AUTHENTICATION_SUCCESS",
  • "supi": "string",
  • "supportedFeatures": "string",
  • "pvsInfo": [
    ],
  • "msk": "string"
}

/rg-authentications

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "suci": "string",
  • "authenticatedInd": false,
  • "supportedFeatures": "string"
}

Response samples

Content type
application/json
{
  • "authResult": "AUTHENTICATION_SUCCESS",
  • "supi": "string",
  • "authInd": false
}

/prose-authentications

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "supiOrSuci": "string",
  • "5gPrukId": "string",
  • "relayServiceCode": 16777215,
  • "nonce1": "string",
  • "servingNetworkName": "string",
  • "supportedFeatures": "string"
}

Response samples

Content type
application/json
{
  • "knrProSe": "string",
  • "nonce2": "string",
  • "supportedFeatures": "string"
}

proseAuth

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
authCtxId
required
string
Request Body schema: application/json
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.

Responses

Request samples

Content type
application/json
{
  • "eapPayload": "string",
  • "knrProSe": "string",
  • "_links": {
    },
  • "authResult": "AUTHENTICATION_SUCCESS",
  • "supportedFeatures": "string",
  • "nonce2": "string",
  • "5gPrukId": "string"
}

Response samples

Content type
{
  • "eapPayload": "string",
  • "knrProSe": "string",
  • "_links": {
    },
  • "authResult": "AUTHENTICATION_SUCCESS",
  • "supportedFeatures": "string",
  • "nonce2": "string",
  • "5gPrukId": "string"
}

Authentication Result Deletion

Deletes the authentication result in the UDM

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
authCtxId
required
string

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}

Deletes the authentication result in the UDM

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
authCtxId
required
string

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}

Deletes the authentication result in the UDM

Authorizations:
NoneoAuth2ClientCredentialsoAuth2ClientCredentials
path Parameters
authCtxId
required
string

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}