N5g-eir Equipment Identity Check

N5g-eir is a Service-based interface exhibited by 5G-EIR (5G-Equipment Identity Register) which is an optional network function that supports the checking of the status of Equipment's identity. For example, to check that it has not been blacklisted.

Reference: 3GPP TS 29.511 V15.3.0

N5g-eir_EquipmentIdentityCheck: This service offered by the 5G-EIR allows the consumer to check the Permanent Equipment Identifier (PEI) and check whether the PEI is in the black list or not.

OpenAPI

OpenAPI Version: 3.0.0

info

Version: '1.0.0'

Title: '5G-EIR Equipment Identity Check'

Description: '5G-EIR Equipment Identity Check Service'

externalDocs

Description: 3GPP TS 29.511 V15.2.0; 5G System; Equipment Identity Register Services; Stage 3

URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.511/'

security

- {}

- oAuth2ClientCredentials:

- n5g-eir-eic

servers

URL: '{apiRoot}/n5g-eir-eic/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501

paths

/equipment-status

get:

Summary: Retrieves the status of the UE

Operation ID: GetEquipmentStatus

Tags:

- Equipment Status (Document)

Parameters:

- name: pei

In: query

Description: PEI of the UE

Required/Optional: true

Schema:

Reference: '#/components/schemas/Pei'

- name: supi

In: query

Description: SUPI of the UE

Required/Optional: false

Schema:

Reference: '#/components/schemas/Supi'

Responses:

'200' Expected response to a valid request

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/EirResponseData'

'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29571_CommonData.yaml#/components/responses/401'

'404' PEI Not Found

Content:

application/problem+json:

Schema:

Reference: '#/components/schemas/ProblemDetails'

'414': Reference 'TS29571_CommonData.yaml#/components/responses/414'

'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'

default:

Description: Unexpected error

Content:

application/problem+json:

Schema:

Reference: '#/components/schemas/ProblemDetails'

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{nrfApiRoot}/oauth2/token'

scopes:

n5g-eir-eic: Access to the N5g-eir_EquipmentIdentityCheck API

schemas

EirResponseData

Type: object

Required:

- status

Properties:

status:

Reference: '#/components/schemas/EquipmentStatus'

Pei

Type: string

Pattern: "([0-9]{14})"

Supi

Type: string

Pattern: "(imsi-[0-9]{5,15}|nai-.+)"

EquipmentStatus

Type: string

enum:

- WHITELISTED

- BLACKLISTED

- GREYLISTED

ProblemDetails

Description: 'https://www.rfc-editor.org/rfc/rfc7807.txt'

Type: object

Required:

- type

Properties:

Type:

Type: string

title:

Type: string

status:

Type: integer

detail:

Type: string

instance:

Type: string