From 6d5b3c2813cbc2b76dd76582b8f9150a8df5b4e6 Mon Sep 17 00:00:00 2001 From: sra Date: Tue, 16 Sep 2025 08:18:35 +0530 Subject: [PATCH 1/2] DOCS-8473 updated the script with yaml spec file link --- .../5G Management Service.yaml | 1651 +++++++++++++++++ 1 file changed, 1651 insertions(+) create mode 100644 openapi-specs/sase/manage-services-5g/5G Management Service.yaml diff --git a/openapi-specs/sase/manage-services-5g/5G Management Service.yaml b/openapi-specs/sase/manage-services-5g/5G Management Service.yaml new file mode 100644 index 000000000..793a0a416 --- /dev/null +++ b/openapi-specs/sase/manage-services-5g/5G Management Service.yaml @@ -0,0 +1,1651 @@ +components: + schemas: + CieTokenRequest: + properties: + access_token: + type: string + cie_directory: + type: string + created_at: + type: string + created_by: + type: string + tsg_id: + type: string + type: object + JsonObject: + items: + type: string + type: array + RadiusProxyRequest: + properties: + ipaddress: + type: string + name: + type: string + type: object + RadiusServerSecretRequest: + properties: + created_by: + type: string + secret: + type: string + type: object + RegisterUE: + description: A list of one or more UEs + items: + properties: + apn: + description: APN (Access Point Name) for the Tenant UE + example: apn@panw.com + type: string + cellId: + type: string + eventTime: + description: epoc time in ms + type: integer + expiryTime: + description: epoc time in ms + type: integer + imei: + description: 15 digit IMEI (International Mobile Equipment Identity) number. + Error is returned if number of digits is not exactly 15.Last digit will + be replaced by zero. + example: '123456789012345' + type: string + imsi: + description: 15 digit IMSI (International Mobile Subscriber Identity) + number. Error is returned if number of digits is not exactly 15. + example: '123456789012345' + type: string + ipType: + description: it tells whether it is ipv4, ipv6 or dual stack. Valid values + are IPv4, IPv6, IPv4v6 + example: IPV4 + type: string + ipv4Addr: + type: string + ipv6Addr: + type: string + msisdn: + type: string + ratType: + type: string + sliceId: + type: string + supi: + type: string + required: + - eventTime + - ipType + - imsi + - imei + - apn + type: object + type: array + SetInterface: + properties: + interfaceType: + example: RADIUS + type: string + interimMsgInterval: + description: How often interim messages will come(in minutes) + type: integer + processInterimMsg: + default: false + type: boolean + required: + - interfaceType + type: object + TenantGroupInfo: + properties: + group_name: + type: string + identity_id: + items: + type: string + type: array + tsg_id: + type: string + type: object + TenantGroupInfoListInput: + properties: + group_id: + type: string + tsg_id: + type: string + type: object + TenantUEInfoListInput: + properties: + tsg_id: + type: string + type: object + TenantUEInfoRequest: + properties: + apn: + type: string + imei: + type: string + imsi: + type: string + root_tsg_id: + type: string + tsg_id: + type: string + type: object + TenantUeInfoBulkDeleteRequest: + properties: + identityIds: + items: + type: string + type: array + type: object + UpdateInterimMsg: + properties: + interval: + description: How often interim messages will come(in minutes) + type: integer + processMsg: + default: false + type: boolean + type: object + securitySchemes: + Bearer: + scheme: bearer + type: http +info: + contact: + email: support@paloaltonetworks.com + description: "The evolution of 5G technology is transforming enterprise connectivity,\ + \ offering unprecedented speed and capacity. \nAs businesses embrace 5G networks,\ + \ the demand for robust security measures grows exponentially. \nService Providers\ + \ are at the forefront of this shift, tasked with safeguarding vast amounts of\ + \ sensitive data across diverse 5G-connected devices.\nTraditional security approaches\ + \ fall short in the 5G landscape. Embedded solutions often hit scalability roadblocks\ + \ and increase management complexity. \nOver-the-Top (OTT) solutions, while flexible,\ + \ prove impractical for many IoT devices and sensors. Neither fully addresses\ + \ the unique challenges of 5G, \nsuch as seamless roaming and integrated network-based\ + \ security.\n\nThis gap in the market calls for an innovative security paradigm\ + \ - one that combines scalability, ease of management, \nand comprehensive protection\ + \ across all 5G scenarios. \nThe Enterprise 5G Security Solution emerges as the\ + \ answer to these pressing needs, \noffering a new approach to securing the future\ + \ of enterprise connectivity.\n\nThese APIs use the common SASE authentication\ + \ mechanism and base URL. See the\n[Prisma SASE API Get Started](https://pan.dev/sase/docs/getstarted)\ + \ guide for more information.\n\nThis Open API spec file was created on September\ + \ 16, 2025. To check for a more recent version of this file, see\n[SASE 5G Manage\ + \ Services APIs on pan.dev](https://pan.dev/sase/api/manage-services-5g/introduction).\n\ + \n\xA9 2025 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark\ + \ of Palo\nAlto Networks. A list of our trademarks can be found at\n\n[https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html)\n\ + \nAll other marks mentioned herein may be trademarks of their respective companies.\n" + title: SASE 5G Manage Service APIs + version: '1.0' +openapi: 3.0.2 +paths: + /mt/manage/5g/cie/token: + post: + description: 'Save the Customer Identity and Engagement (CIE) token for the + leaf tenant. This token is used for authentication and authorization purposes. + + ' + operationId: post-mt-manage-5g-cie-token + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CieTokenRequest' + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Save CIE token + tags: + - CIE Token Resource + /mt/manage/5g/cie/token/details: + post: + description: 'Retrieve the details of the Customer Identity and Engagement (CIE) + token for the leaf tenant. This includes information about the token''s validity + and usage. + + ' + operationId: post-mt-manage-5g-cie-token-details + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/JsonObject' + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Get CIE token details + tags: + - CIE Token Resource + /mt/manage/5g/connection: + get: + description: 'Retrieve connection details by regions. This includes information + about the current status and configuration of connections in different regions. + + ' + operationId: get-mt-manage-5g-connection + responses: + '200': + content: + application/json: + examples: + Get Connection Details by region: + value: + data: + - bandwidth: 500000000 + computeRegion: us-west2 + connectionCount: 2 + connectionStatusEntry: + down: 1 + up: 1 + - bandwidth: 100000000 + computeRegion: us-central1 + connectionCount: 1 + connectionStatusEntry: + down: 0 + up: 1 + - bandwidth: 400000000 + computeRegion: us-east2 + connectionCount: 1 + connectionStatusEntry: + down: 0 + up: 1 + - bandwidth: 300000000 + computeRegion: us-west1 + connectionCount: 1 + connectionStatusEntry: + down: 1 + up: 0 + header: + createdAt: '2024-08-28T16:05:27Z' + dataCount: 4 + status: + subCode: 200 + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Get connection details + tags: + - Connection + /mt/manage/5g/control/cert/download: + get: + description: 'Download the certificate file required to enable 5G connectivity + for a specified region. This certificate is used for secure communication. + + ' + operationId: get-mt-manage-5g-control-cert-download + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Download certificate + tags: + - ControlPlane Resource + /mt/manage/5g/control/interface: + get: + description: 'Retrieve details of the interface currently selected by the user. + + ' + operationId: get-mt-manage-5g-control-interface + responses: + '200': + description: Successful response + '500': + description: Server Error + security: + - Bearer: [] + summary: Get Interface + tags: + - ControlPlane Resource + post: + description: 'Set the interface type. You can optionally include interim message + configuration in the request. + + ' + operationId: post-mt-manage-5g-control-interface + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetInterface' + responses: + '200': + description: Successful response + '400': + description: Bad Request + '500': + description: Server Error + security: + - Bearer: [] + summary: Add Interface + tags: + - ControlPlane Resource + /mt/manage/5g/control/interimMsg: + put: + description: This api allows you to update the interim message config + operationId: put-mt-manage-5g-control-interimmsg + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateInterimMsg' + responses: + '200': + description: Successful response + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Update the Interim Message Configuration + tags: + - ControlPlane Resource + /mt/manage/5g/control/proxycert: + get: + description: 'Check if the client certificate is uploaded for the root tenant + security group (root tsg). This certificate is necessary for secure proxy + communication. + + ' + operationId: get-mt-manage-5g-control-proxycert + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Get Client Certificate + tags: + - ControlPlane Resource + /mt/manage/5g/control/proxycert/upload: + post: + description: 'Upload the client certificate to enable 5G connectivity for a + specified region. This certificate is necessary for secure proxy communication. + + ' + operationId: post-mt-manage-5g-control-proxycert-upload + requestBody: + content: + multipart/form-data: + encoding: + file: + contentType: application/octet-stream + schema: + properties: + file: + format: binary + type: string + filename: + type: string + rootTsgId: + type: string + tsgId: + type: string + type: object + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Upload Client certificate + tags: + - ControlPlane Resource + /mt/manage/5g/control/radiusProxy: + get: + description: 'Retrieve the shared secret for the RADIUS server associated with + the root tenant security group (root tsg). This secret is used for secure + RADIUS communication. + + ' + operationId: get-mt-manage-5g-control-radiusproxy + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Get RADIUS server secret + tags: + - ControlPlane Resource + post: + description: Add radius server shared secrete forroot tsg + operationId: post-mt-manage-5g-control-radiusproxy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RadiusProxyRequest' + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Add radius server shared secrete for root tsg + tags: + - ControlPlane Resource + /mt/manage/5g/control/radiusSecret: + get: + description: 'Retrieve the shared secret for the RADIUS server associated with + the root tenant security group (root tsg). This secret is used for secure + RADIUS communication. + + ' + operationId: get-mt-manage-5g-control-radiussecret + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Get RADIUS server secret + tags: + - ControlPlane Resource + post: + description: Add radius server shared secrete forroot tsg + operationId: post-mt-manage-5g-control-radiussecret + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RadiusServerSecretRequest' + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Add radius server shared secrete for root tsg + tags: + - ControlPlane Resource + /mt/manage/5g/control/radiusServers: + get: + description: 'Retrieve details of the RADIUS servers. This includes information + about the configuration and status of the RADIUS servers. + + ' + operationId: get-mt-manage-5g-control-radiusservers + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Get RADIUS server details + tags: + - ControlPlane Resource + /mt/manage/5g/control/supported/interfaces: + get: + description: 'Retrieve all supported interface types available in the system. + + ' + operationId: get-mt-manage-5g-control-supported-interfaces + responses: + '200': + description: Successful response + '500': + description: Server Error + security: + - Bearer: [] + summary: List Supported Interfaces + tags: + - ControlPlane Resource + /mt/manage/5g/deregister/ue: + post: + description: 'Remove a previously registered User Equipment (UE) from the system. + + ' + operationId: post-mt-manage-5g-deregister-ue + requestBody: + content: + application/json: + examples: + Degister Success: + value: + - apn: demo.com + eventTime: 123456789009 + imei: '333333333333333' + imsi: '333333333333333' + ipType: IPv4 + ipv4Addr: 172.29.0.8 + schema: + $ref: '#/components/schemas/RegisterUE' + responses: + '202': + content: + application/json: + examples: + Successful: + summary: Request Accepted + schema: + type: object + description: Accepted + '401': + content: + application/json: + example: + clientRequestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab + details: Interface set is not API + errorCode: '60076' + message: Either 5g is not enabled or interface is not API + requestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab + service: 5G Management Service + schema: + type: object + description: Unauthorized + security: + - Bearer: [] + summary: DeRegister UE + tags: + - UE Enrichment + /mt/manage/5g/register/ue: + post: + description: 'Register a User Equipment (UE) with the system by submitting IMSI, + IMEI, APN, IP address, and event details. + + ' + operationId: post-mt-manage-5g-register-ue + requestBody: + content: + application/json: + examples: + IP out of Range: + value: + - apn: demo.com + eventTime: 123456789009 + imei: '333333333333333' + imsi: '333333333333333' + ipType: IPv4 + ipv4Addr: 192.29.0.8 + Incorrect Payload: + value: + - apn: demo.com + eventTime: 123456789009 + imei: '333333333333333' + imsi: '3333333333333' + ipType: IPv4 + ipv4Addr: 172.29.0.8 + Missing mandory param: + value: + - apn: demo.com + imei: '333333333333333' + imsi: '333333333333333' + ipType: IPv4 + ipv4Addr: 172.29.0.8 + Partially correct payload: + value: + - apn: demo.com + eventTime: 123456789009 + expiryTime: 1234568988 + imei: '444444444444444' + imsi: '444444444444444' + ipType: IPv4 + ipv4Addr: 172.29.0.10 + - apn: demo.com + expiryTime: 1234568988 + imei: '333333333333444' + imsi: '333333333333444' + ipType: IPv4 + ipv4Addr: 172.29.0.9 + msisdn: test + Register UE With mandatory params: + value: + - apn: demo.com + eventTime: 123456789009 + imei: '333333333333333' + imsi: '333333333333333' + ipType: IPv4 + ipv4Addr: 172.29.0.8 + Update expiry Time: + value: + - apn: demo.com + eventTime: 123456789009 + expiryTime: 8765432190 + imei: '333333333333333' + imsi: '333333333333333' + ipType: IPv4 + ipv4Addr: 172.29.0.8 + schema: + $ref: '#/components/schemas/RegisterUE' + responses: + '202': + content: + application/json: + examples: + Successful: + summary: Request Accepted + schema: + type: object + description: Accepted + '207': + content: + application/json: + example: + apn: demo.com + errorMsg: Event time is must + expiryTime: 1234568988 + imei: '333333333333440' + imsi: '333333333333444' + ipType: 0 + ipv4Addr: 172.29.0.9 + msisdn: test + schema: + type: object + description: Partial Success + '400': + content: + application/json: + examples: + example-0: + summary: Incorrect Payload + value: + apn: demo.com + errorMsg: IMSI needs to be 15 digits, current length is 13 + eventTime: 123456789009 + imei: '333333333333333' + imsi: '3333333333333' + ipType: 0 + ipv4Addr: 172.29.0.8 + example-1: + summary: IP Out of Range + value: + apn: demo.com + errorMsg: IP is not a part of any ue cidr block + eventTime: 123456789009 + imei: '333333333333330' + imsi: '333333333333333' + ipType: 0 + ipv4Addr: 192.29.0.8 + example-2: + summary: Missing mandatory param + value: + apn: demo.com + errorMsg: Event time is must + imei: '333333333333330' + imsi: '333333333333333' + ipType: 0 + ipv4Addr: 172.29.0.8 + schema: + type: object + description: Bad Request + '401': + content: + application/json: + example: + clientRequestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab + details: Interface set is not API + errorCode: '60076' + message: Either 5g is not enabled or interface is not API + requestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab + service: 5G Management Service + schema: + type: object + description: Unauthorized + security: + - Bearer: [] + summary: Register UE + tags: + - UE Enrichment + /mt/manage/5g/tenantUEInfo: + post: + description: 'Create tenant-user equipment (UE) information. This includes mapping + user devices to tenants for management and policy enforcement. + + ' + operationId: post-mt-manage-5g-tenantueinfo + requestBody: + content: + application/json: + examples: + Add Tenant UE Info: + value: + apn: apn@panw.com + imei: '111111789012345' + imsi: '123456789012345' + root_tsg_id: '123456891' + tsg_id: '123456890' + IMEI Input Size Error: + value: + apn: apn@panw.com + imei: '12345678901234' + imsi: '123456789012345' + root_tsg_id: '1204544558' + tsg_id: '1886576124' + IMSI Input Size Error: + value: + apn: apn@panw.com + imei: '123456789012345' + imsi: '12345678901234' + root_tsg_id: '1204544558' + tsg_id: '1886576124' + schema: + $ref: '#/components/schemas/TenantUEInfoRequest' + responses: + '200': + content: + application/json: + examples: + Add Tenant UE Info: + value: + data: + apn: apn@panw.com + create_time: 1738446903587 + id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 + imei: '123456789012340' + imsi: '123456789012345' + root_tsg_id: '1204544558' + tsg_id: '1886576124' + update_time: 1738446903587 + description: Success + '400': + content: + application/json: + examples: + Duplicate Tenant UE Info: + value: + clientRequestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f + details: Duplicate UE info + errorCode: '60013' + message: Duplicate tenant UE information + requestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f + service: 5G Management Service + IMEI Input Size Error: + value: + clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + details: IMEI needs to be 15 digits, current length is 27 + errorCode: '60014' + message: Failed to create tenant UE information + requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + service: 5G Management Service + IMSI Input Size Error: + value: + clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + details: IMSI needs to be 15 digits, current length is 27 + errorCode: '60014' + message: Failed to create tenant UE information + requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + service: 5G Management Service + Invalid TSG Id: + value: + clientRequestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 + details: tsg_id 123456890 does not exist in TenantDetails + errorCode: '60014' + message: Failed to create tenant UE information + requestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 + service: 5G Management Service + description: Bad Request + '404': + description: Data Not Found + '500': + content: + application/json: + examples: + ? '{"errorCode": "60000", "message": "Unexpected server error", "details": + "Unknown error occurred", "service": "5G Management Service", "requestId": + null, "clientRequestId": null}' + : value: Internal Server Error + description: Server Error + security: + - Bearer: [] + summary: Create tenant-UE info + tags: + - UE Info Resource + /mt/manage/5g/tenantUEInfo/delete: + post: + description: 'Delete the tenant-user equipment (UE) mapping for the provided + identity ID in bulk. This removes the association between user devices and + tenants. + + ' + operationId: post-mt-manage-5g-tenantueinfo-delete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TenantUeInfoBulkDeleteRequest' + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Delete tenant-UE mapping + tags: + - UE Info Resource + /mt/manage/5g/tenantUEInfo/list: + post: + description: 'List tenant-user equipment (UE) information for the provided tenant + ID or group ID. This includes details about the devices associated with the + tenant or group. + + ' + operationId: post-mt-manage-5g-tenantueinfo-list + parameters: + - in: query + name: filter + schema: + pattern: ^[a-z]+:\w+(?:,[a-z]+:\w+)*$ + type: string + - in: query + name: order + schema: + pattern: ^[a-z]+:(asc|desc)*$ + type: string + - in: query + name: page + schema: + default: 0 + format: int32 + type: integer + - in: query + name: size + schema: + default: 50 + format: int32 + type: integer + requestBody: + content: + application/json: + examples: + List Tenant UE Info: + value: + tsg_id: '1886576124' + schema: + $ref: '#/components/schemas/TenantUEInfoListInput' + responses: + '200': + content: + application/json: + examples: + List Tenant UE Info: + value: + data: + - apn: apn@panw.com + create_time: 1737682646248 + group: [] + identity_id: a5831ca0-5cf4-46a9-9409-6d55ea5e210a + imei: '100411547312190' + imsi: '264467605337818' + root_tsg_id: '1204544558' + tsg_id: '1886576124' + update_time: 1737682646248 + - apn: apn@panw.com + create_time: 1737682657616 + group: [] + identity_id: 29900486-f87f-475a-803d-12e1ee886e55 + imei: '100454707189790' + imsi: '512181509888245' + root_tsg_id: '1204544558' + tsg_id: '1886576124' + update_time: 1737682657616 + totalItems: 2 + List Tenant UE Info with Groups: + value: + data: + - apn: apn@panw.com + create_time: 1737682646248 + group: + - group_id: 6e451583-b3ab-4d62-af67-398675ab746f + group_name: testgroup + identity_id: a5831ca0-5cf4-46a9-9409-6d55ea5e210a + imei: '100411547312190' + imsi: '264467605337818' + root_tsg_id: '1204544558' + tsg_id: '1886576124' + update_time: 1737682646248 + - apn: apn@panw.com + create_time: 1737682657616 + group: [] + identity_id: 29900486-f87f-475a-803d-12e1ee886e55 + imei: '100454707189790' + imsi: '512181509888245' + root_tsg_id: '1204544558' + tsg_id: '1886576124' + update_time: 1737682657616 + totalItems: 2 + description: Success + '204': + content: + application/json: + examples: + List Tenant UE Info Invalid TSG Id: + value: + data: [] + totalItems: 0 + description: No Content + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: List tenant-UE info + tags: + - UE Info Resource + /mt/manage/5g/tenantUEInfo/upload: + post: + description: 'Upload tenant-user equipment (UE) information in bulk. This allows + for the mass addition of user devices to the system. + + ' + operationId: post-mt-manage-5g-tenantueinfo-upload + requestBody: + content: + multipart/form-data: + encoding: + file: + contentType: application/octet-stream + schema: + properties: + file: + format: binary + type: string + filename: + type: string + rootTsgId: + type: string + tsgId: + type: string + type: object + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Upload tenant-UE info + tags: + - UE Info Resource + /mt/manage/5g/tenantUEInfo/{identity_id}: + delete: + description: 'Delete the Tenant UE mapping for provided identity_id. + + ' + operationId: delete-mt-manage-5g-tenantueinfo-identity_id + parameters: + - in: path + name: identity_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + Delete Tenant UE Info: + value: + identity_id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 + description: Success + '400': + content: + application/json: + examples: + Tenant UE information not found: + value: + clientRequestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 + details: Provided identityId 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 + does not exits. + errorCode: '60011' + message: Tenant UE information not found + requestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 + service: 5G Management Service + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + security: + - Bearer: [] + summary: Delete the Tenant UE mapping + tags: + - UE Info Resource + put: + description: 'Update the tenant-user equipment (UE) mapping for the provided + identity ID. This modifies the association between user devices and tenants. + + ' + operationId: put-mt-manage-5g-tenantueinfo-identity_id + parameters: + - in: path + name: identity_id + required: true + schema: + type: string + requestBody: + content: + application/json: + examples: + Edit Tenant UE Info: + value: + apn: apn@panw.com + imei: '111111789012345' + imsi: '123456789012345' + root_tsg_id: '123456891' + tsg_id: '123456890' + IMEI Input Size Error: + value: + apn: apn@panw.com + imei: '12345678901234' + imsi: '123456789012345' + root_tsg_id: '1204544558' + tsg_id: '1886576124' + IMSI Input Size Error: + value: + apn: apn@panw.com + imei: '123456789012345' + imsi: '12345678901234' + root_tsg_id: '1204544558' + tsg_id: '1886576124' + schema: + $ref: '#/components/schemas/TenantUEInfoRequest' + responses: + '200': + content: + application/json: + examples: + Edit Tenant UE Info: + value: + data: + apn: apn@panw.com + create_time: 1738446903587 + id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 + imei: '111111789012340' + imsi: '123456789012345' + root_tsg_id: '1204544558' + tsg_id: '1886576124' + update_time: 1738446903587 + description: Success + '400': + content: + application/json: + examples: + Duplicate Tenant UE Info: + value: + clientRequestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f + details: Duplicate UE info + errorCode: '60013' + message: Duplicate tenant UE information + requestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f + service: 5G Management Service + IMEI Input Size Error: + value: + clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + details: IMEI needs to be 15 digits, current length is 27 + errorCode: '60014' + message: Failed to create tenant UE information + requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + service: 5G Management Service + IMSI Input Size Error: + value: + clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + details: IMSI needs to be 15 digits, current length is 27 + errorCode: '60014' + message: Failed to create tenant UE information + requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + service: 5G Management Service + Invalid TSG Id: + value: + clientRequestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 + details: tsg_id 123456890 does not exist in TenantDetails + errorCode: '60014' + message: Failed to create tenant UE information + requestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 + service: 5G Management Service + description: Bad Request + '404': + description: Data Not Found + '500': + content: + application/json: + examples: + ? '{"errorCode": "60000", "message": "Unexpected server error", "details": + "Unknown error occurred", "service": "5G Management Service", "requestId": + null, "clientRequestId": null}' + : value: Internal Server Error + description: Server Error + security: + - Bearer: [] + summary: Update tenant-UE mapping + tags: + - UE Info Resource + /mt/manage/5g/tenantUEInfo/{ueInfoId}: + get: + description: 'Retrieve Tenant UE information Mapping, which includes the mapping + of Tenant, IMSI, IMEI, and APN for the specified ID. + + ' + operationId: get-mt-manage-5g-tenantueinfo-ueinfoid + parameters: + - in: path + name: ueInfoId + required: true + schema: + type: string + - in: query + name: unknownUes + schema: + type: boolean + responses: + '200': + content: + application/json: + examples: + Get Tenant UE Info for a given Identity ID: + value: + data: + apn: new_apn_122 + create_time: 1738909540647 + id: d8642f4c-e639-4acb-925d-5558a2331035 + imei: '000000000000000' + imsi: '222222222222228' + root_tsg_id: '1157492855' + tsg_id: '1157492855' + update_time: 1738909540647 + header: + clientRequestId: 70e19fff-0793-45e7-93db-511ffe26288d + createdAt: '2025-02-10T18:47:01.000Z' + dataCount: 1 + status: + subCode: 200 + description: Success + '400': + content: + application/json: + examples: + Tenant UE information not found: + value: + clientRequestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 + details: Provided identityId 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 + does not exits. + errorCode: '60011' + message: Tenant UE information not found + requestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 + service: 5G Management Service + description: Bad Request + '404': + description: Data Not Found + '500': + content: + application/json: + examples: + Invalid TSG Id: + value: + details: Unknown error occurred + errorCode: '60000' + message: Unexpected server error + service: 5G Management Service + description: Server Error + security: + - Bearer: [] + summary: Retrieve UE Mapping + tags: + - UE Info Resource + /mt/manage/5g/userGroup: + post: + description: 'Create a user group with user equipment (UE) information. This + allows for the grouping of user devices for management and policy enforcement. + + ' + operationId: post-mt-manage-5g-usergroup + requestBody: + content: + application/json: + examples: + Add User Group: + value: + group_name: testgroup + identity_id: + - e20f9c45-6f53-4c2f-96fc-7964532d8b83 + - e79bda5e-d2ae-4e1d-b0f2-c9318a2b7fa2 + tsg_id: '1886576124' + schema: + $ref: '#/components/schemas/TenantGroupInfo' + responses: + '200': + content: + application/json: + examples: + Add User Group: + value: + data: + cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 + createTime: 1738448314169 + id: 6e451583-b3ab-4d62-af67-398675ab746f + tsgId: '1886576124' + updateTime: 1738448314412 + userGroupName: testgroup + Add User Group with Incorrect Identity ID: + value: + data: + cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 + createTime: 1738448314169 + id: 6e451583-b3ab-4d62-af67-398675ab746f + tsgId: '1886576124' + updateTime: 1738448314412 + userGroupName: testgroup + description: Success + '400': + content: + application/json: + examples: + Add Duplicate User Group Name: + value: + clientRequestId: 8e414a6e-51ce-4d71-b272-e00b3f17c961 + details: Duplicate user group name testgroup + errorCode: '60003' + message: Duplicate user group name + requestId: 8e414a6e-51ce-4d71-b272-e00b3f17c961 + service: 5G Management Service + description: Bad Request + '404': + description: Data Not Found + '500': + content: + application/json: + examples: + Internal Server Error: + value: + details: Unknown error occurred + errorCode: '60000' + message: Unexpected server error + service: 5G Management Service + description: Server Error + security: + - Bearer: [] + summary: Create user group + tags: + - Group Resource + /mt/manage/5g/userGroup/list: + post: + description: 'List user groups for the provided tenant ID. This includes details + about the groups and their associated user devices. + + ' + operationId: post-mt-manage-5g-usergroup-list + requestBody: + content: + application/json: + examples: + List User Group: + value: + tsg_id: '1886576124' + schema: + $ref: '#/components/schemas/TenantGroupInfoListInput' + responses: + '200': + content: + application/json: + examples: + List User Group: + value: + data: + - group_id: 3ff7689a-c7a8-410c-b973-8ccac5e6d20d + group_name: testgroup2 + tsg_id: '1886576124' + user_count: 3 + - group_id: 6e451583-b3ab-4d62-af67-398675ab746f + group_name: testgroup + tsg_id: '1886576124' + user_count: 2 + totalItems: 2 + description: Success + '204': + content: + application/json: + examples: + List User Group Invalid TSG Id: + value: + data: [] + totalItems: 0 + description: No Content + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + content: + application/json: + examples: + Internal Server Error: + value: + details: Unknown error occurred + errorCode: '60000' + message: Unexpected server error + service: 5G Management Service + description: Server Error + security: + - Bearer: [] + summary: List user groups + tags: + - Group Resource + /mt/manage/5g/userGroup/{groupId}: + get: + description: 'Retrieve Tenant UE information IDs for the specified groupId. + + ' + operationId: get-mt-manage-5g-usergroup-groupid + parameters: + - in: path + name: groupId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + Get User Group: + value: + data: + - group_name: test-group + identity_id: + - ac19eca7-dd5c-40bc-98f3-5b3f7e905d79 + - b4453abf-0f71-4e54-b2b9-339cc803b335 + - c83de425-8459-4d6d-93d6-3b2515624a19 + - d79e02e8-f6aa-4d23-a65c-6f3b804a1dbe + - d8642f4c-e639-4acb-925d-5558a2331035 + - e38f8ebf-437f-4ca8-a447-42714eae24d6 + tsg_id: '1157492855' + header: + clientRequestId: 237266cc-8f00-45c8-9122-e551fba2a1fa + createdAt: '2025-02-10T18:53:31.000Z' + dataCount: 1 + status: + subCode: 200 + description: Success + '400': + content: + application/json: + examples: + Invalid User Group: + value: + clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' + errorCode: '60007' + message: User group validation failed + requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + service: 5G Management Service + description: Bad Request + '404': + description: Data Not Found + '500': + content: + application/json: + examples: + Internal Server Error: + value: + details: Unknown error occurred + errorCode: '60000' + message: Unexpected server error + service: 5G Management Service + description: Server Error + security: + - Bearer: [] + summary: Retrieve UE IDs + tags: + - Group Resource + /mt/manage/5g/userGroup/{group_id}: + put: + description: 'Update the user group mapping for the provided group ID. This + modifies the association between user devices and the group. + + ' + operationId: put-mt-manage-5g-usergroup-group_id + parameters: + - in: path + name: group_id + required: true + schema: + type: string + requestBody: + content: + application/json: + examples: + Edit User Group: + value: + group_name: testgroup + identity_id: + - e20f9c45-6f53-4c2f-96fc-7964532d8b83 + - e79bda5e-d2ae-4e1d-b0f2-c9318a2b7fa2 + tsg_id: '1886576124' + schema: + $ref: '#/components/schemas/TenantGroupInfo' + responses: + '200': + content: + application/json: + examples: + Edit User Group: + value: + data: + cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 + createTime: 1738448314169 + id: 6e451583-b3ab-4d62-af67-398675ab746f + tsgId: '1886576124' + updateTime: 1738448314412 + userGroupName: testgroup + Edit User Group with Incorrect Identity ID: + value: + data: + cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 + createTime: 1738448314169 + id: 6e451583-b3ab-4d62-af67-398675ab746f + tsgId: '1886576124' + updateTime: 1738448314412 + userGroupName: testgroup + description: Success + '400': + content: + application/json: + examples: + Invalid User Group: + value: + clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' + errorCode: '60007' + message: User group validation failed + requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + service: 5G Management Service + description: Bad Request + '404': + description: Data Not Found + '500': + content: + application/json: + examples: + Internal Server Error: + value: + details: Unknown error occurred + errorCode: '60000' + message: Unexpected server error + service: 5G Management Service + description: Server Error + security: + - Bearer: [] + summary: Update user group + tags: + - Group Resource + /mt/manage/5g/userGroup/{identity_id}: + delete: + description: 'Delete the user group mapping for the provided identity ID. This + removes the association between user devices and the group. + + ' + operationId: delete-mt-manage-5g-usergroup-identity_id + parameters: + - in: path + name: identity_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + examples: + Delete User Group: + value: + identity_id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 + Delete User Group Again: + value: + identity_id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 + description: Success + '400': + content: + application/json: + examples: + Invalid User Group: + value: + clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' + errorCode: '60007' + message: User group validation failed + requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + service: 5G Management Service + description: Bad Request + '404': + description: Data Not Found + '500': + content: + application/json: + examples: + Internal Server Error: + value: + details: Unknown error occurred + errorCode: '60000' + message: Unexpected server error + service: 5G Management Service + description: Server Error + security: + - Bearer: [] + summary: Delete user group mapping + tags: + - Group Resource +servers: +- url: https://api.sase.paloaltonetworks.com +tags: +- description: "The Customer Identity and Engagement (CIE) Token Resource API is responsible\ + \ for managing tokens used for authentication and authorization purposes within\ + \ the 5G SASE system. This includes operations such as saving, retrieving, and\ + \ validating CIE tokens for leaf tenants. \nThese tokens are crucial for ensuring\ + \ secure access and interaction with the system's resources.\n" + name: CIE Token Resource API +- description: "The Connection API provides endpoints for retrieving and managing\ + \ connection details across different regions within the 5G SASE system. \nThis\ + \ includes information about the current status, configuration, and performance\ + \ of connections. \nAdministrators can use this API to monitor and optimize network\ + \ connectivity, ensuring efficient and reliable communication.\n" + name: Connection API +- description: "The Control Plane Resource API is responsible for managing control\ + \ plane operations within the 5G SASE system. \nThis includes handling certificates,\ + \ proxy configurations, and RADIUS server secrets. \nThese operations are critical\ + \ for establishing secure communication channels and ensuring the proper functioning\ + \ of the control plane, which orchestrates the overall network management and\ + \ security policies.\n" + name: Control Plane Resource API +- description: 'The User Equipment (UE) Info Resource API manages information related + to user devices within the 5G SASE system. This includes creating, updating, listing, + and deleting tenant-user equipment mappings. + + By managing UE information, this API helps in enforcing security policies, tracking + device usage, and ensuring that user devices are properly associated with their + respective tenants. + + ' + name: UE Info Resource API +- description: "The Group Resource API is responsible for managing user groups within\ + \ the 5G SASE system. This includes creating, updating, listing, and deleting\ + \ groups that contain user equipment (UE) information. \nBy organizing user devices\ + \ into groups, this API facilitates the application of group-based security policies\ + \ and simplifies the management of multiple devices within the network.\n" + name: Group Resource API +- description: "The User Equipment (UE) Enrichment API is designed to augment UE data\ + \ with additional context and security-related information. This includes enriching\ + \ UE profiles with details such as device type, location, user identity, and security\ + \ posture. \nBy enriching this data, the API enables more granular policy enforcement,\ + \ better threat detection, and improved network visibility, helping administrators\ + \ to make more informed decisions about device access and security.\n" + name: UE Enrichment API From afa70cf59d2576c3916f4bf0a9873fd1f98a82c8 Mon Sep 17 00:00:00 2001 From: sra Date: Wed, 8 Oct 2025 13:01:10 +0530 Subject: [PATCH 2/2] DOCS-8473 Updated the changelog --- .../5G Management Service.yaml | 8 +- ...aloaltonetworks-5G Management Service.yaml | 1366 ----------------- products/sase/docs/release-notes/changelog.md | 1 + 3 files changed, 5 insertions(+), 1370 deletions(-) delete mode 100644 openapi-specs/sase/manage-services-5g/paloaltonetworks-5G Management Service.yaml diff --git a/openapi-specs/sase/manage-services-5g/5G Management Service.yaml b/openapi-specs/sase/manage-services-5g/5G Management Service.yaml index 793a0a416..dda9515b2 100644 --- a/openapi-specs/sase/manage-services-5g/5G Management Service.yaml +++ b/openapi-specs/sase/manage-services-5g/5G Management Service.yaml @@ -171,8 +171,8 @@ info: \ answer to these pressing needs, \noffering a new approach to securing the future\ \ of enterprise connectivity.\n\nThese APIs use the common SASE authentication\ \ mechanism and base URL. See the\n[Prisma SASE API Get Started](https://pan.dev/sase/docs/getstarted)\ - \ guide for more information.\n\nThis Open API spec file was created on September\ - \ 16, 2025. To check for a more recent version of this file, see\n[SASE 5G Manage\ + \ guide for more information.\n\nThis Open API spec file was created on October\ + \ 07, 2025. To check for a more recent version of this file, see\n[SASE 5G Manage\ \ Services APIs on pan.dev](https://pan.dev/sase/api/manage-services-5g/introduction).\n\ \n\xA9 2025 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark\ \ of Palo\nAlto Networks. A list of our trademarks can be found at\n\n[https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html)\n\ @@ -1078,7 +1078,7 @@ paths: description: Server Error security: - Bearer: [] - summary: Delete the Tenant UE mapping + summary: Delete tenant-UE mapping by ID tags: - UE Info Resource put: @@ -1187,7 +1187,7 @@ paths: description: Server Error security: - Bearer: [] - summary: Update tenant-UE mapping + summary: Update tenant-UE mapping by ID tags: - UE Info Resource /mt/manage/5g/tenantUEInfo/{ueInfoId}: diff --git a/openapi-specs/sase/manage-services-5g/paloaltonetworks-5G Management Service.yaml b/openapi-specs/sase/manage-services-5g/paloaltonetworks-5G Management Service.yaml deleted file mode 100644 index 00fe79a35..000000000 --- a/openapi-specs/sase/manage-services-5g/paloaltonetworks-5G Management Service.yaml +++ /dev/null @@ -1,1366 +0,0 @@ -components: - schemas: - CieTokenRequest: - properties: - access_token: - type: string - cie_directory: - type: string - created_at: - type: string - created_by: - type: string - tsg_id: - type: string - type: object - Enable5GRequest: - properties: - action: - type: string - compute_region: - type: string - ipv4_cidr: - type: string - ipv6_cidr: - type: string - type: object - JsonObject: - items: - type: string - type: array - RadiusProxyRequest: - properties: - ipaddress: - type: string - name: - type: string - type: object - RadiusServerSecretRequest: - properties: - created_by: - type: string - secret: - type: string - type: object - TenantGroupInfo: - properties: - group_name: - type: string - identity_id: - items: - type: string - type: array - tsg_id: - type: string - type: object - TenantGroupInfoListInput: - properties: - tsg_id: - type: string - type: object - TenantUEInfoListInput: - properties: - group_id: - type: string - tsg_id: - type: string - type: object - TenantUEInfoRequest: - properties: - apn: - type: string - imei: - type: string - imsi: - type: string - root_tsg_id: - type: string - tsg_id: - type: string - type: object - TenantUeInfoBulkDeleteRequest: - properties: - identityIds: - items: - type: string - type: array - type: object - securitySchemes: - Bearer: - scheme: bearer - type: http -info: - contact: - email: support@paloaltonetworks.com - description: "The evolution of 5G technology is transforming enterprise connectivity,\ - \ offering unprecedented speed and capacity. \nAs businesses embrace 5G networks,\ - \ the demand for robust security measures grows exponentially. \nService Providers\ - \ are at the forefront of this shift, tasked with safeguarding vast amounts of\ - \ sensitive data across diverse 5G-connected devices.\nTraditional security approaches\ - \ fall short in the 5G landscape. Embedded solutions often hit scalability roadblocks\ - \ and increase management complexity. \nOver-the-Top (OTT) solutions, while flexible,\ - \ prove impractical for many IoT devices and sensors. Neither fully addresses\ - \ the unique challenges of 5G, \nsuch as seamless roaming and integrated network-based\ - \ security.\n\nThis gap in the market calls for an innovative security paradigm\ - \ - one that combines scalability, ease of management, \nand comprehensive protection\ - \ across all 5G scenarios. \nThe Enterprise 5G Security Solution emerges as the\ - \ answer to these pressing needs, \noffering a new approach to securing the future\ - \ of enterprise connectivity.\n\nThese APIs use the common SASE authentication\ - \ mechanism and base URL. See the\n[Prisma SASE API Get Started](https://pan.dev/sase/docs/getstarted)\ - \ guide for more information.\n\nThis Open API spec file was created on May 20,\ - \ 2025. To check for a more recent version of this file, see\n[SASE 5G Manage\ - \ Services APIs on pan.dev](https://pan.dev/sase/api/manage-services-5g/introduction).\n\ - \n\xA9 2025 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark\ - \ of Palo\nAlto Networks. A list of our trademarks can be found at\n\n[https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html)\n\ - \nAll other marks mentioned herein may be trademarks of their respective companies.\n" - title: SASE 5G Manage Service APIs - version: '1.0' -openapi: 3.0.2 -paths: - /mt/manage/5g/cie/token: - post: - description: 'Save the Customer Identity and Engagement (CIE) token for the - leaf tenant. This token is used for authentication and authorization purposes. - - ' - operationId: post-mt-manage-5g-cie-token - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CieTokenRequest' - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Save CIE token - tags: - - CIE Token Resource - /mt/manage/5g/cie/token/details: - post: - description: 'Retrieve the details of the Customer Identity and Engagement (CIE) - token for the leaf tenant. This includes information about the token''s validity - and usage. - - ' - operationId: post-mt-manage-5g-cie-token-details - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/JsonObject' - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Get CIE token details - tags: - - CIE Token Resource - /mt/manage/5g/connection: - get: - description: 'Retrieve connection details by regions. This includes information - about the current status and configuration of connections in different regions. - - ' - operationId: get-mt-manage-5g-connection - responses: - '200': - content: - application/json: - examples: - Get Connection Details by region: - value: - data: - - bandwidth: 500000000 - computeRegion: us-west2 - connectionCount: 2 - connectionStatusEntry: - down: 1 - up: 1 - - bandwidth: 100000000 - computeRegion: us-central1 - connectionCount: 1 - connectionStatusEntry: - down: 0 - up: 1 - - bandwidth: 400000000 - computeRegion: us-east2 - connectionCount: 1 - connectionStatusEntry: - down: 0 - up: 1 - - bandwidth: 300000000 - computeRegion: us-west1 - connectionCount: 1 - connectionStatusEntry: - down: 1 - up: 0 - header: - createdAt: '2024-08-28T16:05:27Z' - dataCount: 4 - status: - subCode: 200 - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Get connection details - tags: - - Connection - /mt/manage/5g/control/cert/download: - get: - description: 'Download the certificate file required to enable 5G connectivity - for a specified region. This certificate is used for secure communication. - - ' - operationId: get-mt-manage-5g-control-cert-download - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Download certificate - tags: - - ControlPlane Resource - /mt/manage/5g/control/proxycert: - get: - description: 'Check if the client certificate is uploaded for the root tenant - security group (root tsg). This certificate is necessary for secure proxy - communication. - - ' - operationId: get-mt-manage-5g-control-proxycert - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Get Client Certificate - tags: - - ControlPlane Resource - /mt/manage/5g/control/proxycert/upload: - post: - description: 'Upload the client certificate to enable 5G connectivity for a - specified region. This certificate is necessary for secure proxy communication. - - ' - operationId: post-mt-manage-5g-control-proxycert-upload - requestBody: - content: - multipart/form-data: - encoding: - file: - contentType: application/octet-stream - schema: - properties: - file: - format: binary - type: string - filename: - type: string - rootTsgId: - type: string - tsgId: - type: string - type: object - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Upload Client certificate - tags: - - ControlPlane Resource - /mt/manage/5g/control/radiusProxy: - get: - description: 'Retrieve the shared secret for the RADIUS server associated with - the root tenant security group (root tsg). This secret is used for secure - RADIUS communication. - - ' - operationId: get-mt-manage-5g-control-radiusproxy - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Get RADIUS server secret - tags: - - ControlPlane Resource - post: - description: Add radius server shared secrete forroot tsg - operationId: post-mt-manage-5g-control-radiusproxy - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RadiusProxyRequest' - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Add radius server shared secrete for root tsg - tags: - - ControlPlane Resource - /mt/manage/5g/control/radiusSecret: - get: - description: 'Retrieve the shared secret for the RADIUS server associated with - the root tenant security group (root tsg). This secret is used for secure - RADIUS communication. - - ' - operationId: get-mt-manage-5g-control-radiussecret - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Get RADIUS server secret - tags: - - ControlPlane Resource - post: - description: Add radius server shared secrete forroot tsg - operationId: post-mt-manage-5g-control-radiussecret - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RadiusServerSecretRequest' - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Add radius server shared secrete for root tsg - tags: - - ControlPlane Resource - /mt/manage/5g/control/radiusServers: - get: - description: 'Retrieve details of the RADIUS servers. This includes information - about the configuration and status of the RADIUS servers. - - ' - operationId: get-mt-manage-5g-control-radiusservers - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Get RADIUS server details - tags: - - ControlPlane Resource - /mt/manage/5g/ipcidr/{compute_region}: - get: - description: 'Retrieve the IPv4 and IPv6 Classless Inter-Domain Routing (CIDR) - blocks for a specified compute region. This is used to define the IP address - ranges for the network. - - ' - operationId: get-mt-manage-5g-ipcidr-compute_region - parameters: - - in: path - name: compute_region - required: true - schema: - type: string - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Get IP CIDR - tags: - - 5G API - /mt/manage/5g/setup: - post: - description: 'Enable 5G connectivity for a specified region. This involves configuring - the necessary settings and infrastructure to support 5G network access. - - ' - operationId: post-mt-manage-5g-setup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Enable5GRequest' - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Enable 5G connectivity - tags: - - 5G API - /mt/manage/5g/tenantUEInfo: - post: - description: 'Create tenant-user equipment (UE) information. This includes mapping - user devices to tenants for management and policy enforcement. - - ' - operationId: post-mt-manage-5g-tenantueinfo - requestBody: - content: - application/json: - examples: - Add Tenant UE Info: - value: - apn: apn@panw.com - imei: '111111789012345' - imsi: '123456789012345' - root_tsg_id: '123456891' - tsg_id: '123456890' - IMEI Input Size Error: - value: - apn: apn@panw.com - imei: '12345678901234' - imsi: '123456789012345' - root_tsg_id: '1204544558' - tsg_id: '1886576124' - IMSI Input Size Error: - value: - apn: apn@panw.com - imei: '123456789012345' - imsi: '12345678901234' - root_tsg_id: '1204544558' - tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantUEInfoRequest' - responses: - '200': - content: - application/json: - examples: - Add Tenant UE Info: - value: - data: - apn: apn@panw.com - create_time: 1738446903587 - id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - imei: '123456789012340' - imsi: '123456789012345' - root_tsg_id: '1204544558' - tsg_id: '1886576124' - update_time: 1738446903587 - description: Success - '400': - content: - application/json: - examples: - Duplicate Tenant UE Info: - value: - clientRequestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f - details: Duplicate UE info - errorCode: '60013' - message: Duplicate tenant UE information - requestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f - service: 5G Management Service - IMEI Input Size Error: - value: - clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - details: IMEI needs to be 15 digits, current length is 27 - errorCode: '60014' - message: Failed to create tenant UE information - requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - service: 5G Management Service - IMSI Input Size Error: - value: - clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - details: IMSI needs to be 15 digits, current length is 27 - errorCode: '60014' - message: Failed to create tenant UE information - requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - service: 5G Management Service - Invalid TSG Id: - value: - clientRequestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 - details: tsg_id 123456890 does not exist in TenantDetails - errorCode: '60014' - message: Failed to create tenant UE information - requestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 - service: 5G Management Service - description: Bad Request - '404': - description: Data Not Found - '500': - content: - application/json: - examples: - ? '{"errorCode": "60000", "message": "Unexpected server error", "details": - "Unknown error occurred", "service": "5G Management Service", "requestId": - null, "clientRequestId": null}' - : value: Internal Server Error - description: Server Error - security: - - Bearer: [] - summary: Create tenant-UE info - tags: - - UE Info Resource - /mt/manage/5g/tenantUEInfo/delete: - post: - description: 'Delete the tenant-user equipment (UE) mapping for the provided - identity ID in bulk. This removes the association between user devices and - tenants. - - ' - operationId: post-mt-manage-5g-tenantueinfo-delete - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TenantUeInfoBulkDeleteRequest' - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Delete tenant-UE mapping - tags: - - UE Info Resource - /mt/manage/5g/tenantUEInfo/list: - post: - description: 'List tenant-user equipment (UE) information for the provided tenant - ID or group ID. This includes details about the devices associated with the - tenant or group. - - ' - operationId: post-mt-manage-5g-tenantueinfo-list - parameters: - - in: query - name: filter - schema: - pattern: ^[a-z]+:\w+(?:,[a-z]+:\w+)*$ - type: string - - in: query - name: order - schema: - pattern: ^[a-z]+:(asc|desc)*$ - type: string - - in: query - name: page - schema: - default: 0 - format: int32 - type: integer - - in: query - name: size - schema: - default: 50 - format: int32 - type: integer - requestBody: - content: - application/json: - examples: - List Tenant UE Info: - value: - tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantUEInfoListInput' - responses: - '200': - content: - application/json: - examples: - List Tenant UE Info: - value: - data: - - apn: apn@panw.com - create_time: 1737682646248 - group: [] - identity_id: a5831ca0-5cf4-46a9-9409-6d55ea5e210a - imei: '100411547312190' - imsi: '264467605337818' - root_tsg_id: '1204544558' - tsg_id: '1886576124' - update_time: 1737682646248 - - apn: apn@panw.com - create_time: 1737682657616 - group: [] - identity_id: 29900486-f87f-475a-803d-12e1ee886e55 - imei: '100454707189790' - imsi: '512181509888245' - root_tsg_id: '1204544558' - tsg_id: '1886576124' - update_time: 1737682657616 - totalItems: 2 - List Tenant UE Info with Groups: - value: - data: - - apn: apn@panw.com - create_time: 1737682646248 - group: - - group_id: 6e451583-b3ab-4d62-af67-398675ab746f - group_name: testgroup - identity_id: a5831ca0-5cf4-46a9-9409-6d55ea5e210a - imei: '100411547312190' - imsi: '264467605337818' - root_tsg_id: '1204544558' - tsg_id: '1886576124' - update_time: 1737682646248 - - apn: apn@panw.com - create_time: 1737682657616 - group: [] - identity_id: 29900486-f87f-475a-803d-12e1ee886e55 - imei: '100454707189790' - imsi: '512181509888245' - root_tsg_id: '1204544558' - tsg_id: '1886576124' - update_time: 1737682657616 - totalItems: 2 - description: Success - '204': - content: - application/json: - examples: - List Tenant UE Info Invalid TSG Id: - value: - data: [] - totalItems: 0 - description: No Content - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: List tenant-UE info - tags: - - UE Info Resource - /mt/manage/5g/tenantUEInfo/upload: - post: - description: 'Upload tenant-user equipment (UE) information in bulk. This allows - for the mass addition of user devices to the system. - - ' - operationId: post-mt-manage-5g-tenantueinfo-upload - requestBody: - content: - multipart/form-data: - encoding: - file: - contentType: application/octet-stream - schema: - properties: - file: - format: binary - type: string - filename: - type: string - rootTsgId: - type: string - tsgId: - type: string - type: object - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Upload tenant-UE info - tags: - - UE Info Resource - /mt/manage/5g/tenantUEInfo/{identity_id}: - delete: - description: 'Delete the Tenant UE mapping for provided identity_id. - - ' - operationId: delete-mt-manage-5g-tenantueinfo-identity_id - parameters: - - in: path - name: identity_id - required: true - schema: - type: string - responses: - '200': - content: - application/json: - examples: - Delete Tenant UE Info: - value: - identity_id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - description: Success - '400': - content: - application/json: - examples: - Tenant UE information not found: - value: - clientRequestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 - details: Provided identityId 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - does not exits. - errorCode: '60011' - message: Tenant UE information not found - requestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 - service: 5G Management Service - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Delete the Tenant UE mapping - tags: - - UE Info Resource - put: - description: 'Update the tenant-user equipment (UE) mapping for the provided - identity ID. This modifies the association between user devices and tenants. - - ' - operationId: put-mt-manage-5g-tenantueinfo-identity_id - parameters: - - in: path - name: identity_id - required: true - schema: - type: string - requestBody: - content: - application/json: - examples: - Edit Tenant UE Info: - value: - apn: apn@panw.com - imei: '111111789012345' - imsi: '123456789012345' - root_tsg_id: '123456891' - tsg_id: '123456890' - IMEI Input Size Error: - value: - apn: apn@panw.com - imei: '12345678901234' - imsi: '123456789012345' - root_tsg_id: '1204544558' - tsg_id: '1886576124' - IMSI Input Size Error: - value: - apn: apn@panw.com - imei: '123456789012345' - imsi: '12345678901234' - root_tsg_id: '1204544558' - tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantUEInfoRequest' - responses: - '200': - content: - application/json: - examples: - Edit Tenant UE Info: - value: - data: - apn: apn@panw.com - create_time: 1738446903587 - id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - imei: '111111789012340' - imsi: '123456789012345' - root_tsg_id: '1204544558' - tsg_id: '1886576124' - update_time: 1738446903587 - description: Success - '400': - content: - application/json: - examples: - Duplicate Tenant UE Info: - value: - clientRequestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f - details: Duplicate UE info - errorCode: '60013' - message: Duplicate tenant UE information - requestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f - service: 5G Management Service - IMEI Input Size Error: - value: - clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - details: IMEI needs to be 15 digits, current length is 27 - errorCode: '60014' - message: Failed to create tenant UE information - requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - service: 5G Management Service - IMSI Input Size Error: - value: - clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - details: IMSI needs to be 15 digits, current length is 27 - errorCode: '60014' - message: Failed to create tenant UE information - requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - service: 5G Management Service - Invalid TSG Id: - value: - clientRequestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 - details: tsg_id 123456890 does not exist in TenantDetails - errorCode: '60014' - message: Failed to create tenant UE information - requestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 - service: 5G Management Service - description: Bad Request - '404': - description: Data Not Found - '500': - content: - application/json: - examples: - ? '{"errorCode": "60000", "message": "Unexpected server error", "details": - "Unknown error occurred", "service": "5G Management Service", "requestId": - null, "clientRequestId": null}' - : value: Internal Server Error - description: Server Error - security: - - Bearer: [] - summary: Update tenant-UE mapping - tags: - - UE Info Resource - /mt/manage/5g/tenantUEInfo/{ueInfoId}: - get: - description: 'Retrieve Tenant UE information Mapping, which includes the mapping - of Tenant, IMSI, IMEI, and APN for the specified ID. - - ' - operationId: get-mt-manage-5g-tenantueinfo-ueinfoid - parameters: - - in: path - name: ueInfoId - required: true - schema: - type: string - - in: query - name: unknownUes - schema: - type: boolean - responses: - '200': - content: - application/json: - examples: - Get Tenant UE Info for a given Identity ID: - value: - data: - apn: new_apn_122 - create_time: 1738909540647 - id: d8642f4c-e639-4acb-925d-5558a2331035 - imei: '000000000000000' - imsi: '222222222222228' - root_tsg_id: '1157492855' - tsg_id: '1157492855' - update_time: 1738909540647 - header: - clientRequestId: 70e19fff-0793-45e7-93db-511ffe26288d - createdAt: '2025-02-10T18:47:01.000Z' - dataCount: 1 - status: - subCode: 200 - description: Success - '400': - content: - application/json: - examples: - Tenant UE information not found: - value: - clientRequestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 - details: Provided identityId 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - does not exits. - errorCode: '60011' - message: Tenant UE information not found - requestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 - service: 5G Management Service - description: Bad Request - '404': - description: Data Not Found - '500': - content: - application/json: - examples: - Invalid TSG Id: - value: - details: Unknown error occurred - errorCode: '60000' - message: Unexpected server error - service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: Retrieve UE Mapping - tags: - - UE Info Resource - /mt/manage/5g/userGroup: - post: - description: 'Create a user group with user equipment (UE) information. This - allows for the grouping of user devices for management and policy enforcement. - - ' - operationId: post-mt-manage-5g-usergroup - requestBody: - content: - application/json: - examples: - Add User Group: - value: - group_name: testgroup - identity_id: - - e20f9c45-6f53-4c2f-96fc-7964532d8b83 - - e79bda5e-d2ae-4e1d-b0f2-c9318a2b7fa2 - tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantGroupInfo' - responses: - '200': - content: - application/json: - examples: - Add User Group: - value: - data: - cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 - createTime: 1738448314169 - id: 6e451583-b3ab-4d62-af67-398675ab746f - tsgId: '1886576124' - updateTime: 1738448314412 - userGroupName: testgroup - Add User Group with Incorrect Identity ID: - value: - data: - cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 - createTime: 1738448314169 - id: 6e451583-b3ab-4d62-af67-398675ab746f - tsgId: '1886576124' - updateTime: 1738448314412 - userGroupName: testgroup - description: Success - '400': - content: - application/json: - examples: - Add Duplicate User Group Name: - value: - clientRequestId: 8e414a6e-51ce-4d71-b272-e00b3f17c961 - details: Duplicate user group name testgroup - errorCode: '60003' - message: Duplicate user group name - requestId: 8e414a6e-51ce-4d71-b272-e00b3f17c961 - service: 5G Management Service - description: Bad Request - '404': - description: Data Not Found - '500': - content: - application/json: - examples: - Internal Server Error: - value: - details: Unknown error occurred - errorCode: '60000' - message: Unexpected server error - service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: Create user group - tags: - - Group Resource - /mt/manage/5g/userGroup/list: - post: - description: 'List user groups for the provided tenant ID. This includes details - about the groups and their associated user devices. - - ' - operationId: post-mt-manage-5g-usergroup-list - requestBody: - content: - application/json: - examples: - List User Group: - value: - tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantGroupInfoListInput' - responses: - '200': - content: - application/json: - examples: - List User Group: - value: - data: - - group_id: 3ff7689a-c7a8-410c-b973-8ccac5e6d20d - group_name: testgroup2 - tsg_id: '1886576124' - user_count: 3 - - group_id: 6e451583-b3ab-4d62-af67-398675ab746f - group_name: testgroup - tsg_id: '1886576124' - user_count: 2 - totalItems: 2 - description: Success - '204': - content: - application/json: - examples: - List User Group Invalid TSG Id: - value: - data: [] - totalItems: 0 - description: No Content - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - content: - application/json: - examples: - Internal Server Error: - value: - details: Unknown error occurred - errorCode: '60000' - message: Unexpected server error - service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: List user groups - tags: - - Group Resource - /mt/manage/5g/userGroup/{groupId}: - get: - description: 'Retrieve Tenant UE information IDs for the specified groupId. - - ' - operationId: get-mt-manage-5g-usergroup-groupid - parameters: - - in: path - name: groupId - required: true - schema: - type: string - responses: - '200': - content: - application/json: - examples: - Get User Group: - value: - data: - - group_name: test-group - identity_id: - - ac19eca7-dd5c-40bc-98f3-5b3f7e905d79 - - b4453abf-0f71-4e54-b2b9-339cc803b335 - - c83de425-8459-4d6d-93d6-3b2515624a19 - - d79e02e8-f6aa-4d23-a65c-6f3b804a1dbe - - d8642f4c-e639-4acb-925d-5558a2331035 - - e38f8ebf-437f-4ca8-a447-42714eae24d6 - tsg_id: '1157492855' - header: - clientRequestId: 237266cc-8f00-45c8-9122-e551fba2a1fa - createdAt: '2025-02-10T18:53:31.000Z' - dataCount: 1 - status: - subCode: 200 - description: Success - '400': - content: - application/json: - examples: - Invalid User Group: - value: - clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae - details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' - errorCode: '60007' - message: User group validation failed - requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae - service: 5G Management Service - description: Bad Request - '404': - description: Data Not Found - '500': - content: - application/json: - examples: - Internal Server Error: - value: - details: Unknown error occurred - errorCode: '60000' - message: Unexpected server error - service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: Retrieve UE IDs - tags: - - Group Resource - /mt/manage/5g/userGroup/{group_id}: - put: - description: 'Update the user group mapping for the provided group ID. This - modifies the association between user devices and the group. - - ' - operationId: put-mt-manage-5g-usergroup-group_id - parameters: - - in: path - name: group_id - required: true - schema: - type: string - requestBody: - content: - application/json: - examples: - Edit User Group: - value: - group_name: testgroup - identity_id: - - e20f9c45-6f53-4c2f-96fc-7964532d8b83 - - e79bda5e-d2ae-4e1d-b0f2-c9318a2b7fa2 - tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantGroupInfo' - responses: - '200': - content: - application/json: - examples: - Edit User Group: - value: - data: - cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 - createTime: 1738448314169 - id: 6e451583-b3ab-4d62-af67-398675ab746f - tsgId: '1886576124' - updateTime: 1738448314412 - userGroupName: testgroup - Edit User Group with Incorrect Identity ID: - value: - data: - cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 - createTime: 1738448314169 - id: 6e451583-b3ab-4d62-af67-398675ab746f - tsgId: '1886576124' - updateTime: 1738448314412 - userGroupName: testgroup - description: Success - '400': - content: - application/json: - examples: - Invalid User Group: - value: - clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae - details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' - errorCode: '60007' - message: User group validation failed - requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae - service: 5G Management Service - description: Bad Request - '404': - description: Data Not Found - '500': - content: - application/json: - examples: - Internal Server Error: - value: - details: Unknown error occurred - errorCode: '60000' - message: Unexpected server error - service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: Update user group - tags: - - Group Resource - /mt/manage/5g/userGroup/{identity_id}: - delete: - description: 'Delete the user group mapping for the provided identity ID. This - removes the association between user devices and the group. - - ' - operationId: delete-mt-manage-5g-usergroup-identity_id - parameters: - - in: path - name: identity_id - required: true - schema: - type: string - responses: - '200': - content: - application/json: - examples: - Delete User Group: - value: - identity_id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - Delete User Group Again: - value: - identity_id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - description: Success - '400': - content: - application/json: - examples: - Invalid User Group: - value: - clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae - details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' - errorCode: '60007' - message: User group validation failed - requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae - service: 5G Management Service - description: Bad Request - '404': - description: Data Not Found - '500': - content: - application/json: - examples: - Internal Server Error: - value: - details: Unknown error occurred - errorCode: '60000' - message: Unexpected server error - service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: Delete user group mapping - tags: - - Group Resource -servers: -- url: https://api.sase.paloaltonetworks.com -tags: -- description: "The Customer Identity and Engagement (CIE) Token Resource API is responsible\ - \ for managing tokens used for authentication and authorization purposes within\ - \ the 5G SASE system. This includes operations such as saving, retrieving, and\ - \ validating CIE tokens for leaf tenants. \nThese tokens are crucial for ensuring\ - \ secure access and interaction with the system's resources.\n" - name: CIE Token Resource API -- description: "The Connection API provides endpoints for retrieving and managing\ - \ connection details across different regions within the 5G SASE system. \nThis\ - \ includes information about the current status, configuration, and performance\ - \ of connections. \nAdministrators can use this API to monitor and optimize network\ - \ connectivity, ensuring efficient and reliable communication.\n" - name: Connection API -- description: "The Control Plane Resource API is responsible for managing control\ - \ plane operations within the 5G SASE system. \nThis includes handling certificates,\ - \ proxy configurations, and RADIUS server secrets. \nThese operations are critical\ - \ for establishing secure communication channels and ensuring the proper functioning\ - \ of the control plane, which orchestrates the overall network management and\ - \ security policies.\n" - name: Control Plane Resource API -- description: "The Enable 5G API encompasses a set of endpoints designed to facilitate\ - \ the setup and management of 5G connectivity within the SASE framework. \nThis\ - \ includes enabling 5G network access for specified regions, configuring necessary\ - \ settings, and ensuring that the infrastructure supports seamless 5G communication.\ - \ \nThis API is vital for deploying and maintaining 5G services.\n" - name: Enable 5G API -- description: 'The User Equipment (UE) Info Resource API manages information related - to user devices within the 5G SASE system. This includes creating, updating, listing, - and deleting tenant-user equipment mappings. - - By managing UE information, this API helps in enforcing security policies, tracking - device usage, and ensuring that user devices are properly associated with their - respective tenants. - - ' - name: UE Info Resource API -- description: "The Group Resource API is responsible for managing user groups within\ - \ the 5G SASE system. This includes creating, updating, listing, and deleting\ - \ groups that contain user equipment (UE) information. \nBy organizing user devices\ - \ into groups, this API facilitates the application of group-based security policies\ - \ and simplifies the management of multiple devices within the network.\n" - name: Group Resource API diff --git a/products/sase/docs/release-notes/changelog.md b/products/sase/docs/release-notes/changelog.md index 8c56a2c31..3bf669872 100644 --- a/products/sase/docs/release-notes/changelog.md +++ b/products/sase/docs/release-notes/changelog.md @@ -13,6 +13,7 @@ keywords: | Date | Description | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Oct 8, 2025 | Added new APIs to [SASE 5G Manage Services APIs](/sase/api/manage-services-5g/). | July 1, 2025 | Added [Identity Security Posture Management APIs](/sase/api/identity-sspm/). | June 24, 2025 | Added Plugin API to [SaaS Security Posture Management APIs](/sase/api/sspm/). | May 20, 2025 | Added [SASE 5G Manage Services APIs](/sase/api/manage-services-5g/).