Equipment Identity Register

EIR allows the AMF to interact with EIR to validate the UE identity during the UE registration procedure.

OpenAPI

OpenAPI Version: 3.0.0

Info


Version: '1.1.1'
 
Title: '5G-EIR Equipment Identity Check'
 
 
Description: |
 
  5G-EIR Equipment Identity Check Service.
 
  © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
 
  All rights reserved.

Servers


  URL: '{apiRoot}/n5g-eir-eic/v1'
 
  Variables:
 
    API Root:
 
      Default: https://example.com
 
      Description: apiRoot as defined in clause clause 4.4 of 3GPP TS 29.501

Security


- {}
 
- oAuth2ClientCredentials:
 
    - n5g-eir-eic

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: 'TS29571_CommonData.yaml#/components/schemas/Pei'
 
      - Name: supi
 
        In: query
 
        Description: SUPI of the UE
 
        Required/Optional: false
 
        Schema:
 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
 
      - Name: gpsi
 
        In: query
 
        Description: GPSI of the UE
 
        Required/Optional: false
 
        Schema:
 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
 
      - Name: supported-features
 
        In: query
 
        Description: supported features of the NF consumer
 
        Schema:
 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
 
    Responses:
 
      '200':
 
        Description: Expected response to a valid request
 
        Content:
 
          Application/JSON:
 
            Schema:
 
              Reference: '#/components/schemas/EirResponseData'
 
      '307':
 
        Description: temporary redirect
 
        Headers:
 
          Location:
 
            Description: 'An alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set '
 
            Required/Optional: true
 
            Schema:
 
              Type: string
 
          3gpp-Sbi-Target-Nf-Id:
 
            Description: 'Identifier of target 5G-EIR (service) instance towards which the request is redirected'
 
            Schema:
 
              Type: string
 
      '308':
 
        Description: permanent redirect
 
        Headers:
 
          Location:
 
            Description: 'An alternative URI of the resource located on an alternative service instance within the same 5G-EIR or 5G-EIR (service) set '
 
            Required/Optional: true
 
            Schema:
 
              Type: string
 
          3gpp-Sbi-Target-Nf-Id:
 
            Description: 'Identifier of target 5G-EIR (service) instance towards which the request is redirected'
 
            Schema:
 
              Type: string
 
      '400':
 
        Reference: 'TS29571_CommonData.yaml#/components/responses/400'
 
      '401':
 
        Reference: 'TS29571_CommonData.yaml#/components/responses/401'
 
      '404':
 
        Description: PEI Not Found
 
        Content:
 
          application/problem+json:
 
            Schema:
 
              Reference: 'TS29571_CommonData.yaml#/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

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'
 
  EquipmentStatus:
 
    Type: string
 
    enum:
 
      - WHITELISTED
 
      - BLACKLISTED
 
      - GREYLISTED

External Docs


Description: 3GPP TS 29.511 V16.4.0; 5G System; Equipment Identity Register Services; Stage 3
 
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.511/'