uav-authentications

/uav-authentications

POST

A UAV authentication

apiRoot

string

See clause 6.1.1

n/a

UAVAuthInfo

M

1

Represents the data to be used for UAV authentication

UAVAuthResponse

M

1

200 OK

Successful request of UAV authentication and authorization. If C2 authorization request is sent during UUAA-SM, the final response indicates that at least UUAA has succeeded.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same NEF (UAS-NF) or NEF (UAS-NF) (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same NEF (UAS-NF) or NEF (UAS-NF) (service) set.

(NOTE 2)

UAVAuthFailure

O

0..1

403 Forbidden

This represents that the UAV authentication is failed, the "cause" attribute of the ProblemDetails data structure set to:

– AUTHENTICATION_FAILURE

See table 6.1.7.3-1 for the description of these errors.

ProblemDetails

O

0..1

504 Gateway Timeout

The "cause" attribute may be used to indicate the following application error:

– PEER_NOT_RESPONDING

See table 6.1.7.3-1 for the description of the error.

NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same NEF (UAS-NF) or NEF (UAS-NF) (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same NEF (UAS-NF) or UAS-NF/NEF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

notificationUri

String formatted as URI with the Callback Uri

AuthNotification

M

1

Contains the reauthentication information.

n/a

204 No Content

Successful notification of reauthentication

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same NF consumer where the notification should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same NF consumer where the notification should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

A URI pointing to the endpoint of NF service consumer to which the notification should be sent

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the notification is redirected

Location

string

M

1

A URI pointing to the endpoint of NF service consumer to which the notification should be sent

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the notification is redirected

UAVAuthInfo

6.1.6.2.2

Information within Authenticate Request

AuthNotification

6.1.6.2.3

Information within notification

UAVAuthResponse

6.1.6.2.4

Information within Authenticate Response

UAVAuthFailure

6.1.6.2.5

Information within Authenticate Response

AuthResult

6.1.6.3.3

Enumeration indicating authentication result

NotifType

6.1.6.3.4

Enumeration Notification type

AuthContainer

6.1.6.2.6

Carries the AA related data

IpAddr

3GPP TS 29.571 [15]

IP address

Pei

3GPP TS 29.571 [15]

Permanent Equipment Identifier

Uri

3GPP TS 29.571 [15]

Uri

Gpsi

3GPP TS 29.571 [15]

GPSI

ExtSnssai

3GPP TS 29.571 [15]

Ext Snssai

Dnn

3GPP TS 29.571 [15]

DNN information

UserLocation

3GPP TS 29.571 [15]

User location

RedirectResponse

3GPP TS 29.571 [15]

Contains redirection related information

NFType

3GPP TS 29.510 [14]

NF Type

RefToBinaryData

3GPP TS 29.571 [15]

authMsg data, AA message payload data

Bytes

3GPP TS 29.571 [15]

Binary data encoded as a base64 character string

gpsi

Gpsi

M

1

GPSI of the UAV

serviceLevelId

string

M

1

Service Level Device Identity of the UAV

ipAddr

IpAddr

O

0..1

This IE may be present if the NF Service Consumer is the SMF or SMF+PGW-C.

When present, this IE indicates the IP address associated with the PDU session.

authMsg

RefToBinaryData

O

0..1

Contains the service-level AA message. This attribute is deprecated; the attribute "authContainer" should be used instead.

authContainer

array(AuthContainer)

O

1..N

Contains the AA related data without the "authResult" attribute. This attribute deprecates "authMsg" attribute.

pei

Pei

O

0..1

This IE may be present if the NF Service Consumer is the SMF or SMF+PGW-C.

When present, PEI associated with the UAV.

authServerAddress

string

O

0..1

Provides the Authorization Server Address, e.g. Authorization Server FQDN.

authNotificationURI

Uri

C

0..1

This IE shall be present in the initial authentication message.

It carries the notification URI to receive authentication related notifications

dnn

Dnn

C

0..1

This IE shall be present if the NF Service Consumer is the SMF or SMF+PGW-C.

When present, this IE indicates DNN associated with the PDU session.

sNssai

ExtSnssai

C

0..1

This IE shall be present if the NF Service Consumer is the SMF.

When present, this IE indicates the S-NSSAI associated with the PDU session.

ueLocInfo

UserLocation

O

0..1

This IE shall contain the UE location information if it is available.

nfType

NFType

M

0..1

NFType of the NF service consumer.

Possible NFType values supported in this release of the specification are

– AMF

– SMF

gpsi

Gpsi

M

1

GPSI of the UAV

serviceLevelId

string

M

1

Service Level Device Identity of the UAV

authMsg

RefToBinaryData

C

0..1

Contains the service-level AA message.

This IE may be present if the notifType is set to "UPDATEAUTH". This attribute is deprecated; the attribute "authContainer" should be used instead.

authContainer

array(AuthContainer)

C

1..N

Contains the AA related data, including optionally the "authResult" attribute. This IE shall be present if the notifType is set to "UPDATEAUTH". This attribute deprecates "authMsg" attribute.

notifType

NotifType

M

1

This IE shall contain the notification type.

notifyCorrId

string

M

1

This IE shall contain the Notification Correlation Id.

gpsi

Gpsi

M

1

GPSI of the UAV

authResult

AuthResult

C

0..1

This IE shall be present for the final NEF (UAS-NF) to NF service consumer message.

Conveys the UAV authentication result. This attribute is deprecated; the attribute "authContainer" should be used instead.

authMsg

RefToBinaryData

O

0..1

Contains the service-level AA message. This attribute is deprecated; the attribute "authContainer" should be used instead.

authContainer

array(AuthContainer)

C

1..N

Contains the AA related data, including the "authResult" attribute in the final AA response. This attribute shall be present for the final AA response message. This attribute deprecates "authMsg" attribute.

serviceLevelId

string

O

0..1

This IE contains the authorized Service Level Device Identity

notifyCorrId

string

O

0..1

When present, this IE shall contain the Notification Correlation Id.

error

ProblemDetails

M

0..1

Represents the application error information. The application level error cause shall be encoded in the "cause" attribute.

uasResourceRelease

boolean

C

0..1

This IE shall be present and used to indicate if the PDU sessions associated with the "DNN(s) subject to aerial services" can be released or not, during re-authentication failure.

It shall be included if the "cause" attribute of the ProblemDetails data structure set to "AUTHENTICATION_FAILURE".

When present, it shall be set as follows:

– true: the PDU sessions associated with the "DNN(s) subject to aerial services" release is requested;

– false (default): the PDU sessions associated with the "DNN(s) subject to aerial services" release is not requested.

authMsgType

Bytes

O

0..1

This IE, when present, carries the Service-level-AA payload type specified in clause 9.11.2.15 of 3GPP TS 24.501 [16].

authMsgPayload

RefToBinaryData

O

0..1

AA message payload data.

authResult

AuthResult

C

0..1

Shall be present for the final AA response conveying the AA result.

"AUTH_SUCCESS"

The UAV authentication or C2 Authorization has succeeded.

"AUTH_FAIL"

The UAV authentication or C2 Authorization has failed.

"REAUTH"

The UAV needs to be reauthenticated.

"UPDATEAUTH"

Authorization data needs to be updated to UAV.

"REVOKE"

Revoke UAV authentication and authorization

AUTHENTICATION_FAILURE

403 Forbidden

The UAV authentication is failed

PEER_NOT_RESPONDING

504 Gateway Timeout

No response is received from the remote peer (i.e. USS) when time out.