ETSI TS 129 511 V15.6.0 (2020-04)

ETSI TS 129 511 V15.6.0 (2020-04)
TECHNICAL SPECIFICATION
5G;
5G System;
Equipment Identity Register Services;
Stage 3
(3GPP TS 29.511 version 15.6.0 Release 15)
---------------------- Page: 1 ----------------------
3GPP TS 29.511 version 15.6.0 Release 15 1 ETSI TS 129 511 V15.6.0 (2020-04)
Reference
RTS/TSGC-0429511vf60
Keywords
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search

The present document may be made available in electronic versions and/or in print. The content of any electronic and/or

print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any

existing or perceived difference in contents between such versions and/or in print, the prevailing version of an ETSI

deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.

Users of the present document should be aware that the document may be subject to revision or change of status.

Information on the current status of this and other ETSI documents is available at

If you find errors in the present document, please send your comment to one of the following services:

No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying

The content of the PDF version shall not be modified without the written authorization of ETSI.

DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.

3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and

oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and

IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The information

pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found

in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in

respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web

Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee

can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web

The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.

ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no

right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does

not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.

This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).

The present document may refer to technical specifications or reports using their 3GPP identities. These shall be

The cross reference between 3GPP and ETSI identities can be found under http://webapp.etsi.org/key/queryform.asp.

In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and

"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of

"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.

Intellectual Property Rights ........................................................................................................................ 2

Legal Notice ............................................................................................................................................... 2

Modal verbs terminology ............................................................................................................................ 2

Foreword ..................................................................................................................................................... 5

1 Scope ................................................................................................................................................ 7

2 References ........................................................................................................................................ 7

3 Definitions and abbreviations ........................................................................................................... 8

3.1 Definitions ................................................................................................................................................. 8

3.2 Abbreviations ............................................................................................................................................ 8

4 Overview .......................................................................................................................................... 8

4.1 Introduction ............................................................................................................................................... 8

5 Services offered by the 5G-EIR NF ................................................................................................. 8

5.1 Introduction ............................................................................................................................................... 8

5.2 N5g-eir_EquipmentIdentityCheck Service ................................................................................................ 9

5.2.1 Service Description ................................................................................................................................... 9

5.2.2 Service Operations ............................................................................................................................... 9

5.2.2.1 Introduction .................................................................................................................................... 9

5.2.2.2 CheckEquipmentIdentity ................................................................................................................ 9

5.2.2.2.1 General ..................................................................................................................................... 9

5.2.2.2.2 Procedure using CheckEquipmentIdentity Operation .............................................................. 9

6 API Definitions .............................................................................................................................. 10

6.1 N5g-eir_EquipmentIdentityCheck Service API ...................................................................................... 10

6.1.1 API URI ............................................................................................................................................. 10

6.1.2 Usage of HTTP .................................................................................................................................. 10

6.1.2.1 General ......................................................................................................................................... 10

6.1.2.2 HTTP standard headers ................................................................................................................ 10

6.1.2.2.1 General ................................................................................................................................... 10

6.1.2.2.2 Content type ........................................................................................................................... 10

6.1.2.3 HTTP custom headers .................................................................................................................. 11

6.1.2.3.1 General ................................................................................................................................... 11

6.1.3 Resources ........................................................................................................................................... 11

6.1.3.1 Overview ...................................................................................................................................... 11

6.1.3.2 Resource: equipmentStatus .......................................................................................................... 11

6.1.3.2.1 Description ............................................................................................................................. 11

6.1.3.2.2 Resource Definition ................................................................................................................ 11

6.1.3.2.3 Resource Standard Methods ................................................................................................... 11

6.1.3.2.3.1 GET................................................................................................................................... 11

6.1.4 Data Model ........................................................................................................................................ 12

6.1.4.1 General ......................................................................................................................................... 12

6.1.4.2 Structured data types .................................................................................................................... 13

6.1.4.2.1 Introduction ............................................................................................................................ 13

6.1.4.2.2 Type: EirResponseData .......................................................................................................... 13

6.1.4.3 Simple data types and enumerations ............................................................................................ 13

6.1.4.3.1 Introduction ............................................................................................................................ 13

6.1.4.3.2 Simple data types .................................................................................................................... 13

6.1.4.3.3 Enumeration: EquipmentStatus .............................................................................................. 13

6.1.5 Error Handling ................................................................................................................................... 13

6.1.5.1 General ......................................................................................................................................... 13

6.1.5.2 Protocol Errors ............................................................................................................................. 13

6.1.5.3 Application Errors ........................................................................................................................ 13

6.1.6 Feature Negotiation............................................................................................................................ 14

6.1.7 Security .............................................................................................................................................. 14

6.1.7.1 General ......................................................................................................................................... 14

6.1.7.2 Transport Layer Security Protection of Messages ........................................................................ 14

6.1.7.3 Authorization of 5G-EIR NF Service Access .............................................................................. 15

Annex A (normative): OpenAPI specification ........................................................................... 16

A.1 General .................................................................................................................................................... 16

A.2 N5g-eir_EquipmentIdentityCheck Service API ...................................................................................... 16

Annex B (informative): Change history ....................................................................................... 18

History ...................................................................................................................................................... 19

This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).

The contents of the present document are subject to continuing work within the TSG and may change following formal

TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an

y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections,

z the third digit is incremented when editorial only changes have been incorporated in the document.

The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in

The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided

insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced,

non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a

The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions

"might not" or "shall not" are used instead, depending upon the meaning intended.

The constructions "can" and "cannot" are not substitutes for "may" and "need not".

will indicates that something is certain or expected to happen as a result of action taken by an agency

will not indicates that something is certain or expected not to happen as a result of action taken by an

might indicates a likelihood that something will happen as a result of action taken by some agency the

might not indicates a likelihood that something will not happen as a result of action taken by some agency

is not (or any other negative verb in the indicative mood) indicates a statement of fact

The present document describes the stage 3 protocol and data model for the N5g-eir Service Based Interface between

the 5G-EIR and its consumers over which the service to check the equipment identity as described in

3GPP TS 23.501 [2] is performed. It provides the stage 3 protocol definitions and message flows, and specifies the API

The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3].

The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition

The following documents contain provisions which, through reference in this text, constitute provisions of the present

- References are either specific (identified by date of publication, edition number, version number, etc.) or

- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including

a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same

[4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".

[5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".

[6] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3".

[8] OpenAPI Initiative, "OpenAPI 3.0.0 Specification", https://github.com/OAI/OpenAPI-

[9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".

For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following

apply. A term defined in the present document takes precedence over the definition of the same term, if any, in

For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An

abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in

N5g-eir is a Service-based interface exhibited by 5G-EIR (5G-Equipment Identity Register) which is an optional