ScscfRegistration
(Document)

/{imsUeId}/scscf-registration

PUT

Create or update the S-CSCF registration state of the UE

Authorize
(Custom operation)

/{impu}/authorize

authorize

(POST)

Authorize the requested operation for the UE

Scscf Restoration Information

(Document)

/{imsUeId}/scscf-registration/scscf-restoration-info

GET

Retrieve the S-CSCF restoration information.

PUT

Update the S-CSCF restoration information.

DELETE

Delete the S-CSCF restoration information.

apiRoot

See clause 6.1.1

apiVersion

See clause 6.1.1

imsUeId

Represents the IMS Subscription Identifier, either the IMS Public Identity (i.e. IMPU or Public PSI) or the Private Identity (i.e. IMPI or PSI). See 3GPP TS 23.228 [6] clause 4.3).

IMS Public Identity is used with the PUT method;

IMS Public Identity or IMS Private Identity is used with the PATCH methods.

Pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

n/a

ScscfRegistration

M

1

S-CSCF registration for indicated IMS Public Identity is updated with the received information.

ScscfRegistration

M

1

201 Created

A response body containing a representation of the created individual scscfRegistration resource for the received IMS Public Identity shall be returned.

ScscfRegistration

M

1

200 OK

A response body containing a representation of the updated individual scscfRegistration resource for the received IMS Public Identity shall be returned.

n/a

204 No Content

Upon success, an empty response body shall be returned.

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 HSS (service) set.

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 HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

ExtendedProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– IDENTITY_ALREADY_REGISTERED In this case include invalidParams with cscfServerName as param and with value of the currently assigned S-CSCF name in the AdditionalInfo

– IDENTITIES_DO_NOT_MATCH

– ERROR_IN_REGISTRATION_TYPE

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

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 HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

apiRoot

See clause 6.1.1

apiVersion

See clause 6.1.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

n/a

n/a

ScscfRestorationInfoResponse

M

1

200 OK

A response body containing information for the S-CSCF to handle the requests for a user.

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 HSS (service) set.

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 HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that there is no restoration info stored under the scscf-registration resource.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

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 HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

n/a

ScscfRestorationInfoRequest

M

1

S-CSCF restoration information for indicated IMS Public Identity is updated with the received information.

ScscfRestorationInfoResponse

M

1

201 Created

Upon success, a response body containing a representation of the created individual ScscfRestorationInfo resource for the received IMS Public Identity shall be returned.

ScscfRestorationInfoResponse

M

1

200 OK

Upon success, a response body containing a representation of the updated individual ScscfRestorationInfo resource shall be returned.

n/a

204 No Content

Upon success, an empty response body shall be returned.

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 HSS (service) set.

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 HSS (service) set.

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– OPERATION_NOT_ALLOWED

NOTE: OPERATION_NOT_ALLOWED indicates the S-CSCF is not allowed to create/update the restoration information.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

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 HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

n/a

n/a

M

1

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

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 HSS (service) set.

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 HSS (service) set.

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– OPERATION_NOT_ALLOWED

NOTE: OPERATION_NOT_ALLOWED indicates the S-CSCF is not allowed to delete the restoration information stored in the HSS.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that there is no restoration info stored under the scscf-registration resource.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

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 HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

/{impu}/authorize

POST

Authorize the requested operation for the UE

apiRoot

See clause 6.1.1

apiVersion

See clause 6.1.1

impu

Represents the IMS Public Identity (i.e. IMPU or Public PSI). See 3GPP TS 23.228 [6] clause 4.3).

AuthorizationRequest

M

1

Contains input for authorization, such as the authorization type or the visited network identifier.

AuthorizationResponse

M

1

200 OK

A response body containing result information or the registered S-CSCF shall be returned.

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 HSS (service) set.

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 HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– USER_NOT_FOUND

– IDENTITY_NOT_REGISTERED

ProblemDetails

O

0..1

403 Forbidden

The "cause" attribute may be used to indicate one of the following application errors:

– AUTHORIZATION_REJECTED

– IDENTITIES_DONT_MATCH

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

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 HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

n/a

DeregistrationData

M

1

Includes Deregistration Reason and identities to be deregistered

n/a

204 No Content

Upon success, an empty response body shall be returned.

DeregistrationData

200 OK

Upon success or partial success, DeregistrationData shall be returned including additional information about the result of the procedure.

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 notification endpoint of the subscribing NF Service Consumer.

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 notification endpoint of the subscribing NF Service Consumer.

ProblemDetails

O

0..1

404 Not Found

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

– CONTEXT_NOT_FOUND

Location

string

M

1

An alternative URI of the notification endpoint of the subscribing NF Service Consumer.

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 notification endpoint of the subscribing NF Service Consumer.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

AuthorizationRequest

6.1.6.2.2

Information for the type of authorization requested and the visited PLMN-ID

AuthorizationResponse

6.1.6.2.3

Result of the authorization requested for registration.

ScscfRestorationInfo

6.1.6.2.4

Information required for an S-CSCF to handle the requests for a user.

ScscfRestorationInfoRequest

6.1.6.2.5

Scscf restoration information request.

ScscfRestorationInfoResponse

6.1.6.2.6

Result of the scscf restoration information request.

RestorationInfo

6.1.6.2.7

Information related to a specific registration required for an S-CSCF to handle the requests for a user.

UeSubscriptionInfo

6.1.6.2.8

UE’s subscription information.

PcscfSubscriptionInfo

6.1.6.2.9

P-CSCF’s subscription information.

ScscfRegistration

6.1.6.2.10

Registration information of the S-CSCF for the registered UE.

ExtendedProblemDetails

6.1.6.2.11

AdditionalInfo

6.1.6.2.12

DeregistrationData

6.1.6.2.13

DeregistrationReason

6.1.6.2.14

EmergencyRegisteredIdentity

6.1.6.2.15

Uri

3GPP TS 29.571 [16]

Uniform Resource Identifier

SupportedFeatures

3GPP TS 29.571 [16]

see 3GPP TS 29.500 [4] clause 6.6

DateTime

3GPP TS 29.571 [16]

String with format "date-time" as defined in OpenAPI Specification [9]

ProblemDetails

3GPP TS 29.571 [16]

Response body of error response messages.

RedirectResponse

3GPP TS 29.571 [16]

Response body of redirect response messages.

ScscfSelectionAssistanceInformation

6.2.6.2.51

This information shall be used by the I-CSCF to select an S-CSCF for the UE

authorizationType

AuthorizationType

M

1

Contains the type of the authorization requested

impi

Impi

O

1

Contains an IMS Private User Identity. It shall be present when the authorization requested is for a registration or de-registration.

visitedNetworkIdentifier

string

O

1

Contains the identifier of the visited network where the P-CSCF is located. It shall be present when the authorization requested is for a registration or de-registration.

authorizationResult

AuthorizationResult

M

1

Contains the details of the granted authorization.

cscfServerName

string

C

0..1

Contains the stored S-CSCF name in SIP URI format. It shall be present if there is a S-CSCF name stored for the associated IMS subscription.

scscfSelectionAssistanceInfo

ScscfSelectionAssistanceInformation

C

0..1

Contains information needed by the I-CSCF to select an S-CSCF for the UE.
Shall be present if cscfServerName is absent.

userName

Uri

O

0..1

Registered Private Identity of the user for whom the data is required.

If the userName is NULL, it means that an S-CSCF request all registrations for all the private identities registered in the S-CSCF.

restorationInfo

array(RestorationInfo)

O

0..N

This IE shall contain the information related to a specific registration required for an S-CSCF to handle the requests for a user.

registrationTimeOut

DateTime

O

1

This IE indicates the point of time at which the UE’s registration expires.

sipAuthenticationScheme

SipAuthenticationScheme

O

1

This IE indicates the authentication scheme to be used in the authentication of SIP requests.

scscfRestorationInfoRequest

ScscfRestorationInfo

M

1

This IE shall contain the information related to a specific registration required for an S-CSCF to handle the requests for the users.

scscfRestorationInfoResponse

array(ScscfRestorationInfo)

M

1..N

This IE shall contain the response information related to a specific or all registrations required for an S-CSCF.

path

string

M

1

This IE shall contain a comma separated list of SIP proxies in the Path header.

contact

string

M

1

This IE shall contain the Contact Addresses and Parameters in the Contact header.

initialCSeqSequenceNumber

Uint32

O

1

This IE contains the sequence number of the CSeq header field contained in the initial successful REGISTER request.

callIdSipHeader

string

O

1

This IE contains the information in the Call-ID header.

uesubscriptionInfo

UeSubscriptionInfo

O

1

This IE contains the UE’s subscription information.

pcscfSubscriptionInfo

PcscfSubscriptionInfo

O

1

This IE contains the P-CSCF’s subscription information.

imsSdmSubscriptions

map(ImsSdmSubscription)

O

1..N

A map (list of key-value pairs where subscriptionId serves as key) of imsSdmSubscriptions.

callIdSipHeader

string

M

1

This IE contains the information in the Call-ID header.

fromSipHeader

string

M

1

This IE shall contain the information in the From header.

toSipHeader

string

M

1

This IE shall contain the information in the To header.

recordRoute

string

M

1

This IE shall contain a comma separated list of Record Route header(s).

contact

string

M

1

This IE shall contain the Contact Addresses and Parameters in the Contact header.

callIdSipHeader

string

M

1

This IE contains the information in the Call-ID header.

fromSipHeader

string

M

1

This IE shall contain the information in the From header.

toSipHeader

string

M

1

This IE shall contain the information in the To header.

contact

string

M

1

This IE shall contain the Contact Addresses and Parameters in the Contact header.

imsRegistrationType

ImsRegistrationType

M

1

Contains the type of the registration/deregistration requested.

impi

Impi

C

1

Contains an IMS Private Identity.

It may be absent during the originating or terminating request to an unregistered Public Identity (imsRegistrationType shall contain the value UNREGISTERED_USER)

cscfServerName

String

M

1

Contains the S-CSCF name in SIP URI format.

scscfInstanceId

NfInstanceId

M

1

The NF instance id of the S-CSCF.

deregCallbackUri

Uri

C

1

A URI provided by the S-CSCF to receive (implicitly subscribed) notifications on deregistration.

The deregistration callback URI shall have unique information within S-CSCF set to identify the IMS Public Identity to be deregistered.

If there are implicitly identities registered (i.e. the identity belongs to an IRS) in the response, the deregistration callback URI identifies the IRS to be deregistered.

If there is a wildcarded PSI unregistered received in the response, the deregistration callback URI identifies the wildcarded PSI to be deregistered.

associatedImpis

array(Impi)

O

1..N

Associated IMS private Identities in the subscription. If the IMS subscription contains only single Private Identity this attribute shall not be present.

(NOTE)

associatedRegisteredImpis

array(Impi)

O

1..N

Associated registered IMS private Identities in the subscription.

(NOTE)

irsImpus

array(Impu)

O

1…N

List of non barred IMS Public User Identities (distinct or wildcarded) which are in the Implicit Registration Set. This attribute shall be present when the received public identity belongs to an IRS.

(NOTE)

wildcardedPui

Impu

O

1

It shall be present when the Public Identity in the request fell within the range of a Wildcarded Public User Identity present in the IRS.

(NOTE)

wildcardedPsi

Impu

O

1

It shall be present if the Public Identity in the request fell within the range of a Wildcarded Public Service Identity in the HSS whose state is unregistered.

If this element is present, it shall be used by the S-CSCF to identify the identity affected by the request.

(NOTE)

looseRouteIndicator

LooseRouteIndication

O

1

Loose Routing Indicator

(NOTE)

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.2.8

multipleRegistrationIndicator

boolean

C

1

Contains the multiple registration indication. If included, when it is set to true it indicates multiple registration.

pcscfRestorationIndicator

boolean

C

0..1

true: indicates that the P-CSCF-Restoration-mechanism shall be executed by the HSS.

false or absent: P-CSCF-Restoration is not requested.

May be present if imsRegistrationType is "UNREGISTERED_USER" or "ADMINISTRATIVE_DEREGISTRATION"; otherwise shall be absent.

scscfReselectionIndicator

boolean

C

0..1

true: indicates that the S-CSCF has been selected due to, e.g. failure of the previously assigned S-CSCF.

false or absent: no S-CSCF reselection requested

NOTE: Optional attribute applicable in response messages only.

problemDetails

ProblemDetails

M

1

More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure.

additionalInfo

AdditionalInfo

O

1

Contains the currently assigned S-CSCF name in SIP URI format.

cscfServerName

String

O

1

Current S-CSCF assigned to the user (in SIP URI format). This attribute shall be included when "cause" is IDENTITY_ALREADY_REGISTERED.

deregReason

DeregistrationReason

M

1

Indicates the reason for the deregistration.

impi

Impi

M

1

Contains the IMS Private User Identity known by the SCSCF.

associatedImpis

Array(Impi)

O

0..N

Associated IMS private Identities in the subscription that are deregistered.

This attribute may be present in responses, otherwise, it shall be absent.

emergencyRegisteredIdentities

array(EmergencyRegisteredIdentity)

O

1..N

A list of pairs of private and public user identities which have not been de-registered due to emergency registration.

This attribute may be present in responses, otherwise, it shall be absent.

reasonCode

DeregistrationReasonCode

M

1

Defines the reason for the network initiated de-registration

reasonText

string

O

0..1

Contains textual information to inform the user about the reason for a de-registration

impi

Impi

M

1

IMS Private User Identity

impu

Impu

M

1

IMS Public User Identity

Impu

string

Contains an IMS Public Identity

Impi

string

Contains an IMS Private User Identity

"REGISTRATION"

The authorization requested if for a user’s IMS registration or re-registration.

"DEREGISTRATION"

The authorization requested if for a user’s IMS de-registration.

"FIRST_REGISTRATION"

The registration is an initial registration for the IMS Public User Identity

"SUBSEQUENT_REGISTRATION"

The registration is an subsequent registration for the IMS Public User Identity

"INITIAL_REGISTRATION"

The request is related to an initial registration

"RE_REGISTRATION"

The request is related to a re-registration

"TIMEOUT_DEREGISTRATION"

The registration timer of an identity has expired.

"USER_DEREGISTRATION"

The S-CSCF has received a user initiated de-registration request

"ADMINISTRATIVE_DEREGISTRATION"

The S-CSCF, due to administrative reasons or network issues, has performed the de-registration of an identity.

"AUTHENTICATION_FAILURE"

The authentication of a user has failed.

"AUTHENTICATION_TIMEOUT"

Authentication timeout has occurred.

"UNREGISTERED_USER"

The request is related to a request for a Public Identity that is not registered.

"LOOSE_ROUTE_NOT_REQUIRED"

Indicates that strict routing mechanism is required to serve the user.

"LOOSE_ROUTE_REQUIRED "

Indicates that loose routing mechanism is required to serve the user.

"PERMANENT_TERMINATION"

The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to the Public Identity and associated implicitly registered/unregistered Public Identities (if any) for the Private Identity(ies) indicated in the request (e.g. due to an IMS subscription cancellation, or modification, or a removal of IP-address secure binding information when GIBA is used).

"NEW_SERVER_ASSIGNED"

The HSS indicates to the S-CSCF that a new S-CSCF has been allocated to the IMS Subscription e.g. because the previous assigned S-CSCF was unavailable during a registration procedure. The S-CSCF shall remove all information for all of the Public Identities indicated in the request.

"SERVER_CHANGE"

The HSS indicates to the S-CSCF that the de-registration is requested to force the selection of new S-CSCF to assign to the IMS Subscription (e.g. when the S-CSCF capabilities are changed in the HSS or when the S-CSCF indicates that it has not enough memory for the updated User Profile). If the S-CSCF does not indicate in the response all the associated Private Identities, the HSS shall repeat this request for each of the remaining Private Identities in the IMS Subscription that are known to the S-CSCF. The S-CSCF should start the network initiated de-registration towards the user, i.e. all registrations within the IMS Subscription are de-registered and the user is asked to re-register to all existing registrations.

"REMOVE_S-CSCF"

The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to an unregistered Public Identity(ies) (i.e registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) for a given IMS Subscription.

USER_NOT_FOUND

404 Not Found

The received IMS UE identity is unknown.

CONTEXT_NOT_FOUND

404 Not Found

The context identified by the callback reference is not found

IDENTITIES_DO_NOT_MATCH

403 Forbidden

A message was received with a public identity and a private identity for a user, and the server determines that the public identity does not correspond to the private identity.

ERROR_IN_REGISTRATION_TYPE

403 Forbidden

The requested registrationType is not allowed or the Public Identity type received in the request is not allowed for the requested registrationType.

IDENTITY_ALREADY_REGISTERED

403 Forbidden

The identity has already a server assigned, and the registration information cannot be overwritten.

"nhss-ims-uecm"

Access to the Nhss IMS UE Context Management API

"nhss-ims-uecm:authorize:invoke"

Access to invoke the Authorize custom operation

"nhss-ims-uecm:registration:create"

Access to create S-CSCF Registration resources

"nhss-ims-uecm:restoration:read"

Access to read the S-CSCF Restoration resource

"nhss-ims-uecm:restoration:modify"

Access to create/update/delete the S-CSCF Restoration resource