openapi: 3.0.0 info: version: '1.0.0' title: 'Nudm_UECM' description: 'Nudm Context Management Service' externalDocs: description: 3GPP TS 29.503 Unified Data Management Services, version 15.2.1 url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' servers: - url: '{apiRoot}/nudm-uecm/v1' variables: apiRoot: default: https://example.com description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501. security: - oAuth2ClientCredentials: - nudm-uecm - {} paths: /{ueId}/registrations/amf-3gpp-access: put: summary: register as AMF for 3GPP access operationId: Registration tags: - AMF registration for 3GPP access parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' requestBody: content: application/json: schema: $ref: '#/components/schemas/Amf3GppAccessRegistration' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/Amf3GppAccessRegistration' headers: Location: description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-3gpp-access' required: true schema: type: string '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Amf3GppAccessRegistration' '204': description: No content '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '403': $ref: 'TS29571_CommonData.yaml#/components/responses/403' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error callbacks: deregistrationeNotification: '{request.body#/deregCallbackUri}': post: requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeregistrationData' responses: '204': description: Successful Notification response '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error pcscfRestorationNotification: '{request.body#/pcscfRestorationCallbackUri}': post: requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PcscfRestorationNotification' responses: '204': description: Successful Notification response '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error patch: summary: Update a parameter in the AMF registration for 3GPP access operationId: Update tags: - Parameter update in the AMF registration for 3GPP access parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' requestBody: content: application/merge-patch+json: schema: $ref: '#/components/schemas/Amf3GppAccessRegistrationModification' required: true responses: '204': description: Expected response to a valid request '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '403': $ref: 'TS29571_CommonData.yaml#/components/responses/403' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '422': description: Unprocessable Request content: application/problem+json: schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error get: summary: retrieve the AMF registration for 3GPP access information operationId: Get tags: - AMF 3Gpp-access Registration Info Retrieval parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - name: supported-features in: query schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' responses: '200': description: Expected response to a valid request content: application/json: schema: $ref: '#/components/schemas/Amf3GppAccessRegistration' '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '403': $ref: 'TS29571_CommonData.yaml#/components/responses/403' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error /{ueId}/registrations/amf-non-3gpp-access: put: summary: register as AMF for non-3GPP access operationId: Register tags: - AMF registration for non-3GPP access parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' requestBody: content: application/json: schema: $ref: '#/components/schemas/AmfNon3GppAccessRegistration' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/AmfNon3GppAccessRegistration' headers: Location: description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-non-3gpp-access' required: true schema: type: string '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AmfNon3GppAccessRegistration' '204': description: No Content '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '403': $ref: 'TS29571_CommonData.yaml#/components/responses/403' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error callbacks: deregistrationeNotification: '{request.body#/deregCallbackUri}': post: requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeregistrationData' responses: '204': description: Successful Notification response '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error pcscfRestorationNotification: '{request.body#/pcscfRestorationCallbackUri}': post: requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PcscfRestorationNotification' responses: '204': description: Successful Notification response '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error patch: summary: update a parameter in the AMF registration for non-3GPP access operationId: Update tags: - Parameter update in the AMF registration for non-3GPP access parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' requestBody: content: application/merge-patch+json: schema: $ref: '#/components/schemas/AmfNon3GppAccessRegistrationModification' required: true responses: '204': description: Expected response to a valid request '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '422': description: Unprocessable Request content: application/problem+json: schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error get: summary: retrieve the AMF registration for non-3GPP access information operationId: Get tags: - AMF non-3GPP-access Registration Info Retrieval parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - name: supported-features in: query schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' responses: '200': description: Expected response to a valid request content: application/json: schema: $ref: '#/components/schemas/AmfNon3GppAccessRegistration' '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '403': $ref: 'TS29571_CommonData.yaml#/components/responses/403' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error /{ueId}/registrations/smf-registrations/{pduSessionId}: put: summary: register as SMF operationId: Registration tags: - SMF Registration parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - name: pduSessionId in: path description: Identifier of the PDU session required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SmfRegistration' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/SmfRegistration' headers: Location: description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smf-registrations/{pduSessionId}' required: true schema: type: string '200': description: Expected response to a valid request content: application/json: schema: $ref: '#/components/schemas/SmfRegistration' '204': description: No content '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '403': $ref: 'TS29571_CommonData.yaml#/components/responses/403' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error callbacks: pcscfRestorationNotification: '{request.body#/pcscfRestorationCallbackUri}': post: requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PcscfRestorationNotification' responses: '204': description: Successful Notification response '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error delete: summary: delete an SMF registration operationId: Deregistration tags: - SMF Deregistration parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' - name: pduSessionId in: path description: Identifier of the PDU session required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' responses: '204': description: Expected response to a valid request '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '422': description: Unprocessable Request content: application/problem+json: schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error /{ueId}/registrations/smsf-3gpp-access: put: summary: register as SMSF for 3GPP access operationId: Update SMSF Reg 3GPP tags: - SMSF registration for 3GPP access parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' requestBody: content: application/json: schema: $ref: '#/components/schemas/SmsfRegistration' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/SmsfRegistration' headers: Location: description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smsf-3gpp-access' required: true schema: type: string '200': description: Expected response to a valid request content: application/json: schema: $ref: '#/components/schemas/SmsfRegistration' '204': description: No content '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '403': $ref: 'TS29571_CommonData.yaml#/components/responses/403' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error delete: summary: delete the SMSF registration for 3GPP access operationId: Deregistration tags: - SMSF Deregistration for 3GPP Access parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' responses: '204': description: Expected response to a valid request '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '422': description: Unprocessable Request content: application/problem+json: schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error get: summary: retrieve the SMSF registration for 3GPP access information operationId: Get tags: - SMSF 3GPP access Registration Info Retrieval parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - name: supported-features in: query schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' responses: '200': description: Expected response to a valid request content: application/json: schema: $ref: '#/components/schemas/SmsfRegistration' '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '403': $ref: 'TS29571_CommonData.yaml#/components/responses/403' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error /{ueId}/registrations/smsf-non-3gpp-access: put: summary: register as SMSF for non-3GPP access operationId: Registration tags: - SMSF registration for non-3GPP access parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' requestBody: content: application/json: schema: $ref: '#/components/schemas/SmsfRegistration' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/SmsfRegistration' headers: Location: description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smsf-non-3gpp-access' required: true schema: type: string '200': description: Expected response to a valid request content: application/json: schema: $ref: '#/components/schemas/SmsfRegistration' '204': description: No content '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '403': $ref: 'TS29571_CommonData.yaml#/components/responses/403' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error delete: summary: delete SMSF registration for non 3GPP access operationId: Deregistration tags: - SMSF Deregistration for non-3GPP access parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' responses: '204': description: Expected response to a valid request '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '422': description: Unprocessable Request content: application/problem+json: schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error get: summary: retrieve the SMSF registration for non-3GPP access information operationId: Get tags: - SMSF non-3GPP access Registration Info Retrieval parameters: - name: ueId in: path description: Identifier of the UE required: true schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' - name: supported-features in: query schema: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' responses: '200': description: Expected response to a valid request content: application/json: schema: $ref: '#/components/schemas/SmsfRegistration' '400': $ref: 'TS29571_CommonData.yaml#/components/responses/400' '403': $ref: 'TS29571_CommonData.yaml#/components/responses/403' '404': $ref: 'TS29571_CommonData.yaml#/components/responses/404' '500': $ref: 'TS29571_CommonData.yaml#/components/responses/500' '503': $ref: 'TS29571_CommonData.yaml#/components/responses/503' default: description: Unexpected error components: securitySchemes: oAuth2ClientCredentials: type: oauth2 flows: clientCredentials: tokenUrl: '{nrfApiRoot}/oauth2/token' scopes: nudm-uecm: Access to the nudm-uecm API schemas: # COMPLEX TYPES: Amf3GppAccessRegistration: type: object required: - amfInstanceId - deregCallbackUri - guami - ratType properties: amfInstanceId: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' supportedFeatures: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' purgeFlag: $ref: '#/components/schemas/PurgeFlag' pei: $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' imsVoPs: $ref: '#/components/schemas/ImsVoPs' deregCallbackUri: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' amfServiceNameDereg: $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' pcscfRestorationCallbackUri: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' amfServiceNamePcscfRest: $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' initialRegistrationInd: type: boolean guami: $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' backupAmfInfo: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' minItems: 1 drFlag: $ref: '#/components/schemas/DualRegistrationFlag' ratType: $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' Amf3GppAccessRegistrationModification: type: object required: - guami properties: guami: $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' purgeFlag: $ref: '#/components/schemas/PurgeFlag' pei: $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' imsVoPs: $ref: '#/components/schemas/ImsVoPs' backupAmfInfo: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' AmfNon3GppAccessRegistration: type: object required: - amfInstanceId - imsVoPs - deregCallbackUri - guami - ratType properties: amfInstanceId: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' supportedFeatures: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' purgeFlag: $ref: '#/components/schemas/PurgeFlag' pei: $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' imsVoPs: $ref: '#/components/schemas/ImsVoPs' deregCallbackUri: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' amfServiceNameDereg: $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' pcscfRestorationCallbackUri: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' amfServiceNamePcscfRest: $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' guami: $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' backupAmfInfo: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' minItems: 1 ratType: $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' AmfNon3GppAccessRegistrationModification: type: object required: - guami properties: guami: $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' purgeFlag: $ref: '#/components/schemas/PurgeFlag' pei: $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' imsVoPs: $ref: '#/components/schemas/ImsVoPs' backupAmfInfo: type: array items: $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' SmfRegistration: type: object required: - smfInstanceId - pduSessionId - singleNssai - dnn - plmnId properties: smfInstanceId: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' supportedFeatures: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' pduSessionId: $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' singleNssai: $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' dnn: $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' pcscfRestorationCallbackUri: $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' plmnId: $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' pgwFqdn: type: string SmsfRegistration: type: object required: - smsfInstanceId - plmnId properties: smsfInstanceId: $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' supportedFeatures: $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' plmnId: $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' smsfMAPAddress: $ref: '#/components/schemas/E164Number' smsfDiameterAddress: $ref: '#/components/schemas/NetworkNodeDiameterAddress' DeregistrationData: type: object required: - deregReason - accessType properties: deregReason: $ref: '#/components/schemas/DeregistrationReason' accessType: $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' PcscfRestorationNotification: type: object required: - supi properties: supi: $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' NetworkNodeDiameterAddress: type: object required: - name - realm properties: name: $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' realm: $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' # SIMPLE TYPES: PurgeFlag: type: boolean E164Number: type: string pattern: '^[0-9]{1,15}$' DualRegistrationFlag: type: boolean # ENUMS: ImsVoPs: anyOf: - type: string enum: - HOMOGENEOUS_SUPPORT - HOMOGENEOUS_NON_SUPPORT - NON_HOMOGENEOUS_OR_UNKNOWN - type: string DeregistrationReason: anyOf: - type: string enum: - UE_INITIAL_REGISTRATION - UE_REGISTRATION_AREA_CHANGE - SUBSCRIPTION_WITHDRAWN - 5GS_TO_EPS_MOBILITY - 5GS_TO_EPS_MOBILITY_UE_INITIAL_REGISTRATION - REREGISTRATION_REQUIRED - type: string