Components


securitySchemes: 
  oAuth2ClientCredentials: 
    Type: oauth2 
    Flows: 
      clientCredentials: 
        tokenUrl: '{nrfApiRoot}/oauth2/token' 
        scopes: 
          nausf-auth: Access to Nausf_UEAuthentication API 
 
schemas: 
  AuthenticationInfo: 
    Type: object 
    Properties: 
      supiOrSuci: 
        Reference: 'TS29503_Nudm_UEAU.yaml#/components/schemas/SupiOrSuci' 
      servingNetworkName: 
        Reference: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName' 
      resynchronizationInfo: 
        Reference: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ResynchronizationInfo' 
      traceData: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/TraceData' 
    Required: 
      - supiOrSuci 
      - servingNetworkName 
  UEAuthenticationCtx: 
    Type: object 
    Properties: 
      authType: 
        Reference: '#/components/schemas/AuthType' 
      5gAuthData: 
        oneOf: 
          - $ref: '#/components/schemas/Av5gAka' 
          - $ref: '#/components/schemas/EapPayload' 
      _links: 
        Type: object 
        additionalProperties: 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' 
      servingNetworkName: 
        Reference: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName' 
    Required: 
      - authType 
      - 5gAuthData 
      - _links 
  Av5gAka: 
    Type: object 
    Required: 
      - rand 
      - hxresStar 
      - autn 
    Properties: 
      rand: 
        Reference: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Rand' 
      hxresStar: 
        Reference: '#/components/schemas/HxresStar' 
      autn: 
        Reference: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Autn' 
  ConfirmationData: 
    Type: object 
    Required: 
      - resStar 
    Properties: 
      resStar: 
        Reference: '#/components/schemas/ResStar' 
  ConfirmationDataResponse: 
    Type: object 
    Properties: 
      authResult: 
        Reference: '#/components/schemas/AuthResult' 
      supi: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi' 
      kseaf: 
        Reference: '#/components/schemas/Kseaf' 
    Required: 
      - authResult 
  EapSession: 
    Type: object 
    Properties: 
      eapPayload: 
        Reference: '#/components/schemas/EapPayload' 
      kSeaf: 
        Reference: '#/components/schemas/Kseaf' 
      _links: 
        Type: object 
        additionalProperties: 
          Reference: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' 
      authResult: 
        Reference: '#/components/schemas/AuthResult' 
      supi: 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi' 
    Required: 
      - eapPayload 
  AuthResult: 
    Type: string 
    enum: 
      - AUTHENTICATION_SUCCESS 
      - AUTHENTICATION_FAILURE 
      - AUTHENTICATION_ONGOING 
  EapPayload: 
    Type: string 
    format: base64 
    Description: contains an EAP packet 
  Kseaf: 
    Type: string 
    Pattern: '[A-Fa-f0-9]{64}' 
  ResStar: 
    Type: string 
    Pattern: '[A-Fa-f0-9]{32}' 
  HxresStar: 
    Type: string 
    Pattern: "[A-Fa-f0-9]{32}" 
  AuthType: 
    anyOf: 
      - type: string 
        enum: 
          - 5G_AKA 
          - EAP_AKA_PRIME 
          - EAP_TLS 
      - type: string