Update TS29369_Nadm_Sec.yaml after CT4#133 (0d58c59a) · Commits · All Groups / 5G APIs

TS29369_Nadm_Sec.yaml

+84 −42

Original line number	Diff line number	Diff line
		openapi: 3.0.0

		info:
		version: 1.0.0
		title: Nadm_Sec API
		version: '1.0.1'
		title: 'Nadm_Sec'
		description: \|
		Nadm_Sec Service.
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.

		externalDocs:
		description: 3GPP TS 29.369 Ambient IoT Data Management Services, version 19.1.0
		description: 3GPP TS 29.369 Ambient IoT Data Management Services, version 19.2.0
		url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.369/'

		servers:
		@@ -29,6 +29,15 @@ paths:
		post:
		summary: Retrieve a random value (RANDAIOT_n)
		operationId: getRand
		tags:
		- Get Rand
		security:
		- {}
		- oAuth2ClientCredentials:
		- nadm-sec
		- oAuth2ClientCredentials:
		- nadm-sec
		- nadm-sec:get-rand:invoke
		responses:
		'200':
		description: Successful retrieval of RANDAIOT_n
		@@ -36,9 +45,30 @@ paths:
		application/json:
		schema:
		$ref: '#/components/schemas/GetRandResponse'
		security:
		- oauth2ClientCredentials:
		- nadm-sec:get-rand
		'400':
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'401':
		$ref: 'TS29571_CommonData.yaml#/components/responses/401'
		'403':
		$ref: 'TS29571_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413':
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'415':
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'429':
		$ref: 'TS29571_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'502':
		$ref: 'TS29571_CommonData.yaml#/components/responses/502'
		'503':
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		description: Unexpected error
		/get-authentication:
		post:
		summary: Retrieve authentication data (XRESAIOT)
		@@ -49,6 +79,15 @@ paths:
		application/json:
		schema:
		$ref: '#/components/schemas/GetAuthenticationRequest'
		tags:
		- Get Authentication
		security:
		- {}
		- oAuth2ClientCredentials:
		- nadm-sec
		- oAuth2ClientCredentials:
		- nadm-sec
		- nadm-sec:get-authentication:invoke
		responses:
		'200':
		description: Successful retrieval of authentication data
		@@ -63,19 +102,11 @@ paths:
		'403':
		$ref: 'TS29571_CommonData.yaml#/components/responses/403'
		'404':
		description: Not Found
		content:
		application/problem+json:
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413':
		description: Payload Too Large
		content:
		application/problem+json:
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'415':
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'429':
		@@ -88,13 +119,19 @@ paths:
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		description: Unexpected error
		security:
		- oauth2ClientCredentials:
		- nadm-sec:get-authentication
		/get-session-key:
		post:
		summary: Retrieve session key (KAIOTF)
		operationId: getSessionKey
		tags:
		- Get Session Key
		security:
		- {}
		- oAuth2ClientCredentials:
		- nadm-sec
		- oAuth2ClientCredentials:
		- nadm-sec
		- nadm-sec:get-session-key:invoke
		requestBody:
		required: true
		content:
		@@ -115,11 +152,7 @@ paths:
		'403':
		$ref: 'TS29571_CommonData.yaml#/components/responses/403'
		'404':
		description: Not Found
		content:
		application/problem+json:
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413':
		@@ -136,13 +169,19 @@ paths:
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		description: Unexpected error
		security:
		- oauth2ClientCredentials:
		- nadm-sec:get-session-key
		/get-tid:
		post:
		summary: Retrieve Temporary ID (T-ID)
		operationId: getTid
		tags:
		- Get Tid
		security:
		- {}
		- oAuth2ClientCredentials:
		- nadm-sec
		- oAuth2ClientCredentials:
		- nadm-sec
		- nadm-sec:get-tid:invoke
		requestBody:
		required: true
		content:
		@@ -163,11 +202,7 @@ paths:
		'403':
		$ref: 'TS29571_CommonData.yaml#/components/responses/403'
		'404':
		description: Not Found
		content:
		application/problem+json:
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413':
		@@ -184,9 +219,6 @@ paths:
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		description: Unexpected error
		security:
		- oauth2ClientCredentials:
		- nadm-sec:get-tid
		components:
		securitySchemes:
		oauth2ClientCredentials:
		@@ -196,10 +228,10 @@ components:
		tokenUrl: https://example.com/oauth2/token
		scopes:
		nadm-sec: Access to Nadm_Sec API
		nadm-sec:get-rand: Access to retrieve a RAND
		nadm-sec:get-authentication: Access to retrieve Authentication Data
		nadm-sec:get-session-key: Access to retrieve a Session Key
		nadm-sec:get-tid: Access to retrieve a T-ID
		nadm-sec:get-rand:invoke: Access to retrieve a RAND
		nadm-sec:get-authentication:invoke: Access to retrieve Authentication Data
		nadm-sec:get-session-key:invoke: Access to retrieve a Session Key
		nadm-sec:get-tid:invoke: Access to retrieve a T-ID
		schemas:
		#
		# STRUCTURED TYPES
		@@ -207,6 +239,7 @@ components:

		GetRandResponse:
		type: object
		description: Contains the RandN.
		properties:
		randN:
		$ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Rand'
		@@ -215,6 +248,7 @@ components:

		GetAuthenticationRequest:
		type: object
		description: Contains the Rand and AIoT identifications.
		properties:
		aiotDevPermId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
		@@ -233,7 +267,8 @@ components:

		AuthData:
		type: object
		description: Contains the calculated XRES and optionally the AIoT device permanent
		description: >
		Contains the calculated XRES and optionally the AIoT device permanent
		identifier used to calculate it.
		properties:
		xres:
		@@ -272,6 +307,7 @@ components:

		GetSessionKeyRequest:
		type: object
		description: Contains a AIoT Device Permanent Identifier, RandN and RandD.
		properties:
		aiotDevPermId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
		@@ -286,6 +322,7 @@ components:

		GetSessionKeyResponse:
		type: object
		description: Contains the Kaiotf.
		properties:
		kAiotf:
		$ref: '#/components/schemas/Kaiotf'
		@@ -294,6 +331,7 @@ components:

		GetTidRequest:
		type: object
		description: Contains a AIoT Device Permanent Identifier and Resynchronization Indicator.
		properties:
		aiotDevPermId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
		@@ -304,6 +342,7 @@ components:

		GetTidResponse:
		type: object
		description: Contains T-ID Handling Info and T-ID.
		properties:
		tidHandInfo:
		$ref: 'TS29369_Nadm_DM.yaml#/components/schemas/TidHandlingInformation'
		@@ -319,10 +358,13 @@ components:
		#

		Kaiotf:
		description: Indicates the Kaiotf.
		type: string
		pattern: '^[A-Fa-f0-9]{64}$'
		pattern: '^[A-Fa-f0-9]{32}$'


		#
		# ENUMS
		#