OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
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 Version: 3.0.0
Version: '1.0.0'
Title: '5G-EIR Equipment Identity Check'
Description: '5G-EIR Equipment Identity Check Service'
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/'
- {}
- oAuth2ClientCredentials:
- n5g-eir-eic
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
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'
Type: oauth2
Flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
n5g-eir-eic: Access to the N5g-eir_EquipmentIdentityCheck API
Type: object
Required:
- status
Properties:
status:
Reference: '#/components/schemas/EquipmentStatus'
Type: string
Pattern: "([0-9]{14})"
Type: string
Pattern: "(imsi-[0-9]{5,15}|nai-.+)"
Type: string
enum:
- WHITELISTED
- BLACKLISTED
- GREYLISTED
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