A.2 N5g-eir_EquipmentIdentityCheck Service API
29.5113GPP5G SystemEquipment Identity Register ServicesRelease 18Stage 3TS
openapi: 3.0.0
info:
version: ‘1.3.0-alpha.1’
title: ‘5G-EIR Equipment Identity Check’
description: |
5G-EIR Equipment Identity Check Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.511 V18.0.0; 5G System; Equipment Identity Register Services; Stage 3
url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.511/’
servers:
– url: ‘{apiRoot}/n5g-eir-eic/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials:
– n5g-eir-eic
paths:
/equipment-status:
get:
summary: Retrieves the status of the UE
operationId: GetEquipmentStatus
tags:
– Equipment Status (Document)
parameters:
– name: pei
in: query
description: PEI of the UE
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Pei’
– name: supi
in: query
description: SUPI of the UE
required: false
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: gpsi
in: query
description: GPSI of the UE
required: false
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
– name: supported-features
in: query
description: supported features of the NF consumer
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/EirResponseData’
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
description: PEI Not Found
content:
application/problem+json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ProblemDetails’
‘406’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/406’
‘414’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/414’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
description: Unexpected error
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{nrfApiRoot}/oauth2/token’
scopes:
n5g-eir-eic: Access to the N5g-eir_EquipmentIdentityCheck API
schemas:
EirResponseData:
description: Represents equipment status data provided in an EIR response message.
type: object
required:
– status
properties:
status:
$ref: ‘#/components/schemas/EquipmentStatus’
EquipmentStatus:
description: Represents equipment status of the PEI. This data type is a string.
type: string
enum:
– WHITELISTED # PERMITTED
– BLACKLISTED # PROHIBITED
– GREYLISTED # TRACKING
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2017-10 |
CT4#80 |
C4-175323 |
Initial Draft. |
0.1.0 |
|||
|
2017-10 |
CT4#80 |
C4-175396 |
At CT4#80 approved pCRs C4-175323, C4-175324, C4-175325, C4-175326 incorporated. |
0.2.0 |
|||
|
2017-12 |
CT4#81 |
C4-176439 |
At CT4#81 approved pCRs C4-176428, C4-176429 incorporated |
0.3.0 |
|||
|
2018-03 |
CT4#83 |
C4-182436 |
At CT4#83 approved pCRs C4-182368, C4-182369, C4-182384 incorporated. |
0.4.0 |
|||
|
2018-03 |
CT#79 |
CP-180032 |
Presented for information |
1.0.0 |
|||
|
2018-05 |
CT4#85 |
C4-184627 |
At CT4#85 approved pCRs C4-184475, C4-184476, C4-184628 incorporated. |
1.1.0 |
|||
|
2018-06 |
CT#80 |
CP-181106 |
Presented for approval |
2.0.0 |
|||
|
2018-06 |
CT#80 |
Approved in CT#80. |
15.0.0 |
||||
|
2018-09 |
CT#81 |
CP-182061 |
0001 |
– |
F |
Error Handling |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182061 |
0002 |
– |
F |
Description of Structured data types |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182061 |
0003 |
– |
F |
Update of Resource Figure |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182061 |
0004 |
– |
F |
API Version Number Update |
15.1.0 |
|
2018-12 |
CT#82 |
CP-183178 |
0005 |
2 |
F |
5G-EIR OpenAPI Updates |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183019 |
0007 |
– |
F |
APIRoot Clarification |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183019 |
0008 |
– |
F |
Common Status codes |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183019 |
0009 |
1 |
F |
API Version Update |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183198 |
00010 |
1 |
F |
Correction of "externalDocs" for N5g-eir_EquipmentIdentityCheck Service |
15.2.0 |
|
2019-03 |
CT#83 |
CP-190024 |
0012 |
1 |
F |
GPSI |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190024 |
0014 |
1 |
F |
Reuse of data types in EIR OpenAPI |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190024 |
0015 |
– |
F |
API Version Update |
15.3.0 |
|
2019-06 |
CT#84 |
CP-191035 |
0017 |
2 |
F |
Storage of OpenAPI specification files |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191035 |
0018 |
– |
F |
Copyright Note in YAML file |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191035 |
0019 |
– |
F |
Wrong formatting in OpenAPI annex |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191035 |
0020 |
– |
F |
3GPP TS 29.511 API version update |
15.4.0 |
|
2019-11 |
CT#84 |
CP-193036 |
0022 |
1 |
F |
Add reference to TS 29.524 |
16.0.0 |
|
2019-12 |
CT#84 |
CP-193121 |
0024 |
– |
F |
ExternalDocs field and API version change in the OpenAPI |
16.0.0 |
|
2020-03 |
CT#87e |
CP-200039 |
0025 |
2 |
F |
Add Corresponding API descriptions in clause 5.1 |
16.1.0 |
|
2020-03 |
CT#87e |
CP-200039 |
0028 |
2 |
D |
Editorial corrections |
16.1.0 |
|
2020-03 |
CT#87e |
CP-200020 |
0029 |
1 |
B |
Optionality of ProblemDetails |
16.1.0 |
|
2020-03 |
CT#87e |
CP-200035 |
0030 |
– |
B |
SUPI pattern |
16.1.0 |
|
2020-04 |
CT#88e |
CP-201064 |
0032 |
1 |
F |
Datatype column in Resource URI variables Table |
16.2.0 |
|
2020-06 |
CT#88e |
CP-201034 |
0033 |
– |
B |
Storage of YAML files |
16.2.0 |
|
2020-06 |
CT#88e |
CP-201332 |
0034 |
1 |
F |
API Version and ExternalDoc Version Update |
16.2.0 |
|
2020-12 |
CT#90e |
CP-203035 |
0036 |
– |
F |
Storage of YAML files in 3GPP Forge |
16.3.0 |
|
2021-03 |
CT#91e |
CP-210037 |
0038 |
F |
HTTP 3xx redirection |
16.4.0 |
|
|
2021-03 |
CT#91e |
CP-210054 |
0041 |
F |
29.511 Rel-16 API version and External doc update |
16.4.0 |
|
|
2021-03 |
CT#91e |
CP-210026 |
0037 |
D |
Use of inclusive terminology |
17.0.0 |
|
|
2021-03 |
CT#91e |
CP-210034 |
0039 |
F |
OpenAPI Reference |
17.0.0 |
|
|
2021-03 |
CT#91e |
CP-210029 |
0040 |
F |
29.511 Rel-17 API version and External doc update |
17.0.0 |
|
|
2021-06 |
CT#91e |
CP-211028 |
0042 |
F |
backward compatible correction |
17.1.0 |
|
|
2021-06 |
CT#92e |
CP-211059 |
0044 |
2 |
F |
backward compatible correction |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211050 |
0045 |
– |
F |
29.511 Rel-17 API version and External doc update |
17.1.0 |
|
2021-09 |
CT#93e |
CP-212060 |
0048 |
A |
3xx description correction for SCP |
17.2.0 |
|
|
2022-06 |
CT#96 |
CP-221027 |
0051 |
F |
Correction of typos in description fields |
17.3.0 |
|
|
2022-06 |
CT#96 |
CP-221304 |
0053 |
F |
29.511 Rel17 API version and External doc update |
17.3.0 |
|
|
2022-12 |
CT#98e |
CP-223027 |
0055 |
1 |
F |
Missing Mandatory Status Codes in OpenAPI |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223033 |
0056 |
F |
29.511 Rel18 API version and External doc update |
18.0.0 |
|